1. Epic GamesDeveloper
  3. UKismetRenderingLibrary

UKismetRenderingLibrary

API > API/Runtime > API/Runtime/Engine

   
Name UKismetRenderingLibrary
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Kismet/KismetRenderingLibrary.h
Include Path #include "Kismet/KismetRenderingLibrary.h"

Syntax

UCLASS (MinimalAPI, Meta=(ScriptName="RenderingLibrary"))  
class UKismetRenderingLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UKismetRenderingLibrary ( const FObjectInitializer& ObjectInitializer
)

   Kismet/KismetRenderingLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static void BeginDrawCanvasToRenderTarget ( UObject* WorldContextObject,
UTextureRenderTarget2D* TextureRenderTarget,
UCanvas*& Canvas,
FVector2D& Size,
FDrawToRenderTargetContext& Context
)

 Returns a Canvas object that can be used to draw to the specified render target. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="BeginDrawCanvasToRenderTarget", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static void BreakSkinWeightInfo ( FSkelMeshSkinWeightInfo InWeight,
int32& Bone0,
uint8& Weight0,
int32& Bone1,
uint8& Weight1,
int32& Bone2,
uint8& Weight2,
int32& Bone3,
uint8& Weight3
)

 Break FSkelMeshSkinWeightInfo Kismet/KismetRenderingLibrary.h
  • BlueprintPure
  • Category="Rendering"
  • Meta=(NativeBreakFunc)

static FMatrix CalculateProjectionMatrix ( const FMinimalViewInfo& MinimalViewInfo
)

 Calculates the projection matrix using this view info's aspect ratio (regardless of bConstrainAspectRatio) Kismet/KismetRenderingLibrary.h
  • BlueprintPure
  • Category="Rendering"
  • Meta=(DisplayName="Calculate Projection Matrix (Minimal View Info)", ScriptMethod="CalculateProjectionMatrix")

