1. Epic GamesDeveloper
  3. UKismetRenderingLibrary

UKismetRenderingLibrary

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

Inheritance Hierarchy

References

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

Syntax

class UKismetRenderingLibrary : public UBlueprintFunctionLibrary

Constructors

  Type Name Description
Public function  

UKismetRenderingLibrary ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function 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.
Public function Static void

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

 Break FSkelMeshSkinWeightInfo
Public function Static FMatrix

CalculateProjectionMatrix ( const FMinimalViewInfo& MinimalViewInfo
)

 Calculates the projection matrix using this view info's aspect ratio (regardless of bConstrainAspectRatio)
Public function Static void

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

 Clears the specified render target with the given ClearColor.
Public function Static void

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

 Copies the contents of a render target to a UTexture2D Only works in the editor
Public function 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
Public function 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
Public function 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
Public function Static void

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

 Renders a quad with the material applied to the specified render target.
Public function Static void

EnablePathTracing ( bool bEnablePathTracer
)

 Enables or disables the path tracer for the current Game Viewport.
Public function Static void

EndDrawCanvasToRenderTarget ( UObject* WorldContextObject,
const FDrawToRenderTargetContext& Context
)

 Must be paired with a BeginDrawCanvasToRenderTarget to complete rendering to a render target.
Public function 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)
Public function Static void

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

 Exports a Texture2D as a HDR image onto the disk.
Public function Static UTexture2D *

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

 Imports a texture from a buffer and creates Texture2D from it.
Public function Static UTexture2D *

ImportFileAsTexture2D ( UObject* WorldContextObject,
const FString& Filename
)

 Imports a texture file from disk and creates Texture2D from it.
Public function Static FSkelMeshSkinWeightInfo

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

 Create FSkelMeshSkinWeightInfo
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function Static void Forces the path tracer to restart sample accumulation.
Public function Static void Manually releases GPU resources of a render target.
Public function 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
Public function Static void

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

 Changes the resolution of a render target.
Public function Static void

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

 Set the inset shadow casting state of the given component and all its child attachments.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page