Class KismetRenderingLibrary

Kismet Rendering Library

Inheritance
System.Object
UObject
BlueprintFunctionLibrary
KismetRenderingLibrary
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class KismetRenderingLibrary : BlueprintFunctionLibrary

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static KismetRenderingLibrary DefaultObject { get; }
Property Value
Type Description
KismetRenderingLibrary
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

BeginDrawCanvasToRenderTarget(UObject, TextureRenderTarget2D)

Returns a Canvas object that can be used to draw to the specified render target.

Declaration
public static (Canvas, Vector2D, DrawToRenderTargetContext) BeginDrawCanvasToRenderTarget(UObject WorldContextObject, TextureRenderTarget2D TextureRenderTarget)
Parameters
Type Name Description
UObject WorldContextObject
TextureRenderTarget2D TextureRenderTarget
Returns
Type Description
System.ValueTuple<Canvas, Vector2D, DrawToRenderTargetContext>
Remarks

Canvas has functions like DrawMaterial with size parameters that can be used to draw to a specific area of a render target. Be sure to call EndDrawCanvasToRenderTarget to complete the rendering!

| Improve this Doc View Source

BreakSkinWeightInfo(SkelMeshSkinWeightInfo)

Break FSkelMeshSkinWeightInfo

Declaration
public static (int, byte, int, byte, int, byte, int, byte) BreakSkinWeightInfo(SkelMeshSkinWeightInfo InWeight)
Parameters
Type Name Description
SkelMeshSkinWeightInfo InWeight
Returns
Type Description
System.ValueTuple<System.Int32, System.Byte, System.Int32, System.Byte, System.Int32, System.Byte, System.Int32, System.ValueTuple<System.Byte>>
| Improve this Doc View Source

ClearRenderTarget2D(UObject, TextureRenderTarget2D, LinearColor)

Clears the specified render target with the given ClearColor.

Declaration
public static void ClearRenderTarget2D(UObject WorldContextObject, TextureRenderTarget2D TextureRenderTarget, LinearColor ClearColor)
Parameters
Type Name Description
UObject WorldContextObject
TextureRenderTarget2D TextureRenderTarget
LinearColor ClearColor
| Improve this Doc View Source

ConvertRenderTargetToTexture2DEditorOnly(UObject, TextureRenderTarget2D, Texture2D)

Copies the contents of a render target to a UTexture2D

Declaration
public static void ConvertRenderTargetToTexture2DEditorOnly(UObject WorldContextObject, TextureRenderTarget2D RenderTarget, Texture2D Texture)
Parameters
Type Name Description
UObject WorldContextObject
TextureRenderTarget2D RenderTarget
Texture2D Texture
Remarks

Only works in the editor

| Improve this Doc View Source

CreateRenderTarget2D(UObject, Int32, Int32, Byte)

Creates a new render target and initializes it to the specified dimensions

Declaration
public static TextureRenderTarget2D CreateRenderTarget2D(UObject WorldContextObject, int Width, int Height, byte Format)
Parameters
Type Name Description
UObject WorldContextObject
System.Int32 Width
System.Int32 Height
System.Byte Format
Returns
Type Description
TextureRenderTarget2D
| Improve this Doc View Source

DrawMaterialToRenderTarget(UObject, TextureRenderTarget2D, MaterialInterface)

Renders a quad with the material applied to the specified render target.

Declaration
public static void DrawMaterialToRenderTarget(UObject WorldContextObject, TextureRenderTarget2D TextureRenderTarget, MaterialInterface Material)
Parameters
Type Name Description
UObject WorldContextObject
TextureRenderTarget2D TextureRenderTarget
MaterialInterface Material
Remarks

This sets the render target even if it is already set, which is an expensive operation. Use BeginDrawCanvasToRenderTarget / EndDrawCanvasToRenderTarget instead if rendering multiple primitives to the same render target.

| Improve this Doc View Source

EndDrawCanvasToRenderTarget(UObject, DrawToRenderTargetContext)

Must be paired with a BeginDrawCanvasToRenderTarget to complete rendering to a render target.

Declaration
public static void EndDrawCanvasToRenderTarget(UObject WorldContextObject, DrawToRenderTargetContext Context)
Parameters
Type Name Description
UObject WorldContextObject
DrawToRenderTargetContext Context
| Improve this Doc View Source

ExportRenderTarget(UObject, TextureRenderTarget2D, String, String)

Exports a render target as a HDR or PNG image onto the disk (depending on the format of the render target)

Declaration
public static void ExportRenderTarget(UObject WorldContextObject, TextureRenderTarget2D TextureRenderTarget, string FilePath, string FileName)
Parameters
Type Name Description
UObject WorldContextObject
TextureRenderTarget2D TextureRenderTarget
System.String FilePath
System.String FileName
| Improve this Doc View Source

ExportTexture2D(UObject, Texture2D, String, String)

Exports a Texture2D as a HDR image onto the disk.

Declaration
public static void ExportTexture2D(UObject WorldContextObject, Texture2D Texture, string FilePath, string FileName)
Parameters
Type Name Description
UObject WorldContextObject
Texture2D Texture
System.String FilePath
System.String FileName
| Improve this Doc View Source

ImportBufferAsTexture2D(UObject, Byte)

Imports a texture from a buffer and creates Texture2D from it.

