| | Name | Description |
|---|
 | BackBuffersInitialized |
Gets a Boolean that specifies if the back buffers for this SceneView have been created.
When this is true, then Width and Height define the size of the back buffers.
|
| BackgroundColor |
Color of the background.
The color is not pre-multiplied by the alpha component.
Default value is Transparent color (alpha 0 and Red, Green and Blue set to 1).
|
| BackgroundSpritesRenderingLayer |
Gets a RenderingLayer that contains sprites that are rendered before any other 3D object is rendered. This RenderingLayer is not added to Ab4d.SharpEngine.RenderingLayers collection but is rendered in RenderSpritesRenderingStep.
|
| Camera |
Gets or sets an ICamera that is used to show the scene.
|
| CurrentSwapChainImageIndex |
When SwapChain image is used, then returns the index of the current swap chain image; otherwise 0 is returned.
|
| DefaultBeginRenderPassRenderingStep |
Default BeginRenderPassRenderingStep
|
| DefaultCompleteRenderingStep |
Default CompleteRenderingStep
|
| DefaultInitializeRenderingStep |
Default InitializeRenderingStep
|
| DefaultRenderObjectsRenderingStep |
Default RenderObjectsRenderingStep
|
| DefaultResolveSupersamplingRenderingStep |
Default ResolveSupersamplingRenderingStep
|
| DepthStencilFormat |
Gets the format of DepthStencilImage |
| DepthStencilImage |
Gets the GpuImage that is used as a depth-stencil buffer.
|
| DpiScaleX |
Gets or sets a float that represents a DPI scale factor in X direction: 1 means 96 DPI, 1.5 means 144 DPI, etc.
This value is used in line and pixel rendering and scales the line thickness or size of pixels.
|
| DpiScaleY |
Gets or sets a float that represents a DPI scale factor in Y direction: 1 means 96 DPI, 1.5 means 144 DPI, etc.
This value is used in line and pixel rendering and scales the line thickness or size of pixels.
|
| Format |
Gets or sets a StandardBitmapFormats that specifies the texture format that is used by the SwapChain.
By default, this is set to BGRA, but in cases when using shared texture or when the engine is only rendering to bitmap, it is also possible to specify the RGBA format.
To get the raw Vulkan format get the SwapChainFormat property.
|
| FrameNumber |
Gets the current frame number. The frame number is increased at the beginning of Render(Boolean, Boolean, Boolean) method and before calling Update method.
The first rendered frame number is 1 (0 means that no frame was rendered yet).
See LastSubmittedFrameNumber to get the frame number that was lastly submitted to the graphics card.
|
| GpuDevice |
Gets the VulkanDevice that was used to initialize this SceneView.
|
| GraphicsCommandPool |
Gets the default graphics command pool.
|
| Height |
Gets the final height in pixels of the texture that is shown by this SceneView.
In case when SupersamplingCount is more than 1, then the height of the texture that is used for rendering
is by SupersamplingFactor factor bigger than the value of this property (see RenderHeight).
The super-scaled texture is then down-sampled to this width.
|
| IsCollectingStatistics |
Gets or sets a Boolean that specified is statistics is collected during rendering.
Statistics is written to the Statistics property.
|
| IsLicenseLogoShown |
Returns true if license logo (AB4D Logo with "POWERED BY SHARP ENGINE" text) is shown. When this image is shown no other 3D object can be shown.
This is shown for the free open-source license when the SharpEngine is started. To be informed when this image is hidden use OnLicenseLogoRemoved Action.
|
| IsPerSampleShading |
True when per-sample shading is used.
This can be used to eliminate aliasing and smooth out e.g. high frequency texture maps.
To set the value of per-sample shading, set the PreferredIsPerSampleShading before the SceneView is initialized.
|
| LastSubmittedFrameNumber |
Gets a frame number that was submitted to the graphics card for execution.
This may be lower than the FrameNumber because FrameNumber is increased before the Update phase, when the LastSubmittedFrameNumber is set when the frame is sent to the graphics card.
This value is increased in the InitializeRenderingStep.
|
| MainRenderPass |
Gets the GpuRenderPass that is used to render the objects in the scene.
|
| MaxConcurrentlySubmittedFrames |
Gets the number of frames that can be rendered in the background on the graphics card.
In case when the engine is waiting for the graphics card to finish rendering, then this value is 0 (no background rendering while this app is being executed).
Otherwise this value can be as big as SwapChainImagesCount.
|
| MSAAImage |
Gets the GpuImage that is used as multi-sampled buffer.
When using super-sampling, then this GpuImage is scaled by the SupersamplingFactor.
|
| MultisampleCount |
MultisampleCount defines the multi-sampling count (MSAA) used by this SceneView.
This value can be set when calling Initialize method or after the SceneView is initialized by calling the Resize method.
Default value is 1 (no multi-sampling).
See remarks for more info.
|
| MultisampleCountFlags |
Gets used multi-sampling as a SampleCountFlags.
|
| OnLicenseLogoRemoved |
An Action that can be set to a user code that is called when the license logo (AB4D Logo with "POWERED BY SHARP ENGINE" text) is removed and
SharpEngine can start showing other 3D objects. License logo is shown for the free open-source license when the SharpEngine is started.
|
| OverlaySpritesRenderingLayer |
Gets a RenderingLayer that contains sprites that are rendered after 3D objects are rendered. This RenderingLayer is not added to Ab4d.SharpEngine.RenderingLayers collection but is rendered in RenderSpritesRenderingStep.
|
| PreferredIsPerSampleShading |
PreferredIsPerSampleShading can be set before the SceneView is initialized and defines if the per-sample shading is used.
After initializing the SceneView, the actually used multi-sampling count is set to the IsPerSampleShading property.
|
| PreferredMultiSampleCount | Obsolete.
|
| PresentQueue |
Gets the present queue.
|
| PrimaryCommandBuffers |
Get an array of primary command buffers.
|
| RenderBackgroundSpritesRenderingStep |
Default RenderSpritesRenderingStep that render background sprites.
|
| RenderHeight |
Gets the height in pixels that is used for rendering of this SceneView.
In case when SupersamplingCount is more than 1, then this value is calculated as Height multiplied by SupersamplingFactor.
The super-scaled texture is then down-sampled to the final height that is defined by Height property.
|
| RenderingContext |
Gets the RenderingContext |
| RenderingSteps |
Gets the rendering steps that are executed to render a frame.
|
| RenderOverlaySpritesRenderingStep |
Default RenderSpritesRenderingStep that render overlay sprites.
|
| RenderWidth |
Gets the width in pixels that is used for rendering of this SceneView.
In case when SupersamplingCount is more than 1, then this value is calculated as Width multiplied by SupersamplingFactor.
The super-scaled texture is then down-sampled to the final width that is defined by Width property.
|
| SSAAImage |
Gets the GpuImage that is used when the SupersamplingFactor is bigger than 1.
When no multi-sampling is used, then the 3D scene is rendered to this GpuImage.
When super-sampling is used, then this GpuImage is resoved from the MSAAImage.
This GpuImage is down-samples to the final swap-chin image in the post-process.
|
| SSAAResolveRenderPass |
Gets the GpuRenderPass that is used to resolve the super-sampled (SSAA) image to the final image.
|
| Statistics |
Gets the RenderingStatistics that was taken during the rendering of the last frame.
To enable collecting statistics set the IsCollectingStatistics to true.
When no statistics is collected, then this property is set to null.
|
| SupersamplingCount |
SupersamplingCount gets the super-sampling count (SSAA) that is used by this SceneView.
This value can be set when calling Initialize method or after the SceneView is initialized by calling the Resize method.
Default value is 1 (no super-sampling).
See remarks for more info.
|
| SupersamplingFactor |
Gets the factor by which width and height are multiplied because of the SupersamplingCount,
for example when SupersamplingCount is 4, then SupersamplingFactor is 2 because width and height are multiplied by 2.
Default value is 1 (no super-sampling).
|
| Surface |
Gets the Vulkan surface that will show the rendered SceneView.
Set to SurfaceKHR.Null when no surface is used.
|
| SurfaceDetails |
Gets SurfaceDetails of the used Surface.
|
| SwapChain |
Gets the GpuSwapChain
|
| SwapChainFormat |
Gets the format of the SwapChain. To get format as a StandardBitmapFormats enum value, get the Format property.
|
| SwapChainImagesCount |
Gets the number of used swap chain images.
|
| UsedMultiSampleCount | Obsolete.
|
| UsedMultiSampleCountFlags | Obsolete.
|
| UseSurfacePreTransform |
Gets or sets a Boolean that specifies if Surface pre-transform is used (view is rendered with the same rotation as the surface).
|
| ViewRotation |
Gets or sets rotation of the view (sometimes also called view pre-transform).
|
| WaitForVSync |
Gets or sets a Boolean that specifies if the SceneView is waiting for a v-sync provided by the surface.
Default value is true.
|
| Width |
Gets the final width in pixels of the texture that is shown by this SceneView.
In case when SupersamplingCount is more than 1, then the width of the texture that is used for rendering
is by SupersamplingFactor factor bigger than the value of this property (see RenderWidth).
The super-scaled texture is then down-sampled to this width.
|
Properties