RealDocs

UKismetRenderingLibrary::EndDrawCanvasToRenderTarget

function Engine Blueprint Since unknown
#include "Kismet/KismetRenderingLibrary.h"
Access: public Specifiers: staticUFUNCTIONBlueprintCallable

Description

Completes a canvas drawing session started by BeginDrawCanvasToRenderTarget, flushing the queued draw calls to the render target.

Caveats & Gotchas

  • Must be called with the exact Context returned by the matching BeginDrawCanvasToRenderTarget — passing a stale or default-constructed context is a common source of bugs.
  • Nothing is actually rendered to the target until this is called; the Canvas draw calls issued between Begin and End are only queued.
  • Calling this without a preceding Begin, or calling it twice for one Begin, is undefined and should be avoided.

Signature

static void EndDrawCanvasToRenderTarget(UObject* WorldContextObject, const FDrawToRenderTargetContext& Context)

Parameters

Name Type Description Default
WorldContextObject UObject* World context used to resolve the current world.
Context const FDrawToRenderTargetContext& The context returned by the matching BeginDrawCanvasToRenderTarget call.

Return Type

void

Example

Finish a canvas draw session Blueprint
After issuing Canvas draw calls following Begin Draw Canvas To Render Target, call End Draw Canvas To Render Target passing the same Context output pin to finalize the render target contents.

Version History

Introduced in: unknown

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.