Navigation
API > API/Runtime > API/Runtime/Engine
| Name | UVolumeTexture |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/VolumeTexture.h |
| Include Path | #include "Engine/VolumeTexture.h" |
Syntax
UCLASS (HideCategories=(Object, Compositing, ImportSettings), MinimalAPI)
class UVolumeTexture : public UTexture
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UStreamableRenderAsset → UTexture → UVolumeTexture
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UVolumeTexture
(
const FObjectInitializer& ObjectInitializer |
Engine/VolumeTexture.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AddressMode | TEnumAsByte< enum TextureAddress > | The addressing mode to use for the X, Y and Z axis. | Engine/VolumeTexture.h |
|
| CookedPlatformData | TMap< FString, FTexturePlatformData * > | Engine/VolumeTexture.h | ||
| PrivatePlatformData | FTexturePlatformData * | The derived data for this texture on this platform. | Engine/VolumeTexture.h | |
| Source2DTexture | TObjectPtr< UTexture2D > | A (optional) reference texture from which the volume texture was built | Engine/VolumeTexture.h |
|
| Source2DTileSizeX | int32 | The reference texture tile size X | Engine/VolumeTexture.h |
|
| Source2DTileSizeY | int32 | The reference texture tile size Y | Engine/VolumeTexture.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint32 CalcTextureMemorySize
(
int32 MipCount |
Calculates the size of this texture in bytes if it had MipCount miplevels streamed in. | Engine/VolumeTexture.h | |
int32 GetNumMips() |
Engine/VolumeTexture.h | ||
EPixelFormat GetPixelFormat() |
Engine/VolumeTexture.h | ||
| Get the derived data for this texture on this platform. | Engine/VolumeTexture.h | ||
const FTexturePlatformData * GetPlatformData () |
Get the const derived data for this texture on this platform. | Engine/VolumeTexture.h | |
int32 GetSizeX() |
Engine/VolumeTexture.h | ||
int32 GetSizeY() |
Engine/VolumeTexture.h | ||
int32 GetSizeZ() |
Engine/VolumeTexture.h | ||
void SetDefaultSource2DTileSize() |
Engine/VolumeTexture.h | ||
void SetPlatformData
(
FTexturePlatformData* PlatformData |
Set the derived data for this texture on this platform. | Engine/VolumeTexture.h | |
bool UpdateSourceFromFunction
(
TFunction< void(int32, int32, int32, void*)> Func, |
Updates a volume texture from a user function, which allows for arbitrary UVolumeTexture objects to be filled. | Engine/VolumeTexture.h | |
bool UpdateSourceFromSourceTexture() |
Engine/VolumeTexture.h |
Overridden from UTexture
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual uint32 CalcTextureMemorySizeEnum
(
ETextureMipCount Enum |
Calculates the size of this texture if it had MipCount miplevels streamed in. | Engine/VolumeTexture.h | |
virtual FTextureResource * CreateResource() |
Implemented by subclasses to create a new resource for the texture. | Engine/VolumeTexture.h | |
virtual TMap< FString, FTexturePlatformData * > * GetCookedPlatformData() |
Engine/VolumeTexture.h | ||
virtual EMaterialValueType GetMaterialType() |
Engine/VolumeTexture.h | ||
virtual uint32 GetMaximumDimension() |
Return maximum dimension for this texture type. | Engine/VolumeTexture.h | |
virtual FTexturePlatformData ** GetRunningPlatformData() |
Textures that use the derived data cache must override this function and provide a pointer to the linked list of platform data. | Engine/VolumeTexture.h | |
virtual uint32 GetSurfaceArraySize() |
Engine/VolumeTexture.h | ||
virtual float GetSurfaceDepth() |
Engine/VolumeTexture.h | ||
virtual float GetSurfaceHeight() |
Engine/VolumeTexture.h | ||
virtual float GetSurfaceWidth() |
Engine/VolumeTexture.h | ||
virtual TextureAddress GetTextureAddressX() |
Engine/VolumeTexture.h | ||
virtual TextureAddress GetTextureAddressY() |
Engine/VolumeTexture.h | ||
virtual TextureAddress GetTextureAddressZ() |
Engine/VolumeTexture.h | ||
virtual ETextureClass GetTextureClass() |
Get Texture Class | Engine/VolumeTexture.h | |
virtual bool IsDefaultTexture() |
Returns true if the current texture is a default placeholder because compilation is still ongoing. | Engine/VolumeTexture.h | |
virtual void UpdateResourceWithParams
(
EUpdateResourceFlags InFlags |
Creates a new resource for the texture, and updates any cached references to the resource. | Engine/VolumeTexture.h |
Overridden from UStreamableRenderAsset
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 CalcCumulativeLODSize
(
int32 NumLODs |
Engine/VolumeTexture.h | ||
virtual bool StreamIn
(
int32 NewMipCount, |
Loads mips from disk to memory. Only usable if the asset is streamable. | Engine/VolumeTexture.h | |
virtual bool StreamOut
(
int32 NewMipCount |
Unload some mips from memory. Only usable if the asset is streamable. | Engine/VolumeTexture.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetAssetRegistryTags
(
TArray< FAssetRegistryTag >& OutTags |
Engine/VolumeTexture.h | ||
virtual void GetAssetRegistryTags
(
FAssetRegistryTagsContext Context |
Engine/VolumeTexture.h | ||
virtual FString GetDesc() |
Engine/VolumeTexture.h | ||
virtual void GetResourceSizeEx
(
FResourceSizeEx& CumulativeResourceSize |
Engine/VolumeTexture.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Engine/VolumeTexture.h | ||
virtual void PostLoad() |
Engine/VolumeTexture.h | ||
virtual void Serialize
(
FArchive& Ar |
Engine/VolumeTexture.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void UpdateMipGenSettings() |
Engine/VolumeTexture.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UVolumeTexture * CreateTransient
(
int32 InSizeX, |
Creates and initializes a new VolumeTexture with the requested settings | Engine/VolumeTexture.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| SourceLightingGuid_DEPRECATED | FGuid | Engine/VolumeTexture.h |