UKismetRenderingLibrary

class Engine Blueprint Since 4.0

Inherits: UObjectBase › UObjectBaseUtility › UObject › UBlueprintFunctionLibrary › UKismetRenderingLibrary

#include "Kismet/KismetRenderingLibrary.h"

Description

Blueprint function library for creating and manipulating render targets, converting them to static textures, and reading pixel data back from the GPU.

Caveats & Gotchas

• Most of the pixel-readback functions (ReadRenderTargetPixel, ReadRenderTargetUV, ReadRenderTarget) stall the render thread and copy the entire target from the GPU — do not call these every frame or in a hot loop.
• The RenderTargetCreateStaticTexture*EditorOnly and ConvertRenderTargetToTexture*EditorOnly functions only work in editor builds; calling them in a packaged game does nothing useful.
• All functions are static and stateless — the library holds no persistent render target references itself.

Example

Access from Blueprint Blueprint

All functions on this library appear directly as Blueprint nodes (no target pin needed) under the Rendering category, e.g. "Create Render Target 2D" or "Draw Material to Render Target".

Functions (36)

Rendering 28 Editor Scripting 8

Rendering

28 ▼

Access	Type	Name	Description
public	function	UKismetRenderingLibrary::BeginDrawCanvasToRenderTarget	Begins a canvas drawing session targeting a render target, returning a Canvas you can issue multiple draw calls on before finishing with EndDrawCanvasToRenderTarget.
public	function	UKismetRenderingLibrary::ClearRenderTarget2D	Clears the specified render target with the given ClearColor, filling every pixel.
public	function	UKismetRenderingLibrary::CreateRenderTarget2D	Creates a new render target and initializes it to the specified dimensions, format, and clear color.
public	function	UKismetRenderingLibrary::DrawMaterialToRenderTarget	Renders a full-screen quad with the given material applied directly into the specified render target.
public	function	UKismetRenderingLibrary::EndDrawCanvasToRenderTarget	Completes a canvas drawing session started by BeginDrawCanvasToRenderTarget, flushing the queued draw calls to the render target.
public	function	UKismetRenderingLibrary::ExportRenderTarget	Exports a render target as an HDR or PNG image to disk, choosing the format automatically based on the render target's own pixel format.
public	function	UKismetRenderingLibrary::ImportBufferAsTexture2D	Decodes an in-memory image buffer and creates a new transient Texture2D from it, without touching disk.
public	function	UKismetRenderingLibrary::ImportFileAsTexture2D	Loads an image file from disk and creates a new transient Texture2D from it.
public	function	UKismetRenderingLibrary::ResizeRenderTarget2D	Changes the resolution of an existing render target, useful when the game viewport size or in-game resolution changes at runtime.
public	function	UKismetRenderingLibrary::BreakSkinWeightInfo	Decomposes an FSkelMeshSkinWeightInfo struct into its four individual bone index/weight pairs.
public	function	UKismetRenderingLibrary::CalculateProjectionMatrix	Calculates a projection matrix from a FMinimalViewInfo, using its own aspect ratio regardless of whether bConstrainAspectRatio is set.
public	function	UKismetRenderingLibrary::CreateRenderTarget2DArray	Creates a new 2D render target array with the given number of slices and initializes it to the specified dimensions.
public	function	UKismetRenderingLibrary::CreateRenderTargetVolume	Creates a new volume render target and initializes it to the specified 3D dimensions, typically for volumetric effects written via compute shaders.
public	function	UKismetRenderingLibrary::EnablePathTracing	Enables or disables the path tracer for the current Game Viewport.
public	function	UKismetRenderingLibrary::ExportTexture2D	Writes a Texture2D to disk as an HDR image file.
public	function	UKismetRenderingLibrary::MakeSkinWeightInfo	Constructs an FSkelMeshSkinWeightInfo struct from up to four bone index/weight pairs.
public	function	UKismetRenderingLibrary::NumPrecompilingPSOsRemaining	Returns the number of active PSO (Pipeline State Object) precompilation tasks that are still running.
public	function	UKismetRenderingLibrary::ReadRenderTarget	Reads the entire render target back as sRGB colors into a linear array, one entry per pixel, and returns whether the read succeeded.
public	function	UKismetRenderingLibrary::ReadRenderTargetPixel	Reads a single pixel from a render target using integer pixel coordinates, returning it as an 8-bit sRGB FColor.
public	function	UKismetRenderingLibrary::ReadRenderTargetRaw	Reads the entire render target as raw, unconverted linear values in a single readback, filling OutLinearSamples with one entry per pixel.
public	function	UKismetRenderingLibrary::ReadRenderTargetRawPixel	Reads a single pixel from a render target as-is (no sRGB conversion) at an integer pixel coordinate, returning the raw linear value.
public	function	UKismetRenderingLibrary::ReadRenderTargetRawPixelArea	Reads a rectangular region of a render target as raw, unconverted linear values, returning one entry per pixel.
public	function	UKismetRenderingLibrary::ReadRenderTargetRawUV	Reads a single raw, unconverted pixel value from a render target at a UV coordinate in [0,1]x[0,1] space.
public	function	UKismetRenderingLibrary::ReadRenderTargetRawUVArea	Reads a rectangular region of a render target as raw, unconverted linear values, with the rectangle expressed in UV [0,1]x[0,1] space rather than pixel coordinates.
public	function	UKismetRenderingLibrary::ReadRenderTargetUV	Reads a single pixel from a render target using normalized UV [0,1]x[0,1] coordinates, returning it as an 8-bit sRGB FColor.
public	function	UKismetRenderingLibrary::RefreshPathTracingOutput	Forces the path tracer to restart sample accumulation, useful when a scene change isn't automatically detected.
public	function	UKismetRenderingLibrary::ReleaseRenderTarget2D	Manually releases the GPU resources of a render target instead of waiting for the garbage collector, useful when creating many short-lived render targets at runtime.
public	function	UKismetRenderingLibrary::SetCastInsetShadowForAllAttachments	Sets the inset shadow casting state on a component and recursively on all of its child attachments, optionally grouping them to share a single depth target.