static void ClearRenderTarget2D ( UObject* WorldContextObject,
UTextureRenderTarget2D* TextureRenderTarget,
FLinearColor ClearColor
)

 Clears the specified render target with the given ClearColor. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="ClearRenderTarget", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static void ConvertRenderTargetToTexture2DArrayEditorOnly ( UObject* WorldContextObject,
UTextureRenderTarget2DArray* RenderTarget,
UTexture2DArray* Texture
)

 Copies the contents of a UTextureRenderTarget2DArray to a UTexture2DArray Only works in the editor Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Rendering"
  • Meta=(Keywords="Convert Render Target", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static void ConvertRenderTargetToTexture2DEditorOnly ( UObject* WorldContextObject,
UTextureRenderTarget2D* RenderTarget,
UTexture2D* Texture
)

 Copies the contents of a UTextureRenderTarget2D to a UTexture2D Only works in the editor Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Rendering"
  • Meta=(Keywords="Convert Render Target", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static void ConvertRenderTargetToTextureCubeEditorOnly ( UObject* WorldContextObject,
UTextureRenderTargetCube* RenderTarget,
UTextureCube* Texture
)

 Copies the contents of a UTextureRenderTargetCube to a UTextureCube Only works in the editor Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Rendering"
  • Meta=(Keywords="Convert Render Target", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static void ConvertRenderTargetToTextureVolumeEditorOnly ( UObject* WorldContextObject,
UTextureRenderTargetVolume* RenderTarget,
UVolumeTexture* Texture
)

 Copies the contents of a UTextureRenderTargetVolume to a UVolumeTexture Only works in the editor Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Rendering"
  • Meta=(Keywords="Convert Render Target", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static UTextureRenderTarget2D * CreateRenderTarget2D ( UObject* WorldContextObject,
int32 Width,
int32 Height,
ETextureRenderTargetFormat Format,
FLinearColor ClearColor,
bool bAutoGenerateMipMaps,
bool bSupportUAVs
)

 Creates a new render target and initializes it to the specified dimensions Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(WorldContext="WorldContextObject")

static UTextureRenderTarget2DArray * CreateRenderTarget2DArray ( UObject* WorldContextObject,
int32 Width,
int32 Height,
int32 Slices,
ETextureRenderTargetFormat Format,
FLinearColor ClearColor,
bool bAutoGenerateMipMaps,
bool bSupportUAVs
)

 Creates a new render target array and initializes it to the specified dimensions Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(WorldContext="WorldContextObject")

static UTextureRenderTargetVolume * CreateRenderTargetVolume ( UObject* WorldContextObject,
int32 Width,
int32 Height,
int32 Depth,
ETextureRenderTargetFormat Format,
FLinearColor ClearColor,
bool bAutoGenerateMipMaps,
bool bSupportUAVs
)

 Creates a new volume render target and initializes it to the specified dimensions Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(WorldContext="WorldContextObject")

static void DrawMaterialToRenderTarget ( UObject* WorldContextObject,
UTextureRenderTarget2D* TextureRenderTarget,
UMaterialInterface* Material
)

 Renders a quad with the material applied to the specified render target. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="DrawMaterialToRenderTarget", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static void EnablePathTracing ( bool bEnablePathTracer
)

 Enables or disables the path tracer for the current Game Viewport. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="EnablePathTracing")

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

 Must be paired with a BeginDrawCanvasToRenderTarget to complete rendering to a render target. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="EndDrawCanvasToRenderTarget", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")

static void ExportRenderTarget ( UObject* WorldContextObject,
UTextureRenderTarget2D* TextureRenderTarget,
const FString& FilePath,
const FString& FileName
)

 Exports a render target as a HDR or PNG image onto the disk (depending on the format of the render target) Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="ExportRenderTarget", WorldContext="WorldContextObject")

static void ExportTexture2D ( UObject* WorldContextObject,
UTexture2D* Texture,
const FString& FilePath,
const FString& FileName
)

 Exports a Texture2D as a HDR image onto the disk. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="ExportTexture2D", WorldContext="WorldContextObject")

static UTexture2D * ImportBufferAsTexture2D ( UObject* WorldContextObject,
const TArray< uint8 >& Buffer
)

 Imports a texture from a buffer and creates Texture2D from it. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(WorldContext="WorldContextObject")

static UTexture2D * ImportFileAsTexture2D ( UObject* WorldContextObject,
const FString& Filename
)

 Imports a texture file from disk and creates Texture2D from it. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(WorldContext="WorldContextObject")

static FSkelMeshSkinWeightInfo MakeSkinWeightInfo ( int32 Bone0,
uint8 Weight0,
int32 Bone1,
uint8 Weight1,
int32 Bone2,
uint8 Weight2,
int32 Bone3,
uint8 Weight3
)

 Create FSkelMeshSkinWeightInfo Kismet/KismetRenderingLibrary.h
  • BlueprintPure
  • Category="Rendering"
  • Meta=(NativeMakeFunc)

static int32 NumPrecompilingPSOsRemaining()

 Returns the number of active PSO precompilation tasks which are still running - can be used to extend loading screens to wait for PSO precaching to be finished Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering | Pipeline Cache"

static bool ReadRenderTarget ( UObject* WorldContextObject,
UTextureRenderTarget2D* TextureRenderTarget,
TArray< FColor >& OutSamples,
bool bNormalize
)

 Incredibly inefficient and slow operation! Reads entire render target as sRGB color and returns a linear array of sRGB colors. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="ReadRenderTarget", WorldContext="WorldContextObject")

static FColor ReadRenderTargetPixel ( UObject* WorldContextObject,
UTextureRenderTarget2D* TextureRenderTarget,
int32 X,
int32 Y
)

 Incredibly inefficient and slow operation! Read a value as sRGB color from a render target using integer pixel coordinates. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="ReadRenderTarget", WorldContext="WorldContextObject")

static bool ReadRenderTargetRaw ( UObject* WorldContextObject,
UTextureRenderTarget2D* TextureRenderTarget,
TArray< FLinearColor >& OutLinearSamples,
bool bNormalize
)

 Incredibly inefficient and slow operation! Read entire texture as-is from a render target. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="ReadRenderTarget", WorldContext="WorldContextObject")

static FLinearColor ReadRenderTargetRawPixel ( UObject* WorldContextObject,
UTextureRenderTarget2D* TextureRenderTarget,
int32 X,
int32 Y,
bool bNormalize
)

 Incredibly inefficient and slow operation! Read a value as-is from a render target using integer pixel coordinates. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="ReadRenderTarget", WorldContext="WorldContextObject")

static TArray< FLinearColor > ReadRenderTargetRawPixelArea ( UObject* WorldContextObject,
UTextureRenderTarget2D* TextureRenderTarget,
int32 MinX,
int32 MinY,
int32 MaxX,
int32 MaxY,
bool bNormalize
)

 Incredibly inefficient and slow operation! Read an area of values as-is from a render target using a rectangle defined by integer pixel coordinates. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="ReadRenderTarget", WorldContext="WorldContextObject")

