Ab4d.SharpEngine help
Ab4d.SharpEngine Namespaces
Ab4d.SharpEngine
SceneView Class
SceneView Methods
AddAnimation Method
BoundingBox3DTo2D Method
CalculateCameraPlanes Method
CanConvertPoint3DTo2D Method
CaptureNextFrame Method
CaptureNextFrameInRenderDoc Method
ChooseDepthStencilFormat Method
ChooseSwapPresentMode Method
ChooseSwapSurfaceFormat Method
CreateBackgroundSpriteBatch Method
CreateOverlaySpriteBatch Method
Dispose Method
DisposeBackBuffers Method
DumpCameraInfo Method
DumpRenderingStatistics Method
DumpRenderingSteps Method
GetAllHitObjects Method
GetCameraInfo Method
GetClosestHitObject Method
GetCurrentSurfaceSize Method
GetCurrentSwapChainImage Method
GetImageAvailableSemaphore Method
GetRayFromCamera Method
GetRayFromNearPlane Method
GetRenderFinishedSemaphore Method
GetRenderingStatisticsInfo Method
GetRenderingStepsInfo Method
GetWorldToViewMatrix Method
GetWorldToViewportMatrix Method
Initialize Method
InitializeWithDefaultSurface Method
IsCaptureFrameAvailable Method
IsFrameRenderingFinished Method
Line3DTo2D Method
NotifyChange Method
OnBackBuffersCreated Method
OnInitializeDeviceResources Method
OnSceneRendered Method
OnSceneUpdating Method
OnViewResized Method
Point3DTo2D Method
Points3DTo2D Method
RegisterStagingGpuBufferReadyCallback Method
RegisterStagingGpuImageReadyCallback Method
RemoveAllSpriteBatches Method
RemoveAnimation Method
RemoveSpriteBatch Method
Render Method
RenderToGpuBuffer Method
RenderToGpuImage Method
RenderToRawImageData Method
Resize Method
ToString Method
UnregisterStagingGpuBufferReadyCallback Method
UnregisterStagingGpuImageReadyCallback Method
UpdateAnimations Method
UpdateCameraNearAndFarPlanes Method
UpdateCustomSceneDescriptorSet Method
WaitUntilRendered Method
Click or drag to resize
Ab4d.SharpEngine logo

SceneViewRenderToGpuImage Method

Renders the current scene view to the bitmap and saves the image data a GpuImage that is passed to the specified stagingGpuImageReady Action. To render to a different size or different multi-sample or super-sampling count, create a new SceneView and call RenderToGpuImage there.

Namespace: Ab4d.SharpEngine
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 3.1.9316+94bbd23b55747f096f056a5602f7dd90558b3673
Syntax
C#
Copy
public void RenderToGpuImage(
	bool renderNewFrame = true,
	bool preserveGpuImage = true,
	StandardBitmapFormats format = StandardBitmapFormats.Undefined,
	Action<GpuImage>? stagingGpuImageReady = null
)

Parameters

renderNewFrame  Boolean  (Optional)
renders a new frame before creating a bitmap (true by default)
preserveGpuImage  Boolean  (Optional)
when true then the GpuImage is preserved for the next call of RenderToBitmap. When false then the used GpuImage is disposed before returning from this method. (false by default).
format  StandardBitmapFormats  (Optional)
format of the rendered bitmap (Undefined by default - in this case the value of the SceneView.Format is used)
stagingGpuImageReady  ActionGpuImage  (Optional)
Action that will copy the data from the staging GpuImage
Remarks

[Missing <remarks> documentation for "M:Ab4d.SharpEngine.SceneView.RenderToGpuImage(System.Boolean,System.Boolean,Ab4d.SharpEngine.Common.StandardBitmapFormats,System.Action{Ab4d.SharpEngine.Core.GpuImage})"]

See Also