UVolumeTexture

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/VolumeTexture.h

Include

#include "Engine/VolumeTexture.h"

Syntax

class UVolumeTexture : public UTexture

Variables

Name Description

Public variable

TMap< FString, ...

 

CookedPlatformData

Public variable

FTexturePlatfor...

 

PlatformData

Platform data.

Public variable

UTexture2D *...

 

Source2DTexture

A (optional) reference texture from which the volume texture was built

Public variable

int32

 

Source2DTileSizeX

The reference texture tile size X

Public variable

int32

 

Source2DTileSizeY

The reference texture tile size Y

Public variable

FGuid

 

SourceLightingGuid

The lighting Guid of the source 2D texture, used to trigger rebuild when the source changes.

Constructors

Name Description

Public function

UVolumeTexture

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

uint32

 

CalcTextureMemorySize

(
    int32 MipCount
)

Calculates the size of this texture in bytes if it had MipCount miplevels streamed in.

Public function Const

int32

 

GetNumMips()

Public function Const

EPixelFormat

 

GetPixelFormat()

Public function Const

int32

 

GetSizeX()

Trivial accessors.

Public function Const

int32

 

GetSizeY()

Public function Const

int32

 

GetSizeZ()

Public function

void

 

SetDefaultSource2DTileSize()

Public function Static

bool

 

ShaderPlatformSupportsCompression

(
    FStaticShaderPlatform ShaderPlatfor...
)

Protected function

void

 

UpdateMipGenSettings()

Public function

bool

 

UpdateSourceFromFunction

(
    TFunction< void, int32, int32...,
    int32 SizeX,
    int32 SizeY,
    int32 SizeZ,
    ETextureSourceFormat Format
)

Updates a volume texture from a user function, which allows for arbitrary UVolumeTexture objects to be filled.

Public function

bool

 

UpdateSourceFromSourceTexture()

Overridden from UTexture

Name Description

Public function Virtual Const

uint32

 

CalcTextureMemorySizeEnum

(
    ETextureMipCount Enum
)

Calculates the size of this texture if it had MipCount miplevels streamed in.

Public function Virtual

FTextureReso...

 

CreateResource()

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

Public function Virtual

TMap< FStrin...

 

GetCookedPlatformData()

Public function Virtual Const

EMaterialVal...

 

GetMaterialType()

Public function Virtual Const

uint32

 

GetMaximumDimension()

Return maximum dimension for this texture type.

Public function Virtual

FTexturePlat...

 

GetRunningPlatformData()

Textures that use the derived data cache must override this function and provide a pointer to the linked list of platform data.

Public function Virtual Const

float

 

GetSurfaceHeight()

Public function Virtual Const

float

 

GetSurfaceWidth()

Public function Virtual

void

 

UpdateResource()

Creates a new resource for the texture, and updates any cached references to the resource.

Overridden from UObject

Name Description

Public function Virtual Const

void

 

GetAssetRegistryTags

(
    TArray< FAssetRegistryTag >& OutTa...
)

Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects

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.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss