RenderContext Class

RenderContext Class

Provides information about the current render states.

Inheritance Hierarchy

SystemObject
DigitalRune.GraphicsRenderContext

Namespace: DigitalRune.Graphics
Assembly: DigitalRune.Graphics (in DigitalRune.Graphics.dll) Version: 1.2.0.0 (1.2.1.14562)

Syntax

C++

Copy

public class RenderContext

Public Class RenderContext

public ref class RenderContext

type RenderContext =  class end

The RenderContext type exposes the following members.

Constructors

	Name	Description
	RenderContext	Initializes a new instance of the RenderContext class.

Top

Methods

	Name	Description
	Clone	Creates a new RenderContext that is a clone of the current instance.
	CloneCore	Makes the instance a clone (deep copy) of the specified RenderContext.
	CreateInstanceCore	When implemented in a derived class, creates a new instance of the RenderContext derived class.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Reset	Resets the render context to default values.
	Set	Copies the properties of the specified render context.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	CameraNode	Gets or sets the active camera.
	Data	Gets a generic collection of name/value pairs which can be used to store custom data.
	DeltaTime	Gets the elapsed time since the last frame.
	Frame	Gets or sets the number of the current frame.
	GBuffer0	Gets or sets the first texture containing G-buffer data.
	GBuffer1	Gets or sets the second texture containing G-buffer data.
	GBuffer2	Gets or sets the third texture containing G-buffer data.
	GBuffer3	Gets or sets the fourth texture containing G-buffer data.
	GraphicsService	Gets or sets the graphics service.
	LightBuffer0	Gets or sets the first texture containing light buffer data.
	LightBuffer1	Gets or sets the first texture containing light buffer data.
	LodBias	Gets or sets the global LOD bias.
	LodBlendingEnabled	Gets or sets a value indicating whether smooth LOD transitions are enabled.
	LodCameraNode	Gets or sets the camera that is used as reference for LOD calculations.
	LodHysteresis	Gets or sets the LOD hysteresis, which is the distance over which an object transitions from on level of detail to the next level. (Needs to be normalized - see remarks.)
	MaterialBinding	Gets or sets the effect binding of the current material.
	MaterialInstanceBinding	Gets or sets the effect binding of the current material instance.
	Object	Gets or sets the current data object.
	PassIndex	Gets or sets the index of the current EffectPass.
	PresentationTarget	Gets or sets the PresentationTarget that is currently being rendered.
	ReferenceNode	Gets or sets a scene node that provides additional context for the current render operation.
	RenderPass	Gets or sets a string that identifies the current render pass.
	RenderTarget	Gets or sets the target of the current rendering operations.
	Scene	Gets or sets the scene.
	SceneNode	Gets or sets the currently rendered scene node.
	SceneTexture	Gets or sets the texture that contains the rendered scene.
	Screen	Gets or sets the GraphicsScreen that is currently being rendered.
	SourceTexture	Gets or sets the source texture that contains the source image for the current render operation.
	Technique	Gets or sets a string that identifies the current technique.
	Time	Gets the total elapsed time.
	UserData	Gets or sets a user-defined object.
	Viewport	Gets the viewport (= the portion of the back buffer that should be used for rendering).

Top

Remarks

The RenderContext is passed to every Render method. It is used to pass information to a renderer, and it should contain all information that is required to render an object or to perform a rendering step.

Additional information can be stored in the Data dictionary.

Cloning:
The render context is cloneable. Clone makes a copy of the current render context. The new instance contains a new Data dictionary. The properties and the contents of the Data dictionary are copied by reference (shallow copy).

Reference

DigitalRune.Graphics Namespace