RealityFoundation · IOS API REFERENCE

LowLevelTexture.Descriptor

struct · iOS 18.0+ · SDK 27.1

struct Descriptor

An object that you use to configure new `LowLevelTexture` objects.

Members (20)

get · iOS 18.0+

mipmapLevelCount

TypeScript

get mipmapLevelCount(): Promise<number>

Swift declaration

var mipmapLevelCount: Int

The number of mipmap levels for the texture.

set · iOS 18.0+

mipmapLevelCount

TypeScript

setMipmapLevelCount(value: number): Promise<void>

Swift declaration

var mipmapLevelCount: Int

The number of mipmap levels for the texture.

get · iOS 18.0+

arrayLength

TypeScript

get arrayLength(): Promise<number>

Swift declaration

var arrayLength: Int

The number of array elements for this texture.

set · iOS 18.0+

arrayLength

TypeScript

setArrayLength(value: number): Promise<void>

Swift declaration

var arrayLength: Int

The number of array elements for this texture.

get · iOS 18.0+

pixelFormat

TypeScript

get pixelFormat(): Promise<_Metal_MTLPixelFormat>

Swift declaration

var pixelFormat: MTLPixelFormat

The size and bit layout of all pixels in the texture.

set · iOS 18.0+

pixelFormat

TypeScript

setPixelFormat(value: _Metal_MTLPixelFormat): Promise<void>

Swift declaration

var pixelFormat: MTLPixelFormat

The size and bit layout of all pixels in the texture.

init · iOS 18.0+

init

TypeScript

static initTextureTypePixelFormatWidthHeightDepthMipmapLevelCountArrayLengthTextureUsageSwizzle(textureType?: _Metal_MTLTextureType, pixelFormat?: _Metal_MTLPixelFormat, width?: number, height?: number, depth?: number, mipmapLevelCount?: number, arrayLength?: number, textureUsage?: _Metal_MTLTextureUsage, swizzle?: _Metal_MTLTextureSwizzleChannels): Promise<LowLevelTexture_Descriptor>

Swift declaration

init(textureType: MTLTextureType = .type2D, pixelFormat: MTLPixelFormat = .invalid, width: Int = 0, height: Int = 0, depth: Int = 1, mipmapLevelCount: Int = 1, arrayLength: Int = 1, textureUsage: MTLTextureUsage = .unknown, swizzle: MTLTextureSwizzleChannels = .init(red: .red, green: .green, blue: .blue, alpha: .alpha))

Creates a descriptor for a low-level texture. To create a new ``LowLevelTexture``, first create a `LowLevelTexture.Descriptor` object and set its property values. Then, call ``LowLevelTexture/init(descriptor:)``.

get · iOS 18.0+

textureType

TypeScript

get textureType(): Promise<_Metal_MTLTextureType>

Swift declaration

var textureType: MTLTextureType

The dimension and arrangement of texture image data.

set · iOS 18.0+

textureType

TypeScript

setTextureType(value: _Metal_MTLTextureType): Promise<void>

Swift declaration

var textureType: MTLTextureType

The dimension and arrangement of texture image data.

get · iOS 18.0+

textureUsage

TypeScript

get textureUsage(): Promise<_Metal_MTLTextureUsage>

Swift declaration

var textureUsage: MTLTextureUsage

An enumeration for the various options that determine how you can use a texture.

set · iOS 18.0+

textureUsage

TypeScript

setTextureUsage(value: _Metal_MTLTextureUsage): Promise<void>

Swift declaration

var textureUsage: MTLTextureUsage

An enumeration for the various options that determine how you can use a texture.

get · iOS 18.0+

depth

TypeScript

get depth(): Promise<number>

Swift declaration

var depth: Int

The depth of the texture image for the base level mipmap, in pixels.

set · iOS 18.0+

depth

TypeScript

setDepth(value: number): Promise<void>

Swift declaration

var depth: Int

The depth of the texture image for the base level mipmap, in pixels.

get · iOS 18.0+

width

TypeScript

get width(): Promise<number>

Swift declaration

var width: Int

The width of the texture image for the base level mipmap, in pixels.

set · iOS 18.0+

width

TypeScript

setWidth(value: number): Promise<void>

Swift declaration

var width: Int

The width of the texture image for the base level mipmap, in pixels.

get · iOS 18.0+

height

TypeScript

get height(): Promise<number>

Swift declaration

var height: Int

The height of the texture image for the base level mipmap, in pixels.

set · iOS 18.0+

height

TypeScript

setHeight(value: number): Promise<void>

Swift declaration

var height: Int

The height of the texture image for the base level mipmap, in pixels.

get · iOS 18.0+

swizzle

TypeScript

get swizzle(): Promise<_Metal_MTLTextureSwizzleChannels>

Swift declaration

var swizzle: MTLTextureSwizzleChannels

The pattern you want the GPU to apply to pixels when you read or sample pixels from the texture.

set · iOS 18.0+

swizzle

TypeScript

setSwizzle(value: _Metal_MTLTextureSwizzleChannels): Promise<void>

Swift declaration

var swizzle: MTLTextureSwizzleChannels

The pattern you want the GPU to apply to pixels when you read or sample pixels from the texture.

init · iOS 27.0+

init

TypeScript

static init(mtlDescriptor: _Metal_MTLTextureDescriptor): Promise<LowLevelTexture_Descriptor>

Swift declaration

init(_ mtlDescriptor: MTLTextureDescriptor)

Create from a Metal texture descriptor.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →