1. Epic GamesDeveloper
  3. UVolumeTexture

UVolumeTexture

Unreal Engine C++ API Reference > Runtime > Engine > Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Engine/VolumeTexture.h
Include #include "Engine/VolumeTexture.h"

Syntax

UCLASS (HideCategories=(Object, Compositing, ImportSettings), MinimalAPI)  
class UVolumeTexture : public UTexture

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite assetregistrysearchable TEnumAsByte< enum TextureAddress > AddressMode The addressing mode to use for the X, Y and Z axis.
Public variable TMap< FString, FTexturePlatformData * > CookedPlatformData  
Public variable FTexturePlatformData * PrivatePlatformData The derived data for this texture on this platform.
Public variable UProperty Category, EditAnywhere, Meta TObjectPtr< UTexture2D > Source2DTexture A (optional) reference texture from which the volume texture was built
Public variable UProperty Category, EditAnywhere, Meta int32 Source2DTileSizeX The reference texture tile size X
Public variable UProperty Category, EditAnywhere, Meta int32 Source2DTileSizeY The reference texture tile size Y

Constructors

  Type Name Description
Public function  

UVolumeTexture ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const uint32 Calculates the size of this texture in bytes if it had MipCount miplevels streamed in.
Public function Static UVolumeTexture *

CreateTransient ( int32 InSizeX,
int32 InSizeY,
int32 InSizeZ,
EPixelFormat InFormat,
const FName InName
)

 Creates and initializes a new VolumeTexture with the requested settings
Public function Const int32  
Public function Const EPixelFormat  
Public function FTexturePlatformData * Get the derived data for this texture on this platform.
Public function Const const FTexturePlatformData * Get the const derived data for this texture on this platform.
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function void  
Public function void Set the derived data for this texture on this platform.
Protected function void  
Public function bool

UpdateSourceFromFunction ( TFunction< void(int32, int32, int32, void*)> Func,
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  

Overridden from UTexture

  Type Name Description
Public function Virtual Const uint32 Calculates the size of this texture if it had MipCount miplevels streamed in.
Public function Virtual FTextureResource * Implemented by subclasses to create a new resource for the texture.
Public function Virtual TMap< FString, FTexturePlatformData * > *  
Public function Virtual Const EMaterialValueType  
Public function Virtual Const uint32 Return maximum dimension for this texture type.
Public function Virtual FTexturePlatformData ** 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 uint32  
Public function Virtual Const float  
Public function Virtual Const float  
Public function Virtual Const float  
Public function Virtual Const TextureAddress  
Public function Virtual Const TextureAddress  
Public function Virtual Const TextureAddress  
Public function Virtual Const ETextureClass Get Texture Class
Public function Virtual Const bool Returns true if the current texture is a default placeholder because compilation is still ongoing.
Public function Virtual void Creates a new resource for the texture, and updates any cached references to the resource.

Overridden from UStreamableRenderAsset

  Type Name Description
Public function Virtual Const int32  
Public function Virtual bool

StreamIn ( int32 NewMipCount,
bool bHighPrio
)

 Loads mips from disk to memory. Only usable if the asset is streamable.
Public function Virtual bool

StreamOut ( int32 NewMipCount
)

 Unload some mips from memory. Only usable if the asset is streamable.

Overridden from UObject

  Type Name Description
Public function Virtual Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Virtual Const void 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& CumulativeResourceSize
)

 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& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable UProperty FGuid SourceLightingGuid_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page