Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Engine/Texture2D.h |
Include |
#include "Engine/Texture2D.h" |
class UTexture2D : public UTexture
Name | Description | ||
---|---|---|---|
|
TEnumAsByte< en... |
AddressX |
The addressing mode to use for the X axis. |
|
TEnumAsByte< en... |
AddressY |
The addressing mode to use for the Y axis. |
|
uint8: 1 |
bHasBeenPaintedInEditor |
Whether the texture has been painted in the editor. |
|
CookedPlatformData |
Cooked platform data for this texture |
|
|
FirstResourceMemMip |
Keep track of first mip level used for ResourceMem creation |
|
|
LevelIndex |
Level scope index of this texture. |
|
|
TRefCountPtr< F... |
PendingUpdate |
Helper to manage the current pending update following a call to StreamIn() or StreamOut(). |
|
PlatformData |
The derived data for this texture on this platform. |
|
|
ResourceMem |
Memory used for directly loading bulk mip data |
Name | Description | |
---|---|---|
|
UTexture2D ( |
Name | Description | ||
---|---|---|---|
|
Blueprint_GetSizeX() |
Gets the X size of the texture, in pixels |
|
|
Blueprint_GetSizeY() |
Gets the Y size of the texture, in pixels |
|
|
CalcAllowedMips |
Computes the minimum and maximum allowed mips for a texture. |
|
|
CalcTextureMemorySize ( |
Calculates the size of this texture in bytes if it had MipCount miplevels streamed in. |
|
|
CancelPendingTextureStreaming() |
Cancels any pending texture streaming actions if possible. |
|
|
UTexture2D &... |
CreateTransient ( |
Creates and initializes a new Texture2D with the requested settings |
|
GetExtData() |
||
|
float |
GetGlobalMipMapLODBias() |
Returns the global mip map bias applied as an offset for 2d textures. |
|
GetImportedSize() |
Retrieves the size of the source image from which the texture was created. |
|
|
GetMinTextureResidentMipCount() |
Returns the minimum number of mips that must be resident in memory (cannot be streamed). |
|
|
GetMipData |
Get mip data starting with the specified mip index. |
|
|
GetMipTailBaseIndex() |
||
|
GetNumMips() |
||
|
GetNumMipsAllowed ( |
Calculates the maximum number of mips the engine allows to be loaded for this texture. |
|
|
GetPixelFormat ( |
||
|
const TIndir... |
GetPlatformMips() |
|
|
GetResourceMemSettings |
Calculates and returns the corresponding ResourceMem parameters for this texture. |
|
|
GetSizeX() |
Trivial accessors. |
|
|
GetSizeY() |
||
|
GetSourceArtCRC ( |
Get the CRC of the source art pixels. |
|
|
GetStaticMinTextureResidentMipCount() |
Returns the minimum number of mips that must be resident in memory (cannot be streamed). |
|
|
GetStreamingIndex() |
||
|
HasAlphaChannel() |
Returns true if the runtime texture has an alpha channel that is not completely white. |
|
|
HasSameSourceArt ( |
See if the source art of the two textures matches... |
|
|
IsFullyStreamedIn() |
Whether all miplevels of this texture have been fully streamed in, LOD settings permitting. |
|
|
IsVirtualTexturedWithSinglePhysicalSpace() |
Returns true if this virtual texture uses a single physical space all of its texture layers. |
|
|
LinkStreaming() |
Links texture to the texture streaming manager. |
|
|
RefreshSamplerStates() |
Update the offset for mip map lod bias. This is added to any existing mip bias values. |
|
|
SetMinTextureResidentMipCount ( |
Sets the minimum number of mips that must be resident in memory (cannot be streamed). |
|
|
TemporarilyDisableStreaming() |
Temporarily disable streaming so we update subregions of this texture without streaming clobbering it. |
|
|
UnlinkStreaming() |
Unlinks texture from the texture streaming manager. |
|
|
UpdateTextureRegions |
Asynchronously update a set of regions of a texture with new data. |
Name | Description | ||
---|---|---|---|
|
CalcTextureMemorySizeEnum ( |
Calculates the size of this texture if it had MipCount miplevels streamed in. |
|
|
FTextureReso... |
CreateResource() |
Implemented by subclasses to create a new resource for the texture. |
|
float |
GetAverageBrightness |
Gets the average brightness of the texture (in linear space) |
|
GetCookedPlatformData() |
||
|
EMaterialVal... |
GetMaterialType() |
|
|
FTexturePlat... |
GetRunningPlatformData() |
Textures that use the derived data cache must override this function and provide a pointer to the linked list of platform data. |
|
float |
GetSurfaceHeight() |
|
|
float |
GetSurfaceWidth() |
|
|
IsCurrentlyVirtualTextured() |
Returns if the texture is actually being rendered using virtual texturing right now. |
|
|
UpdateResource() |
Creates a new resource for the texture, and updates any cached references to the resource. |
|
|
WaitForStreaming() |
Waits until all streaming requests for this texture has been fully processed. |
Name | Description | ||
---|---|---|---|
|
CalcCumulativeLODSize ( |
||
|
CalcNumOptionalMips() |
||
|
CancelPendingMipChangeRequest() |
Tries to cancel a pending LOD change request. |
|
|
DoesMipDataExist ( |
||
|
float |
GetLastRenderTimeForStreaming() |
Get the per-asset last render time. |
|
GetMipDataFilename |
||
|
GetNumMipsForStreaming() |
Get the total number of LODs including non-streamable and optional LODs |
|
|
GetNumNonStreamingMips() |
Returns the number of LODs in this asset that are not able to be streamed |
|
|
GetNumRequestedMips() |
When the asset is being updated from StreamIn() or StreamOut(), returns the number of LODs requested |
|
|
GetNumResidentMips() |
The number of LODs currently in memory |
|
|
HasPendingUpdate() |
True if the texture is currently being updated through StreamIn() or StreamOut(). |
|
|
InvalidateLastRenderTimeForStreaming() |
Invalidates per-asset last render time. |
|
|
IsPendingUpdateLocked() |
||
|
IsReadyForStreaming() |
Returns whether the texture is ready for streaming aka whether it has had InitRHI called on it. |
|
|
ShouldMipLevelsBeForcedResident() |
Returns whether miplevels should be forced resident. |
|
|
StreamIn |
Loads mips from disk to memory. Only usable if the asset is streamable. |
|
|
StreamOut ( |
Unload some mips from memory. Only usable if the asset is streamable. |
|
|
UpdateStreamingStatus ( |
Updates the streaming status of the asset and performs finalization when appropriate. |
Name | Description | ||
---|---|---|---|
|
BeginDestroy() |
Called before 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 |
|
|
GetDesc() |
Return a one line description of an object for viewing in the thumbnail view of the generic browser |
|
|
GetResourceSizeEx ( |
Returns the size of the object/ resource for display to artists/ LDs in the Editor. |
|
|
IsReadyForAsyncPostLoad() |
Called before calling PostLoad() in FAsyncPackage::PostLoadObjects(). |
|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostEditUndo() |
Called after an editor or undo operation is formed on texture |
|
|
PostLinkerChange() |
Called in response to the linker changing, this can only happen in the editor |
|
|
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 |
---|---|
GMinTextureResidentMipCount |
The minimum number of mips that must be resident in memory (cannot be streamed). |