Declaration
public static Texture2D ImportBufferAsTexture2D(UObject WorldContextObject, byte Buffer)
Parameters
Type Name Description
UObject WorldContextObject
System.Byte Buffer
Returns
Type Description
Texture2D
| Improve this Doc View Source

ImportFileAsTexture2D(UObject, String)

Imports a texture file from disk and creates Texture2D from it.

Declaration
public static Texture2D ImportFileAsTexture2D(UObject WorldContextObject, string Filename)
Parameters
Type Name Description
UObject WorldContextObject
System.String Filename
Returns
Type Description
Texture2D
| Improve this Doc View Source

MakeSkinWeightInfo(Int32, Byte, Int32, Byte, Int32, Byte, Int32, Byte)

Create FSkelMeshSkinWeightInfo

Declaration
public static SkelMeshSkinWeightInfo MakeSkinWeightInfo(int Bone0, byte Weight0, int Bone1, byte Weight1, int Bone2, byte Weight2, int Bone3, byte Weight3)
Parameters
Type Name Description
System.Int32 Bone0
System.Byte Weight0
System.Int32 Bone1
System.Byte Weight1
System.Int32 Bone2
System.Byte Weight2
System.Int32 Bone3
System.Byte Weight3
Returns
Type Description
SkelMeshSkinWeightInfo
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static KismetRenderingLibrary New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
KismetRenderingLibrary
| Improve this Doc View Source

ReadRenderTargetPixel(UObject, TextureRenderTarget2D, Int32, Int32)

Incredibly inefficient and slow operation! Read a value as sRGB color from a render target using integer pixel coordinates.

Declaration
public static Color ReadRenderTargetPixel(UObject WorldContextObject, TextureRenderTarget2D TextureRenderTarget, int X, int Y)
Parameters
Type Name Description
UObject WorldContextObject
TextureRenderTarget2D TextureRenderTarget
System.Int32 X
System.Int32 Y
Returns
Type Description
Color
Remarks

LDR render targets are assumed to be in sRGB space. HDR ones are assumed to be in linear space. Result is 8-bit per channel [0,255] BGRA in sRGB space.

| Improve this Doc View Source

ReadRenderTargetRawPixel(UObject, TextureRenderTarget2D, Int32, Int32)

Incredibly inefficient and slow operation! Read a value as-is from a render target using integer pixel coordinates.

Declaration
public static LinearColor ReadRenderTargetRawPixel(UObject WorldContextObject, TextureRenderTarget2D TextureRenderTarget, int X, int Y)
Parameters
Type Name Description
UObject WorldContextObject
TextureRenderTarget2D TextureRenderTarget
System.Int32 X
System.Int32 Y
Returns
Type Description
LinearColor
| Improve this Doc View Source

ReadRenderTargetRawUV(UObject, TextureRenderTarget2D, Single, Single)

Incredibly inefficient and slow operation! Read a value as-is color from a render target using UV [0,1]x[0,1] coordinates.

Declaration
public static LinearColor ReadRenderTargetRawUV(UObject WorldContextObject, TextureRenderTarget2D TextureRenderTarget, float U, float V)
Parameters
Type Name Description
UObject WorldContextObject
TextureRenderTarget2D TextureRenderTarget
System.Single U
System.Single V
Returns
Type Description
LinearColor
| Improve this Doc View Source

ReadRenderTargetUV(UObject, TextureRenderTarget2D, Single, Single)

Incredibly inefficient and slow operation! Read a value as sRGB color from a render target using UV [0,1]x[0,1] coordinates.

Declaration
public static Color ReadRenderTargetUV(UObject WorldContextObject, TextureRenderTarget2D TextureRenderTarget, float U, float V)
Parameters
Type Name Description
UObject WorldContextObject
TextureRenderTarget2D TextureRenderTarget
System.Single U
System.Single V
Returns
Type Description
Color
Remarks

LDR render targets are assumed to be in sRGB space. HDR ones are assumed to be in linear space. Result is 8-bit per channel [0,255] BGRA in sRGB space.

| Improve this Doc View Source

ReleaseRenderTarget2D(TextureRenderTarget2D)

Manually releases GPU resources of a render target.

Declaration
public static void ReleaseRenderTarget2D(TextureRenderTarget2D TextureRenderTarget)
Parameters
Type Name Description
TextureRenderTarget2D TextureRenderTarget
Remarks

This is useful for blueprint creating a lot of render target that would normally be released too late by the garbage collector that can be problematic on platforms that have tight GPU memory constrains.

| Improve this Doc View Source

RenderTargetCreateStaticTexture2DEditorOnly(TextureRenderTarget2D, String, Byte, Byte)

Creates a new Static Texture from a Render Target 2D.

Declaration
public static Texture2D RenderTargetCreateStaticTexture2DEditorOnly(TextureRenderTarget2D RenderTarget, string Name, byte CompressionSettings, byte MipSettings)
Parameters
Type Name Description
TextureRenderTarget2D RenderTarget
System.String Name
System.Byte CompressionSettings
System.Byte MipSettings
Returns
Type Description
Texture2D
Remarks

Render Target Must be power of two and use four channels. Only works in the editor

Operators

| Improve this Doc View Source

Implicit(IntPtr to KismetRenderingLibrary)

Convert from IntPtr to UObject

Declaration
public static implicit operator KismetRenderingLibrary(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
KismetRenderingLibrary