Loading...
Searching...
No Matches
OFT.Rendering.Control.IRenderSurface Interface Reference

Public Member Functions

bool IsNeedToRedraw (int width, int height)
 
void SetWindowsFormsHandle (IntPtr controlHandle)
 
void Initialize (IRenderControl parent, double dpiXScale, double dpiYScale)
 
RenderContext BeginRender (int width, int height)
 Starts rendering.
 
int EndRender (RenderContext renderContext)
 Finish rendering to a offscreen surface.
 
void DeInit ()
 Dispose the object, control cannot be used after.
 
void Reset ()
 Cleans up all resources, control can be used after.
 
object? CreateCustomControl ()
 Creates custom control for rendering, or null to use default control.
 

Properties

bool IsInitialized [get]
 
string Name [get]
 
ITextRenderer TextRenderer [get]
 Gets global text renderer for CommandBuffer string measurement.
 
System.Drawing.Size Size [get]
 Gets size in pixels of a surface.
 
ExceptionCollector? ErrorCollector [get, set]
 Gets or sets exception collector for rendering operations.
 
IRenderContextSettings Settings [get]
 
bool VerticalSynchronization [get, set]
 Do we need to sync with monitor refresh rate?
 
bool IsLikelyReady [get]
 Cheap readiness pre-check that does not acquire a frame. False means a systematic cause (native host not created yet, device-loss recovery backoff) would drop the frame anyway, so the caller should skip rendering and leave its state dirty. Transient per-frame failures are not covered — they are discovered by attempting the frame.
 

Member Function Documentation

◆ BeginRender()

RenderContext OFT.Rendering.Control.IRenderSurface.BeginRender ( int  width,
int  height 
)

Starts rendering.

Parameters
width
height
Returns

◆ CreateCustomControl()

object? OFT.Rendering.Control.IRenderSurface.CreateCustomControl ( )

Creates custom control for rendering, or null to use default control.

Returns

◆ DeInit()

void OFT.Rendering.Control.IRenderSurface.DeInit ( )

Dispose the object, control cannot be used after.

◆ EndRender()

int OFT.Rendering.Control.IRenderSurface.EndRender ( RenderContext  renderContext)

Finish rendering to a offscreen surface.

Parameters
renderContext
Returns

◆ Initialize()

void OFT.Rendering.Control.IRenderSurface.Initialize ( IRenderControl  parent,
double  dpiXScale,
double  dpiYScale 
)

◆ IsNeedToRedraw()

bool OFT.Rendering.Control.IRenderSurface.IsNeedToRedraw ( int  width,
int  height 
)

◆ Reset()

void OFT.Rendering.Control.IRenderSurface.Reset ( )

Cleans up all resources, control can be used after.

◆ SetWindowsFormsHandle()

void OFT.Rendering.Control.IRenderSurface.SetWindowsFormsHandle ( IntPtr  controlHandle)

Property Documentation

◆ ErrorCollector

ExceptionCollector? OFT.Rendering.Control.IRenderSurface.ErrorCollector
getset

Gets or sets exception collector for rendering operations.

◆ IsInitialized

bool OFT.Rendering.Control.IRenderSurface.IsInitialized
get

◆ IsLikelyReady

bool OFT.Rendering.Control.IRenderSurface.IsLikelyReady
get

Cheap readiness pre-check that does not acquire a frame. False means a systematic cause (native host not created yet, device-loss recovery backoff) would drop the frame anyway, so the caller should skip rendering and leave its state dirty. Transient per-frame failures are not covered — they are discovered by attempting the frame.

◆ Name

string OFT.Rendering.Control.IRenderSurface.Name
get

◆ Settings

IRenderContextSettings OFT.Rendering.Control.IRenderSurface.Settings
get

◆ Size

System.Drawing.Size OFT.Rendering.Control.IRenderSurface.Size
get

Gets size in pixels of a surface.

◆ TextRenderer

ITextRenderer OFT.Rendering.Control.IRenderSurface.TextRenderer
get

Gets global text renderer for CommandBuffer string measurement.

◆ VerticalSynchronization

bool OFT.Rendering.Control.IRenderSurface.VerticalSynchronization
getset

Do we need to sync with monitor refresh rate?


The documentation for this interface was generated from the following file: