2018-09-10 02:41:13 +02:00
// Copyright © 2018 The CefSharp Authors. All rights reserved.
2018-04-20 13:33:08 +10:00
//
// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
2018-09-17 00:46:21 +02:00
using System ;
2018-04-23 14:15:25 +10:00
using CefSharp.Enums ;
2018-04-20 13:33:08 +10:00
using CefSharp.Structs ;
2020-07-23 07:21:14 +02:00
using Range = CefSharp . Structs . Range ;
2018-04-20 13:33:08 +10:00
namespace CefSharp.OffScreen
{
2018-08-24 19:13:59 +10:00
/// <summary>
/// Implement this interface to handle Offscreen Rendering (OSR).
2018-09-28 12:37:42 +10:00
/// Upstream documentation at http://magpcss.org/ceforum/apidocs3/projects/(default)/CefRenderHandler.html
2018-08-24 19:13:59 +10:00
/// </summary>
public interface IRenderHandler : IDisposable
{
/// <summary>
/// Called to allow the client to return a ScreenInfo object with appropriate values.
/// If null is returned then the rectangle from GetViewRect will be used.
/// If the rectangle is still empty or invalid popups may not be drawn correctly.
/// </summary>
/// <returns>Return null if no screenInfo structure is provided.</returns>
ScreenInfo ? GetScreenInfo ( ) ;
2018-04-23 14:15:25 +10:00
2018-06-27 19:54:41 +10:00
/// <summary>
2018-12-16 10:48:52 +10:00
/// Called to retrieve the view rectangle which is relative to screen coordinates.
/// This method must always provide a non-empty rectangle.
2018-06-27 19:54:41 +10:00
/// </summary>
2018-12-16 10:48:52 +10:00
/// <returns>Return a ViewRect strict containing the rectangle.</returns>
Rect GetViewRect ( ) ;
2018-04-23 14:15:25 +10:00
2018-08-24 19:13:59 +10:00
/// <summary>
/// Called to retrieve the translation from view coordinates to actual screen coordinates.
/// </summary>
/// <param name="viewX">x</param>
/// <param name="viewY">y</param>
/// <param name="screenX">screen x</param>
/// <param name="screenY">screen y</param>
/// <returns>Return true if the screen coordinates were provided.</returns>
bool GetScreenPoint ( int viewX , int viewY , out int screenX , out int screenY ) ;
2018-04-23 14:15:25 +10:00
2018-12-16 14:23:19 +10:00
/// <summary>
/// Called when an element has been rendered to the shared texture handle.
/// This method is only called when <see cref="IWindowInfo.SharedTextureEnabled"/> is set to true
/// </summary>
/// <param name="type">indicates whether the element is the view or the popup widget.</param>
/// <param name="dirtyRect">contains the set of rectangles in pixel coordinates that need to be repainted</param>
/// <param name="sharedHandle">is the handle for a D3D11 Texture2D that can be accessed via ID3D11Device using the OpenSharedResource method.</param>
void OnAcceleratedPaint ( PaintElementType type , Rect dirtyRect , IntPtr sharedHandle ) ;
2018-08-24 19:13:59 +10:00
/// <summary>
/// Called when an element should be painted. Pixel values passed to this method are scaled relative to view coordinates based on the
2018-09-28 12:37:42 +10:00
/// value of <see cref="ScreenInfo.DeviceScaleFactor"/> returned from <see cref="GetScreenInfo"/>.
2018-12-16 14:23:19 +10:00
/// This method is only called when <see cref="IWindowInfo.SharedTextureEnabled"/> is set to false.
2018-08-24 19:13:59 +10:00
/// Called on the CEF UI Thread
/// </summary>
/// <param name="type">indicates whether the element is the view or the popup widget.</param>
/// <param name="dirtyRect">contains the set of rectangles in pixel coordinates that need to be repainted</param>
/// <param name="buffer">The bitmap will be will be width * height *4 bytes in size and represents a BGRA image with an upper-left origin</param>
/// <param name="width">width</param>
/// <param name="height">height</param>
void OnPaint ( PaintElementType type , Rect dirtyRect , IntPtr buffer , int width , int height ) ;
2018-04-23 14:15:25 +10:00
2018-08-24 19:13:59 +10:00
/// <summary>
2018-12-17 13:50:29 +10:00
/// Called when the browser's cursor has changed.
2018-08-24 19:13:59 +10:00
/// </summary>
/// <param name="cursor">If type is Custom then customCursorInfo will be populated with the custom cursor information</param>
/// <param name="type">cursor type</param>
/// <param name="customCursorInfo">custom cursor Information</param>
void OnCursorChange ( IntPtr cursor , CursorType type , CursorInfo customCursorInfo ) ;
2018-04-23 14:15:25 +10:00
2018-08-24 19:13:59 +10:00
/// <summary>
/// Called when the user starts dragging content in the web view. Contextual information about the dragged content is
2018-12-17 13:50:29 +10:00
/// supplied by dragData. OS APIs that run a system message loop may be used within the StartDragging call.
/// Don't call any of the IBrowserHost.DragSource*Ended* methods after returning false.
/// Return true to handle the drag operation. Call <see cref="IBrowserHost.DragSourceEndedAt"/> and <see cref="IBrowserHost.DragSourceSystemDragEnded"/> either synchronously or asynchronously to inform
2018-08-24 19:13:59 +10:00
/// the web view that the drag operation has ended.
/// </summary>
/// <param name="dragData">drag data</param>
/// <param name="mask">operation mask</param>
2018-12-17 13:50:29 +10:00
/// <param name="x">combined x and y provide the drag start location in screen coordinates</param>
/// <param name="y">combined x and y provide the drag start location in screen coordinates</param>
2018-08-24 19:13:59 +10:00
/// <returns>Return false to abort the drag operation.</returns>
bool StartDragging ( IDragData dragData , DragOperationsMask mask , int x , int y ) ;
2018-04-23 14:15:25 +10:00
2018-08-24 19:13:59 +10:00
/// <summary>
2018-11-19 05:37:19 +10:00
/// Called when the web view wants to update the mouse cursor during a drag & drop operation.
2018-08-24 19:13:59 +10:00
/// </summary>
/// <param name="operation">describes the allowed operation (none, move, copy, link). </param>
void UpdateDragCursor ( DragOperationsMask operation ) ;
2018-04-23 14:15:25 +10:00
2018-08-24 19:13:59 +10:00
/// <summary>
/// Called when the browser wants to show or hide the popup widget.
/// </summary>
/// <param name="show">The popup should be shown if show is true and hidden if show is false.</param>
void OnPopupShow ( bool show ) ;
2018-04-23 14:15:25 +10:00
2018-08-24 19:13:59 +10:00
/// <summary>
/// Called when the browser wants to move or resize the popup widget.
/// </summary>
/// <param name="rect">contains the new location and size in view coordinates. </param>
void OnPopupSize ( Rect rect ) ;
2018-04-23 14:15:25 +10:00
2018-08-24 19:13:59 +10:00
/// <summary>
/// Called when the IME composition range has changed.
/// </summary>
/// <param name="selectedRange">is the range of characters that have been selected</param>
/// <param name="characterBounds">is the bounds of each character in view coordinates.</param>
void OnImeCompositionRangeChanged ( Range selectedRange , Rect [ ] characterBounds ) ;
2019-03-27 20:08:46 +10:00
/// <summary>
/// Called when an on-screen keyboard should be shown or hidden for the specified browser.
/// </summary>
/// <param name="browser">the browser</param>
/// <param name="inputMode">specifies what kind of keyboard should be opened. If <see cref="TextInputMode.None"/>, any existing keyboard for this browser should be hidden.</param>
void OnVirtualKeyboardRequested ( IBrowser browser , TextInputMode inputMode ) ;
2018-08-24 19:13:59 +10:00
}
2018-09-28 12:37:42 +10:00
}
