CanvasRenderTarget2D.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Templates/SubclassOf.h"
#include "UObject/ScriptMacros.h"
#include "Engine/TextureRenderTarget2D.h"
#include "CanvasRenderTarget2D.generated.h"
 
class UCanvas;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FOnCanvasRenderTargetUpdate, UCanvas*, Canvas, int32, Width, int32, Height);
 
 
UCLASS(BlueprintType, Blueprintable, MinimalAPI)
class UCanvasRenderTarget2D
    : public UTextureRenderTarget2D
{
    GENERATED_UCLASS_BODY()
 
public:
    ENGINE_API virtual void UpdateResourceWithParams(EUpdateResourceFlags InFlags) override;
 
    UFUNCTION(BlueprintCallable, Category="Canvas Render Target 2D")
    void UpdateResource() { UpdateResourceWithParams(EUpdateResourceFlags::None); }
 
    UFUNCTION(BlueprintCallable, Category="Canvas Render Target 2D",meta=(WorldContext="WorldContextObject" ))
    static ENGINE_API UCanvasRenderTarget2D* CreateCanvasRenderTarget2D(UObject* WorldContextObject, TSubclassOf<UCanvasRenderTarget2D> CanvasRenderTarget2DClass, int32 Width = 1024, int32 Height = 1024);
 
    UFUNCTION(BlueprintImplementableEvent, Category="Canvas Render Target 2D")
    ENGINE_API void ReceiveUpdate(UCanvas* Canvas, int32 Width, int32 Height);
 
    UFUNCTION(BlueprintPure, Category="Canvas Render Target 2D")
    ENGINE_API void GetSize(int32& Width, int32& Height);
 
 
    UPROPERTY(BlueprintAssignable, Category="Canvas Render Target 2D")
    FOnCanvasRenderTargetUpdate OnCanvasRenderTargetUpdate;
 
    // UObject overrides
    ENGINE_API virtual UWorld* GetWorld() const override;
 
    ENGINE_API void FastUpdateResource();
 
    inline bool ShouldClearRenderTargetOnReceiveUpdate() const { return bShouldClearRenderTargetOnReceiveUpdate; }
    inline void SetShouldClearRenderTargetOnReceiveUpdate(bool bInShouldClearRenderTargetOnReceiveUpdate)
    {
        bShouldClearRenderTargetOnReceiveUpdate = bInShouldClearRenderTargetOnReceiveUpdate;
    }
 
    UFUNCTION(BlueprintGetter)
    ENGINE_API virtual ETextureRenderTargetSampleCount GetSampleCount() const override;
 
    UFUNCTION(BlueprintSetter)
    ENGINE_API void SetSampleCount(ETextureRenderTargetSampleCount InSampleCount);
 
#if WITH_EDITOR
    ENGINE_API virtual bool CanEditChange(const FProperty* InProperty) const override;
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
 
protected:
 
    ENGINE_API void RepaintCanvas();
 
    void OnSampleCountChanged();
 
    /* The world this render target will be used with */
    UPROPERTY()
    TWeakObjectPtr<UWorld> World;
 
    UPROPERTY(EditAnywhere, BlueprintGetter = GetSampleCount, BlueprintSetter = SetSampleCount, Category = TextureRenderTarget2D, AssetRegistrySearchable, AdvancedDisplay, meta = (AllowPrivateAccess = "true"))
    ETextureRenderTargetSampleCount SampleCount;
    
    // If true, clear the render target to green whenever OnReceiveUpdate() is called.  (Defaults to true.)
    // If false, the render target will retain whatever values it had, allowing the user to update only areas that
    // have changed.
    UPROPERTY(Transient)
    bool bShouldClearRenderTargetOnReceiveUpdate;
};