1. Epic GamesDeveloper
  3. UCanvasRenderTarget2D

UCanvasRenderTarget2D

CanvasRenderTarget2D is 2D render target which exposes a Canvas interface to allow you to draw elements onto it directly.

Unreal Engine C++ API Reference > Runtime > Engine > Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Engine/CanvasRenderTarget2D.h
Include #include "Engine/CanvasRenderTarget2D.h"

Syntax

UCLASS (BlueprintType, Blueprintable, MinimalAPI)  
class UCanvasRenderTarget2D : public UTextureRenderTarget2D

Remarks

CanvasRenderTarget2D is 2D render target which exposes a Canvas interface to allow you to draw elements onto it directly. Use CreateCanvasRenderTarget2D() to create a render target texture by unique name, then bind a function to the OnCanvasRenderTargetUpdate delegate which will be called when the render target is updated. If you need to repaint your canvas every single frame, simply call UpdateResource() on it from a Tick function. Also, remember to hold onto your new canvas render target with a reference so that it doesn't get garbage collected.

Variables

  Type Name Description
Protected variable bool bShouldClearRenderTargetOnReceiveUpdate If true, clear the render target to green whenever OnReceiveUpdate() is called.
Public variable UProperty Category BlueprintAssignable FOnCanvasRenderTargetUpdate OnCanvasRenderTargetUpdate Called when this Canvas Render Target is asked to update its texture resource.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta assetregistrysearchable, blueprintgetter, blueprintsetter ETextureRenderTargetSampleCount SampleCount MSAA sample count.
Protected variable UProperty TWeakObjectPtr< UWorld > World The world this render target will be used with

Constructors

  Type Name Description
Public function  

UCanvasRenderTarget2D ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category, Meta UCanvasRenderTarget2D *

CreateCanvasRenderTarget2D ( UObject* WorldContextObject,
TSubclassOf< UCanvasRenderTarget2D > CanvasRenderTarget2DClass,
int32 Width,
int32 Height
)

 Creates a new canvas render target and initializes it to the specified dimensions
Public function void Don't delete the underlying resource if it already exists
Public function UFunction BlueprintPure, Category void

GetSize ( int32& Width,
int32& Height
)

 Gets a specific render target's size from the global map of canvas render targets.
Public function Virtual Const UWorld *  
Protected function void  
Public function UFunction Category, BlueprintImplementableEvent void

ReceiveUpdate ( UCanvas* Canvas,
int32 Width,
int32 Height
)

 Allows a Blueprint to implement how this Canvas Render Target 2D should be updated.
Protected function void  
Public function UFunction blueprintsetter void  
Public function void

SetShouldClearRenderTargetOnReceiveUpdate ( bool bInShouldClearRenderTargetOnReceiveUpdate
)

  
Public function Const bool  

Overridden from UTextureRenderTarget2D

  Type Name Description
Public function Virtual Const UFunction blueprintgetter ETextureRenderTargetSampleCount  

Overridden from UTexture

  Type Name Description
Public function Virtual UFunction BlueprintCallable, Category void Updates the the canvas render target texture's resource.

Overridden from UObject

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page