Interface IGuiContext

Namespace: Ritchie.Toolbox

Assembly: Ritchie.Toolbox.dll

Syntax

public interface IGuiContext

Properties

CanvasHeight

Declaration

int CanvasHeight { get; }

Property Value

Type	Description
int

CanvasWidth

Declaration

int CanvasWidth { get; }

Property Value

Type	Description
int

Game

Declaration

Game Game { get; }

Property Value

Type	Description
Game

GraphicsDevice

Declaration

GraphicsDevice GraphicsDevice { get; }

Property Value

Type	Description
GraphicsDevice

PhysicalHeight

Declaration

int PhysicalHeight { get; }

Property Value

Type	Description
int

PhysicalWidth

Declaration

int PhysicalWidth { get; }

Property Value

Type	Description
int

Methods

DrawClippingMesh(WidgetGeometry, RenderTarget2D, Texture2D?, Matrix, float)

Declaration

void DrawClippingMesh(WidgetGeometry mesh, RenderTarget2D clipTarget, Texture2D? clipMaskTexture, Matrix transformMatrix, float opacity)

Parameters

Type	Name	Description
WidgetGeometry	mesh
RenderTarget2D	clipTarget
Texture2D	clipMaskTexture
Matrix	transformMatrix
float	opacity

DrawMesh(WidgetGeometry, Texture2D?, Matrix, IEffect?, float)

Declaration

void DrawMesh(WidgetGeometry mesh, Texture2D? clipMaskTexture, Matrix transformMatrix, IEffect? effectOverride, float opacity)

Parameters

Type	Name	Description
WidgetGeometry	mesh
Texture2D	clipMaskTexture
Matrix	transformMatrix
IEffect	effectOverride
float	opacity

GetFallbackFont()

Declaration

IFontFamily GetFallbackFont()

Returns

Type	Description
IFontFamily

Grab(RenderTarget2D, Rectangle, Rectangle)

Renders the user interface to the given RenderTarget2D. Useful for certain widget rendering techniques such as background blurs.

Declaration

void Grab(RenderTarget2D destination, Rectangle sourceArea, Rectangle destinationArea)

Parameters

Type	Name	Description
RenderTarget2D	destination
Rectangle	sourceArea
Rectangle	destinationArea

PrepareWidgetRender(VertexBuffer, LayoutRect?, IEffect?, float, Point)

Declaration

void PrepareWidgetRender(VertexBuffer vertices, LayoutRect? clipRect = null, IEffect? effectOverride = null, float opacity = 1, Point positionOffset = default)

Parameters

Type	Name	Description
VertexBuffer	vertices
LayoutRect?	clipRect
IEffect	effectOverride
float	opacity
Point	positionOffset

Render(VertexPositionColorTexture[], int[], Texture2D?, LayoutRect?)

Declaration

void Render(VertexPositionColorTexture[] vertices, int[] indices, Texture2D? texture, LayoutRect? clipRect = null)

Parameters

Type	Name	Description
VertexPositionColorTexture[]	vertices
int[]	indices
Texture2D	texture
LayoutRect?	clipRect

RestoreRenderState()

Declaration

void RestoreRenderState()

SetClipMaskDestination(RenderTarget2D?)

Declaration

void SetClipMaskDestination(RenderTarget2D? clipMaskDestination)

Parameters

Type	Name	Description
RenderTarget2D	clipMaskDestination