UTextureRenderTargetVolume

TextureRenderTargetVolume

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/TextureRenderTargetVolume.h

Include

#include "Engine/TextureRenderTargetVolume.h"

Syntax

class UTextureRenderTargetVolume : public UTextureRenderTarget

Remarks

TextureRenderTargetVolume

Volume render target texture resource. This can be used as a target for rendering as well as rendered as a regular Volume texture resource.

Variables

Name Description

Public variable

uint8: 1

 

bForceLinearGamma

True to force linear gamma space for this render target

Public variable

uint8: 1

 

bHDR

Whether to support storing HDR values, which requires more memory.

Public variable

FLinearColor

 

ClearColor

The color the texture is cleared to

Public variable

TEnumAsByte< en...

 

OverrideFormat

The format of the texture data.

Public variable

int32

 

SizeX

The width of the texture.

Public variable

int32

 

SizeY

The height of the texture.

Public variable

int32

 

SizeZ

The depth of the texture.

Constructors

Name Description

Public function

UTextureRenderTargetVolume

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

UVolumeTextu...

 

ConstructTextureVolume

(
    UObject* InOuter,
    const FString& NewTexName,
    EObjectFlags InFlags
)

Utility for creating a new UVolumeTexture from a TextureRenderTargetVolume.

Public function Const

EPixelFormat

 

GetFormat()

Public function Const

int32

 

GetNumMips()

Public function

void

 

Init

(
    uint32 InSizeX,
    uint32 InSizeY,
    uint32 InSizeZ,
    EPixelFormat InFormat
)

Initialize the settings needed to create a render target texture and create its resource

Public function

void

 

InitAutoFormat

(
    uint32 InSizeX,
    uint32 InSizeY,
    uint32 InSizeZ
)

Initializes the render target, the format will be derived from the value of bHDR.

Public function

void

 

UpdateResourceImmediate

(
    bool bClearRenderTarget
)

Overridden from UTexture

Name Description

Public function Virtual

FTextureReso...

 

CreateResource()

Implemented by subclasses to create a new resource for the texture.

Public function Virtual Const

EMaterialVal...

 

GetMaterialType()

Public function Virtual Const

uint32

 

GetSurfaceArraySize()

Public function Virtual Const

float

 

GetSurfaceDepth()

Public function Virtual Const

float

 

GetSurfaceHeight()

Public function Virtual Const

float

 

GetSurfaceWidth()

Overridden from UObject

Name Description

Public function Virtual

FString

 

GetDesc()

Return a one line description of an object for viewing in the thumbnail view of the generic browser

Public function Virtual

void

 

GetResourceSizeEx

(
    FResourceSizeEx& CumulativeResourc...
)

Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.