cohtml.Net.ViewRenderer
The ViewRenderer is in charge of drawing a View in a user-supplied texture.
Inherits from SystemIDisposable
Public Types
Name | |
---|---|
enum class | PaintResult { PR_NotFound, PR_NothingToPaint, PR_PaintedSome, PR_FrameComplete} The result of the Paint call. |
Public Functions
Name | |
---|---|
virtual void | Dispose() |
virtual void | Destroy() Destroys the ViewRenderer. |
virtual ViewRenderer.PaintResult | Paint(uint frameId, bool runUntilCompleteFrame) Call this each frame to update the UI texture. This call will perform the actual rendering using the backend associated in the SystemRenderer. |
virtual void | FreeRenderingResources() Frees all rendering resources used by Cohtml that are associated with this specific view. To free all resources, you need to call this method on all ViewRenderer objects and on the SystemRenderer. Per-view rendering resources are the constant/vertex/index buffers (except path buffers). cohtml.SystemRenderer.FreeRenderingResources |
Protected Attributes
Name | |
---|---|
bool | swigCMemOwn |
Public Types Documentation
enum PaintResult
Enumerator | Value | Description |
---|---|---|
PR_NotFound | ||
PR_NothingToPaint | Such frame was not found, it might have already been painted. | |
PR_PaintedSome | The frame did nothing because there we no actual changes to apply. | |
PR_FrameComplete | The call executed some commands but the frame is not yet completely done. |
The result of the Paint call.
Public Functions Documentation
function Dispose
virtual void Dispose()
function Destroy
virtual void Destroy()
Destroys the ViewRenderer.
function Paint
virtual ViewRenderer.PaintResult Paint(
uint frameId,
bool runUntilCompleteFrame
)
Call this each frame to update the UI texture. This call will perform the actual rendering using the backend associated in the SystemRenderer.
function FreeRenderingResources
virtual void FreeRenderingResources()
Frees all rendering resources used by Cohtml that are associated with this specific view. To free all resources, you need to call this method on all ViewRenderer objects and on the SystemRenderer. Per-view rendering resources are the constant/vertex/index buffers (except path buffers). cohtml.SystemRenderer.FreeRenderingResources
Protected Attributes Documentation
variable swigCMemOwn
bool swigCMemOwn;