Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Engine/Texture.h |
Include |
#include "Engine/Texture.h" |
class UTexture :
public UStreamableRenderAsset,
public IInterface_AssetUserData
Name | Description | ||
---|---|---|---|
|
float |
AdjustBrightness |
Static texture brightness adjustment (scales HSV value.) (Non-destructive; Requires texture source art to be available.) |
|
float |
AdjustBrightnessCurve |
Static texture curve adjustment (raises HSV value to the specified power.) (Non-destructive; Requires texture source art to be available.) |
|
float |
AdjustHue |
Static texture hue adjustment (0 - 360) (offsets HSV hue by value in degrees.) (Non-destructive; Requires texture source art to be available.) |
|
float |
AdjustMaxAlpha |
Remaps the alpha to the specified min/max range, defines the new value of 1 (Non-destructive; Requires texture source art to be available.) |
|
float |
AdjustMinAlpha |
Remaps the alpha to the specified min/max range, defines the new value of 0 (Non-destructive; Requires texture source art to be available.) |
|
float |
AdjustRGBCurve |
Static texture RGB curve adjustment (raises linear-space RGB color to the specified power.) (Non-destructive; Requires texture source art to be available.) |
|
float |
AdjustSaturation |
Static texture saturation adjustment (scales HSV saturation.) (Non-destructive; Requires texture source art to be available.) |
|
float |
AdjustVibrance |
Static texture "vibrance" adjustment (0 - 1) (HSV saturation algorithm adjustment.) (Non-destructive; Requires texture source art to be available.) |
|
AlphaCoverageThresholds |
Alpha values per channel to compare to when preserving alpha coverage. |
|
|
AssetImportData |
||
|
AssetUserData |
Array of user data stored with the asset |
|
|
bChromaKeyTexture |
Whether to chroma key the image, replacing any pixels that match ChromaKeyColor with transparent black |
|
|
uint32: 1 |
bDitherMipMapAlpha |
When true, the alpha channel of mip-maps and the base image are dithered for smooth LOD transitions. |
|
uint32: 1 |
bFlipGreenChannel |
When true the texture's green channel will be inverted. This is useful for some normal maps. |
|
uint32: 1 |
bForcePVRTC4 |
For DXT1 textures, setting this will cause the texture to be twice the size, but better looking, on iPhone |
|
uint8: 1 |
bNoTiling |
If true, the RHI texture will be created using TexCreate_NoTiling |
|
uint8: 1 |
bNotOfflineProcessed |
If true, the RHI texture will be created without TexCreate_OfflineProcessed. |
|
uint32: 1 |
bPreserveBorder |
When true the texture's border will be preserved during mipmap generation. |
|
uint8: 1 |
bUseLegacyGamma |
A flag for using the simplified legacy gamma space e.g pow(color,1/2.2) for converting from FColor to FLinearColor, if we're doing sRGB. |
|
ChromaKeyColor |
The color that will be replaced with transparent black if chroma keying is enabled |
|
|
float |
ChromaKeyThreshold |
The threshold that components have to match for the texel to be considered equal to the ChromaKeyColor when chroma keying (<=, set to 0 to require a perfect exact match) |
|
float |
CompositePower |
Default 1, high values result in a stronger effect e.g 1, 2, 4, 8 this is no slider because the texture update would not be fast enough |
|
UTexture * |
CompositeTexture |
Can be defined to modify the roughness based on the normal map variation (mostly from mip maps). |
|
TEnumAsByte< en... |
CompositeTextureMode |
Defines how the CompositeTexture is applied, e.g. CTM_RoughnessFromNormalAlpha |
|
uint32: 1 |
CompressionNoAlpha |
If enabled, the texture's alpha channel will be discarded during compression |
|
uint32: 1 |
CompressionNone |
|
|
TEnumAsByte< en... |
CompressionQuality |
The compression quality for generated textures. |
|
TEnumAsByte< en... |
CompressionSettings |
Compression settings to use when building the texture. |
|
uint8: 1 |
CompressionYCoCg |
If true the texture stores YCoCg. |
|
uint32: 1 |
DeferCompression |
If enabled, defer compression of the texture until save. |
|
Downscale |
Downscale source texture, applied only to textures without mips 0.0 - use scale value from texture group 1.0 - do not scale texture |
|
|
DownscaleOptions |
Texture downscaling options |
|
|
TEnumAsByte< en... |
Filter |
The texture filtering mode to use when sampling this texture. |
|
LayerFormatSettings |
Array of settings used to control the format of given layer If this array doesn't include an entry for a given layer, values from UTexture will be used |
|
|
LODBias |
A bias to the index of the top mip level to use. |
|
|
TEnumAsByte< en... |
LODGroup |
Texture group this texture belongs to |
|
TEnumAsByte< ET... |
LossyCompressionAmount |
How aggressively should any relevant lossy compression be applied. |
|
MaxTextureSize |
The maximum resolution for generated textures. |
|
|
TEnumAsByte< en... |
MipGenSettings |
Per asset specific setting to define the mip-map generation properties like sharpening and kernel size. |
|
MipLoadOptions |
The texture mip load options. |
|
|
PaddingColor |
The color used to pad the texture out if it is resized due to PowerOfTwoMode |
|
|
TEnumAsByte< en... |
PowerOfTwoMode |
How to pad the texture to a power of 2 size (if necessary) |
|
ReleaseFence |
Release fence to know when resources have been freed on the rendering thread. |
|
|
Resource |
||
|
Source |
||
|
uint8: 1 |
SRGB |
This should be unchecked if using alpha channels individually as masks. |
|
TextureReference |
Stable RHI texture reference that refers to the current RHI texture. |
|
|
uint8: 1 |
VirtualTextureStreaming |
Is this texture streamed in using VT |
Name | Description | |
---|---|---|
|
UTexture ( |
Name | Description | ||
---|---|---|---|
|
BeginCachePlatformData() |
Begins caching platform data in the background. |
|
|
BeginFinalReleaseResource() |
||
|
CachePlatformData ( |
Caches platform data for the texture. |
|
|
CalcTextureMemorySizeEnum ( |
Calculates the size of this texture if it had MipCount miplevels streamed in. |
|
|
CleanupCachedRunningPlatformData() |
||
|
FTextureReso... |
CreateResource() |
Implemented by subclasses to create a new resource for the texture. |
|
FinishCachePlatformData() |
Blocks on async cache tasks and prepares platform data for use. |
|
|
ForceRebuildPlatformData() |
Forces platform data to be rebuilt. |
|
|
ForceUpdateTextureStreaming() |
Forces textures to recompute LOD settings and stream as needed. |
|
|
float |
GetAverageBrightness |
Gets the average brightness of the texture (in linear space) |
|
GetCookedPlatformData() |
||
|
GetDefaultFormatSettings ( |
||
|
GetExternalTextureGuid() |
Access the GUID which defines this texture's resources externally through FExternalTextureRegistry |
|
|
GetLayerFormatSettings ( |
Gets settings used to choose format for the given layer |
|
|
const FGuid ... |
GetLightingGuid() |
Returns a unique identifier for this texture. Used by the lighting build and texture streamer. |
|
EMaterialVal... |
GetMaterialType() |
|
|
GetMaximumDimension() |
Return maximum dimension for this texture type. |
|
|
TextureMipGe... |
GetMipGenSettingsFromString |
|
|
const TCHAR ... |
GetMipGenSettingsString ( |
|
|
UEnum * |
GetPixelFormatEnum() |
Retrieves the pixel format enum for enum <-> string conversions. |
|
const FTextu... |
GetResource() |
Get the const texture's resource, can be NULL |
|
FTextureReso... |
GetResource() |
Get the texture's resource, can be NULL |
|
FStreamableR... |
GetResourcePostInitState ( |
Calculates the render resource initial state, expected to be used in InitResource() for derived classes implementing streaming. |
|
FTexturePlat... |
GetRunningPlatformData() |
Textures that use the derived data cache must override this function and provide a pointer to the linked list of platform data. |
|
GetStaticMinTextureResidentMipCount() |
Returns the minimum number of mips that must be resident in memory (cannot be streamed). |
|
|
float |
GetSurfaceHeight() |
|
|
float |
GetSurfaceWidth() |
|
|
const TCHAR ... |
GetTextureGroupString ( |
|
|
GetVirtualTextureBuildSettings ( |
Returns the virtual texture build settings. |
|
|
HasHDRSource ( |
Checks whether this texture has a high dynamic range (HDR) source. |
|
|
IsAsyncCacheComplete() |
Returns true if all async caching has completed. |
|
|
IsCurrentlyVirtualTextured() |
Returns if the texture is actually being rendered using virtual texturing right now. |
|
|
IsNormalMap() |
||
|
MarkPlatformDataTransient() |
Marks platform data as transient. |
|
|
NotifyMaterials ( |
Notify any loaded material instances that the texture has changed. |
|
|
ReleaseResource() |
Resets the resource for the texture. |
|
|
SerializeCookedPlatformData ( |
Serializes cooked platform data. |
|
|
SetDeterministicLightingGuid() |
Generates a deterministic GUID for the texture based on the full name of the object. |
|
|
SetLayerFormatSettings ( |
||
|
SetLightingGuid() |
Assigns a new GUID to a texture. |
|
|
SetLightingGuid ( |
||
|
SetMinTextureResidentMipCount ( |
Sets the minimum number of mips that must be resident in memory (cannot be streamed). |
|
|
SetResource ( |
Set texture's resource, can be NULL |
|
|
UpdateCachedLODBias() |
Cache the combined LOD bias based on texture LOD group and LOD bias. |
|
|
UpdateResource() |
Creates a new resource for the texture, and updates any cached references to the resource. |
Name | Description | ||
---|---|---|---|
|
DoesMipDataExist ( |
||
|
float |
GetLastRenderTimeForStreaming() |
Get the per-asset last render time. |
|
GetLODGroupForStreaming() |
Get an integer representation of the LOD group |
|
|
FIoFilenameH... |
GetMipIoFilenameHash ( |
|
|
EStreamableR... |
GetRenderAssetType() |
|
|
HasPendingLODTransition() |
||
|
HasPendingRenderResourceInitialization() |
Also returns false if the render resource is non existent, to prevent stalling on an event that will never complete. |
|
|
InvalidateLastRenderTimeForStreaming() |
Invalidates per-asset last render time. |
|
|
ShouldMipLevelsBeForcedResident() |
Returns whether miplevels should be forced resident. |
Name | Description | ||
---|---|---|---|
|
BeginCacheForCookedPlatformData ( |
Begins caching platform data in the background for the platform requested |
|
|
BeginDestroy() |
Called before destroying the object. |
|
|
CanEditChange ( |
Called by the editor to query whether a property of this object is allowed to be modified. |
|
|
ClearAllCachedCookedPlatformData() |
Clear all cached cooked platform data |
|
|
ClearCachedCookedPlatformData ( |
Clears cached cooked platform data for specific platform |
|
|
FinishDestroy() |
Called to finish destroying the object. |
|
|
GetAssetRegistryTags ( |
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 |
|
|
IsCachedCookedPlatformDataLoaded ( |
Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData |
|
|
IsPostLoadThreadSafe() |
Called during async load to determine if PostLoad can be called on the loading thread. |
|
|
IsReadyForFinishDestroy() |
Called to check if the object is ready for FinishDestroy. |
|
|
PostCDOContruct() |
Called after the C++ constructor has run on the CDO for a class. |
|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
PreSave ( |
Presave function. |
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
Name | Description | ||
---|---|---|---|
|
AddAssetUserData ( |
||
|
const TArray... |
GetAssetUserDataArray() |
|
|
UAssetUserDa... |
GetAssetUserDataOfClass ( |
|
|
RemoveUserDataOfClass ( |
Name |
Description |
|
---|---|---|
|
ENotifyMaterialsEffectOnShaders |
Name |
Description |
---|---|
FOnTextureSaved |
Delegate type for texture save events ( Params: UTexture* TextureToSave ) |
Name |
Description |
---|---|
GMinTextureResidentMipCount |
The minimum number of mips that must be resident in memory (cannot be streamed). |
PreSaveEvent |
Triggered before a texture is being saved |
Name | Description | ||
---|---|---|---|
|
SourceFilePath_DEPRECATED |