static FLinearColor ReadRenderTargetRawUV ( UObject* WorldContextObject,
UTextureRenderTarget2D* TextureRenderTarget,
float U,
float V,
bool bNormalize
)

 Incredibly inefficient and slow operation! Read a value as-is from a render target using UV [0,1]x[0,1] coordinates. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="ReadRenderTarget", WorldContext="WorldContextObject")

static TArray< FLinearColor > ReadRenderTargetRawUVArea ( UObject* WorldContextObject,
UTextureRenderTarget2D* TextureRenderTarget,
FBox2D Area,
bool bNormalize
)

 Incredibly inefficient and slow operation! Read an area of values as-is from a render target using a rectangle defined by UV [0,1]x[0,1] coordinates. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="ReadRenderTarget", WorldContext="WorldContextObject")

static FColor ReadRenderTargetUV ( UObject* WorldContextObject,
UTextureRenderTarget2D* TextureRenderTarget,
float U,
float V
)

 Incredibly inefficient and slow operation! Read a value as sRGB color from a render target using UV [0,1]x[0,1] coordinates. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="ReadRenderTarget", WorldContext="WorldContextObject")

static void RefreshPathTracingOutput ()

 Forces the path tracer to restart sample accumulation. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="PathTracing")

static void ReleaseRenderTarget2D ( UTextureRenderTarget2D* TextureRenderTarget
)

 Manually releases GPU resources of a render target. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"

static UTexture2DArray * RenderTargetCreateStaticTexture2DArrayEditorOnly ( UTextureRenderTarget2DArray* RenderTarget,
FString Name,
enum TextureCompressionSettings CompressionSettings,
enum TextureMipGenSettings MipSettings
)

 Creates a new Static Texture 2D Array from a Render Target 2D Array. Only works in the editor Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Rendering"
  • Meta=(DisplayName="Render Target 2D Array Create Static Texture 2D Array Editor Only", Keywords="Create Static Texture from Render Target", UnsafeDuringActorConstruction="true")

static UTexture2D * RenderTargetCreateStaticTexture2DEditorOnly ( UTextureRenderTarget2D* RenderTarget,
FString Name,
enum TextureCompressionSettings CompressionSettings,
enum TextureMipGenSettings MipSettings
)

 Creates a new Static Texture from a Render Target 2D. Only works in the editor Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Rendering"
  • Meta=(DisplayName="Render Target 2D Create Static Texture 2D Editor Only", Keywords="Create Static Texture from Render Target", UnsafeDuringActorConstruction="true")

static UTextureCube * RenderTargetCreateStaticTextureCubeEditorOnly ( UTextureRenderTargetCube* RenderTarget,
FString Name,
enum TextureCompressionSettings CompressionSettings,
enum TextureMipGenSettings MipSettings
)

 Creates a new Static Texture Cube from a Render Target Cube. Only works in the editor Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Rendering"
  • Meta=(DisplayName="Render Target Cube Create Static Texture Cube Editor Only", Keywords="Create Static Texture from Render Target", UnsafeDuringActorConstruction="true")

static UVolumeTexture * RenderTargetCreateStaticVolumeTextureEditorOnly ( UTextureRenderTargetVolume* RenderTarget,
FString Name,
enum TextureCompressionSettings CompressionSettings,
enum TextureMipGenSettings MipSettings
)

 Creates a new Static Volume Texture from a Render Target Volume. Only works in the editor Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Rendering"
  • Meta=(DisplayName="Render Target Volume Create Static Volume Texture Editor Only", Keywords="Create Static Texture from Render Target", UnsafeDuringActorConstruction="true")

static void ResizeRenderTarget2D ( UTextureRenderTarget2D* TextureRenderTarget,
int32 Width,
int32 Height
)

 Changes the resolution of a render target. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"

static void SetCastInsetShadowForAllAttachments ( UPrimitiveComponent* PrimitiveComponent,
bool bCastInsetShadow,
bool bLightAttachmentsAsGroup
)

 Set the inset shadow casting state of the given component and all its child attachments. Kismet/KismetRenderingLibrary.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(Keywords="SetCastShadowForAllAttachments", UnsafeDuringActorConstruction="true")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page