The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE3:Texture2D (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> Surface >> Texture >> Texture2D
Package: 
Engine
Direct subclasses:
ShadowMapTexture2D, TerrainWeightMapTexture, TextureFlipBook
This class in other games:
UT3


Properties[edit]

Property group 'Texture2D'[edit]

AddressX[edit]

Type: Texture.TextureAddress

The addressing mode to use for the X axis.

AddressY[edit]

Type: Texture.TextureAddress

The addressing mode to use for the Y axis.

bGlobalForceMipLevelsToBeResident[edit]

Type: bool

Modifiers: const

Global/ serialized version of ForceMiplevelsToBeResident.

Internal variables[edit]

bForceMiplevelsToBeResident[edit]

Type: bool

Modifiers: transient

Override whether to fully stream even if texture hasn't been rendered.

bHasBeenLoadedFromPersistentArchive[edit]

Type: bool

Modifiers: transient, const

Whether the texture has been loaded from a persistent archive. We keep track of this in order to not stream textures that are being re-imported over as they will have a linker but won't have been serialized from disk and are therefore not streamable.

bHasCancelationPending[edit]

Type: bool

Modifiers: transient, const

Whether the current texture mip change request is pending cancelation.

bIsStreamable[edit]

Type: bool

Modifiers: transient, const

Whether the texture is currently streamable or not.

FirstResourceMemMip[edit]

Type: int

Modifiers: private, const, native, transient

keep track of first mip level used for ResourceMem creation

ForceMipLevelsToBeResidentTimestamp[edit]

Type: float

Modifiers: private, transient

WorldInfo timestamp that tells the streamer to force all miplevels to be resident up until that time.

Format[edit]

Type: Texture.EPixelFormat

Modifiers: const

The format of the texture data.

Mips[edit]

Type: Object.IndirectArray_Mirror{TIndirectArray<FTexture2DMipMap>}

Modifiers: native, const

The texture's mip-map data.

MipTailBaseIdx[edit]

Type: int

Modifiers: const

Keep track of the first mip level stored in the packed miptail. it's set to highest mip level if no there's no packed miptail

OriginalSizeX[edit]

Type: int

Modifiers: const

The original width of the texture source art we imported from.

OriginalSizeY[edit]

Type: int

Modifiers: const

The original height of the texture source art we imported from.

PendingMipChangeRequestStatus[edit]

Type: Object.ThreadSafeCounter{mutable FThreadSafeCounter}

Modifiers: native, transient, const

Thread safe counter indicating status of mip change request. The below defines are mirrored in UnTex.h.

>= 3 == TEXTURE_STATUS_REQUEST_IN_FLIGHT - a request has been kicked off and is in flight == 2 == TEXTURE_READY_FOR_FINALIZATION - initial request has completed and finalization needs to be kicked off == 1 == TEXTURE_FINALIZATION_IN_PROGRESS - finalization has been kicked off and is in progress == 0 == TEXTURE_READY_FOR_REQUESTS - there are no pending requests/ all requests have been fulfilled == -1 == TEXTURE_PENDING_INITIALIZATION - the renderer hasn't created the resource yet

RequestedMips[edit]

Type: int

Modifiers: transient, const

Number of miplevels the texture should have resident.

ResidentMips[edit]

Type: int

Modifiers: transient, const

Number of miplevels currently resident.

ResourceMem[edit]

Type: pointer{FTexture2DResourceMem}

Modifiers: private, const, native, transient

memory used for directly loading bulk mip data

SizeX[edit]

Type: int

Modifiers: const

The width of the texture.

SizeY[edit]

Type: int

Modifiers: const

The height of the texture.

StreamableTexturesLink[edit]

Type: TextureLinkedListMirror{TLinkedList<UTexture2D*>}

Modifiers: private, native, const, duplicatetransient, noimport

This texture's link in the global streamable texture list.

TextureFileCacheGuid[edit]

Type: Object.Guid

Modifiers: native, const

ID generated whenever the texture is changed so that its bulk data can be updated in the TextureFileCache during cook

TextureFileCacheName[edit]

Type: name

Name of texture file cache texture mips are stored in, NAME_None if it is not part of one.

Timer[edit]

Type: float

Modifiers: private, const, native, transient

Used for various timing measurements, e.g. streaming latency.

Structs[edit]

Texture2DMipMap[edit]

Modifiers: native

A mip-map of the texture.

Object.UntypedBulkData_Mirror{FTextureMipBulkData} Data 
int SizeX 
int SizeY 

TextureLinkedListMirror[edit]

Mirror helper structure for linked list of texture objects. The linked list should NOT be traversed by the garbage collector, which is why Element is declared as a pointer.

pointer Element 
pointer Next 
pointer PrevLink 

Functions[edit]

Static native functions[edit]

Create[edit]

static native noexport final function Texture2D Create (int InSizeX, int InSizeY, optional Texture.EPixelFormat InFormat)

creates and initializes a new Texture2D with the requested settings

Native functions[edit]

SetForceMipLevelsToBeResident[edit]

native final function SetForceMipLevelsToBeResident (float Seconds)

Tells the streaming system that it should force all mip-levels to be resident for a number of seconds.