Click or drag to resize
Ab4d.SharpEngine logo

RenderingContext Class

Inheritance Hierarchy
SystemObject
  Ab4d.SharpEngine.CoreRenderingContext

Namespace: Ab4d.SharpEngine.Core
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 4.1.9680+a1b1e43de1ad9a7e35472c33948d688d7b40ef79
Syntax
C#
public class RenderingContext

The RenderingContext type exposes the following members.

Constructors
 NameDescription
Public methodRenderingContextInitializes a new instance of the RenderingContext class
Top
Properties
 NameDescription
Public propertyAllLightsDescriptorSet 
Public propertyCurrentBoundDescriptorSets 
Public propertyCurrentFrameBuffer 
Public propertyCurrentGpuRenderPass 
Public propertyCurrentIndexBuffer 
Public propertyCurrentInFlightFrameIndex 
Public propertyCurrentMaterialIndex 
Public propertyCurrentMatrixIndex 
Public propertyCurrentPipeline 
Public propertyCurrentPipelineLayout 
Public propertyCurrentPrimaryCommandBuffer 
Public propertyCurrentRenderingStep Gets currently executing RenderingStep
Public propertyCurrentRenderPass 
Public propertyCurrentSceneFrameCommandBuffer 
Public propertyCurrentSwapChainImage 
Public propertyCurrentSwapChainImageIndex 
Public propertyCurrentSwapChainImageView 
Public propertyCurrentVertexBuffer 
Public propertyCurrentViewport Gets the currently used Viewport.
Public propertyDepthStencilImage 
Public propertyFinalHeight Gets the height in pixels of the final rendered image. When using super-sampling this can be different then the RenderHeight. This value is initially set by calling UpdateSwapChain(GpuSwapChain, GpuImage, GpuRenderPass, IntSize, IntSize, SampleCountFlags, Single, GpuImage, GpuImage).
Public propertyFinalWidth Gets the width in pixels of the final rendered image. When using super-sampling this can be different then the RenderWidth. This value is initially set by calling UpdateSwapChain(GpuSwapChain, GpuImage, GpuRenderPass, IntSize, IntSize, SampleCountFlags, Single, GpuImage, GpuImage).
Public propertyFrameNumber Current frame number
Public propertyHeight Gets the height in pixels of the current back buffer. This value is initially set by calling UpdateSwapChain(GpuSwapChain, GpuImage, GpuRenderPass, IntSize, IntSize, SampleCountFlags, Single, GpuImage, GpuImage) (set from renderSize parameter) and is then changed when BeginRenderPass(GpuRenderPass) or BeginRenderPass(RenderPass, Framebuffer, Int32, Int32) is called.
Public propertyInFlightFramesCount 
Public propertyIsFrameCommandBufferDirty 
Public propertyIsNonStandardPipelineLayout 
Public propertyIsPrimaryCommandBufferDirty 
Public propertyIsRecordingFrameCommandBuffer 
Public propertyIsRecordingPrimaryCommandBuffer 
Public propertyIsRenderPassRenderingStarted Gets a Boolean that specifies if vkCmdBeginRenderPass command was called and vkCmdEndRenderPass command was not called yet. This property is changed by calling BeginRenderPass(GpuRenderPass), BeginRenderPass(RenderPass, Framebuffer, Int32, Int32) and EndRenderPass methods.
Public propertyIsSceneFrameCommandBufferSupported 
Public propertyMainRenderPass 
Public propertyMSAAImage 
Public propertyMultisampleCount 
Public propertyRenderHeight Gets the height in pixels of the image that is used for main rendering. When using super-sampling this is SupersamplingFactor * FinalHeight. This value is initially set by calling UpdateSwapChain(GpuSwapChain, GpuImage, GpuRenderPass, IntSize, IntSize, SampleCountFlags, Single, GpuImage, GpuImage).
Public propertyRenderingStatistics 
Public propertyRenderWidth Gets the width in pixels of the image that is used for main rendering. When using super-sampling this is SupersamplingFactor * FinalWidth. This value is initially set by calling UpdateSwapChain(GpuSwapChain, GpuImage, GpuRenderPass, IntSize, IntSize, SampleCountFlags, Single, GpuImage, GpuImage).
Public propertySceneDescriptorSet 
Public propertySceneDirtyFlags 
Public propertySceneViewDirtyFlags 
Public propertyShadowDepthRenderingCommandBuffer 
Public propertyShadowRenderingProvider 
Public propertySSAAImage 
Public propertyStagingBufferReadyCallbacks 
Public propertyStagingGpuBuffer 
Public propertyStagingGpuBufferHeight 
Public propertyStagingGpuBufferWidth 
Public propertyStagingGpuImage 
Public propertyStagingImageReadyCallbacks 
Public propertySupersamplingCount 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 UpdateSwapChain(GpuSwapChain, GpuImage, GpuRenderPass, IntSize, IntSize, SampleCountFlags, Single, GpuImage, GpuImage) method.
Public propertySupersamplingFactor 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 SupersamplingCount value.
Public propertySwapChain 
Public propertySwapChainFormat 
Public propertySwapChainImagesCount 
Public propertySwapChainSurfaceFormat 
Public propertyUsedCamera Gets or sets a camera that will be used to view the scene.
Public propertyWidth Gets the width in pixels of the current back buffer. This value is initially set by calling UpdateSwapChain(GpuSwapChain, GpuImage, GpuRenderPass, IntSize, IntSize, SampleCountFlags, Single, GpuImage, GpuImage) (set from renderSize parameter) and is then changed when BeginRenderPass(GpuRenderPass) or BeginRenderPass(RenderPass, Framebuffer, Int32, Int32) is called.
Top
Methods
 NameDescription
Public methodBeginRenderPass(GpuRenderPass) 
Public methodBeginRenderPass(RenderPass, Framebuffer, Int32, Int32) 
Public methodClearSwapChainImages 
Public methodEndRenderPass 
Public methodFrameCommandBufferRecordingStarted 
Public methodIsCommandBuffersRecreateNeeded IsCommandBuffersRecreateNeeded returns true if Scene.DirtyFlags or SceneView.DirtyFlags require that the command buffer is recreated.
Public methodIsRenderingLayersRecreateNeeded IsRenderingLayersRecreateNeeded returns true if Scene.DirtyFlags or SceneView.DirtyFlags require that the RenderingLayers are recreated by calling CollectRenderingItems(RenderingContext) methods on all SceneNodes..
Public methodPrimaryCommandBufferRecordingStarted 
Public methodResetCounters 
Public methodShouldDisposeAllRenderingItems 
Public methodStartNewFrame 
Public methodUpdateCommandBuffers 
Public methodUpdateDirtyFlags 
Public methodUpdateSwapChain 
Top
Fields
See Also