Editor Scripting

8 ▼

Access	Type	Name	Description
public	function	UKismetRenderingLibrary::ConvertRenderTargetToTexture2DArrayEditorOnly	Copies the current contents of a render target array into an existing Texture2DArray asset, overwriting its pixel data.
public	function	UKismetRenderingLibrary::ConvertRenderTargetToTexture2DEditorOnly	Copies the current contents of a render target into an existing Texture2D asset, overwriting its pixel data.
public	function	UKismetRenderingLibrary::ConvertRenderTargetToTextureCubeEditorOnly	Copies the current contents of a cube render target into an existing TextureCube asset, overwriting its pixel data.
public	function	UKismetRenderingLibrary::ConvertRenderTargetToTextureVolumeEditorOnly	Copies the current contents of a volume render target into an existing VolumeTexture asset, overwriting its pixel data.
public	function	UKismetRenderingLibrary::RenderTargetCreateStaticTexture2DArrayEditorOnly	Creates a new static Texture2DArray asset from the current contents of a render target array.
public	function	UKismetRenderingLibrary::RenderTargetCreateStaticTexture2DEditorOnly	Creates a new static Texture2D asset from the current contents of a render target.
public	function	UKismetRenderingLibrary::RenderTargetCreateStaticTextureCubeEditorOnly	Creates a new static TextureCube asset from the current contents of a cube render target, typically used to bake captured reflection or skybox cubemaps.
public	function	UKismetRenderingLibrary::RenderTargetCreateStaticVolumeTextureEditorOnly	Creates a new static VolumeTexture asset from the current contents of a volume render target.

Version History

Introduced in: 4.0

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?