Click or drag to resize
AB4D logo

RenderingContext Properties

The RenderingContext type exposes the following members.

Properties
 NameDescription
Public propertyCurrentBackBuffer Gets the currently used BackBuffer as Texture2D. The value of CurrentBackBuffer is initialized from DXScene.BackBuffer or DXScene.MSAABackBuffer (when multisampling is used) in the InitializeRenderingStep. The value can be changed with the SetBackBuffer(Texture2D, Texture2DDescription, RenderTargetView, DepthStencilView, Int32, Boolean) method.
Public propertyCurrentBackBufferDescription Gets the description of the currently used BackBuffer. The value of CurrentBackBufferDescription is initialized from DXScene.BackBufferDescription or DXScene.MSAABackBufferDescription (when multisampling is used) in the InitializeRenderingStep. The value can be changed with the SetBackBuffer(Texture2D, Texture2DDescription, RenderTargetView, DepthStencilView, Int32, Boolean) method.
Public propertyCurrentDepthStencilView Gets the currently used DepthStencilView. The value of CurrentDepthStencilView is initialized from DXScene.DepthStencilView in the InitializeRenderingStep. The value can be changed with the SetBackBuffer(Texture2D, Texture2DDescription, RenderTargetView, DepthStencilView, Int32, Boolean) method.
Public propertyCurrentRenderingStep Gets currently executing RenderingStep
Public propertyCurrentRenderTargetView Gets the currently used RenderTargetView. The value of CurrentRenderTargetView is initialized from DXScene.RenderTargetView in the InitializeRenderingStep. The value can be changed with the SetBackBuffer(Texture2D, Texture2DDescription, RenderTargetView, DepthStencilView, Int32, Boolean) method.
Public propertyCurrentSupersamplingCount Gets a super-sampling count that is used by the current BackBuffer (how much more pixels are rendered for each final pixel). Value 1 indicates no super-sampling. This value is set by the SetBackBuffer(Texture2D, Texture2DDescription, RenderTargetView, DepthStencilView, Int32, Boolean) method.
Public propertyCurrentSupersamplingFactor Gets the factor by which width and height are multiplied because of the used super-sampling. This value is calculated by using Sqrt function of the CurrentSupersamplingCount value.
Public propertyCurrentViewport Gets or sets the current Viewport that is used for the next DrawCall. The value of CurrentViewport is initialized from DXScene.Viewport in the InitializeRenderingStep.
Public propertyFinalBackBuffer Gets the Texture2D that represents the BackBuffer that will contain the finally rendered image. FinalBackBuffer must not use multisampling and should not be a staging buffer. When you need to copy the FinalBackBuffer to the main memory, set StagingBackBuffer. FinalBackBuffer can be set with SetFinalBackBufferInternal(Texture2D, Texture2DDescription, RenderTargetView) method that can be available from a class derived from RenderingContext - for example CustomRenderingContext.
Public propertyFinalBackBufferDescription Gets the description of the FinalBackBuffer.
Public propertyFinalRenderTargetView Gets the RenderTargetView of the FinalBackBuffer.
Public propertyFrameNumber Current frame number
Public propertyIsCollectingBackBufferChanges Gets or sets a Boolean that specifies if all changes to BackBuffer are collected and can be get with calling the GetBackBufferChangesReport method.
Public propertyName Gets the name the this RenderingContext (usually indicates a background or main thread)
Public propertyRenderReason Gets or sets ChangeNotifications flags that were set on DXScene with NotifyChange method and describe the changes that lead to render
Public propertySSAABackBuffer Gets super-sampled back buffer that is used for super-sampling. This property is set by SetSupersamplingBackBuffers(Texture2D, ShaderResourceView, RenderTargetView) method.
Public propertySSAARenderTargetView Gets super-sampled back buffer RenderTargetView that is used for super-sampling. This property is set by SetSupersamplingBackBuffers(Texture2D, ShaderResourceView, RenderTargetView) method.
Public propertySSAAShaderResourceView Gets super-sampled back buffer ShaderResourceView that is used for super-sampling. This property is set by SetSupersamplingBackBuffers(Texture2D, ShaderResourceView, RenderTargetView) method.
Public propertyStagingBackBuffer StagingBackBuffer is used to allow coping the FinalBackBuffer to the main memory. This is done in the CompleteRenderingStep where the FinalBackBuffer is first copied to StagingBackBuffer and then the StagingBackBuffer is mapped so that it can be accessed by the CPU and copied to main memory. The StagingBackBuffer is set with RegisterBackBufferMapping(BackBufferReadyEventHandler) or RegisterBackBufferMapping(Texture2D, Texture2DDescription, BackBufferReadyEventHandler) methods.
Public propertyStagingBackBufferDescription Gets the description of the StagingBackBuffer.
Public propertyStagingBackBufferMappedCallbacks Get a list of BackBufferReadyEventHandler delegate that are called when the StagingBackBuffer has been mapped and is ready to be copied from GPU memory to the main memory. A delagate is added to this list with RegisterBackBufferMapping(BackBufferReadyEventHandler) or RegisterBackBufferMapping(Texture2D, Texture2DDescription, BackBufferReadyEventHandler) methods.
Public propertySwapChain Gets the SwapChain when DXEngine is using SwapChain or null when SwapChain is not used.
Public propertyUsedCamera Gets or sets a camera that will be used to view the scene. Usually UsedCamera is set in the InitializeRenderingStep from the DXScene's Camera property.
Public propertyVirtualRealityContext Gets the current VirtualRealityContext that is set when DXDEngine is using rendering for virtual reality (different images for left and right eye).
Top
See Also