One Logo Pool Ball
RealityFoundation · IOS API REFERENCE

TextureResource.DrawableQueue.Descriptor

struct · iOS 15.0+ · SDK 27.1

struct Descriptor

Describes the texture managed by the drawable queue

Members (14)

get · iOS 15.0+

mipmapsMode

TypeScript
get mipmapsMode(): Promise<TextureResource_MipmapsMode>
Swift declaration
var mipmapsMode: TextureResource.MipmapsMode

A Boolean value that determines whether the resource should generate mipmaps for each drawable's texture after it was updated.

set · iOS 15.0+

mipmapsMode

TypeScript
setMipmapsMode(value: TextureResource_MipmapsMode): Promise<void>
Swift declaration
var mipmapsMode: TextureResource.MipmapsMode

A Boolean value that determines whether the resource should generate mipmaps for each drawable's texture after it was updated.

init · iOS 18.0+

init

TypeScript
static initPixelFormatWidthHeightUsageMipmapsModeTimeout(pixelFormat: _Metal_MTLPixelFormat, width: number, height: number, usage: _Metal_MTLTextureUsage, mipmapsMode: TextureResource_MipmapsMode, timeout: SDKHandle): Promise<TextureResource_DrawableQueue_Descriptor>
Swift declaration
init(pixelFormat: MTLPixelFormat, width: Int, height: Int, usage: MTLTextureUsage, mipmapsMode: TextureResource.MipmapsMode, timeout: Duration)
init · iOS 15.0+

init

TypeScript
static initPixelFormatWidthHeightUsageMipmapsMode(pixelFormat: _Metal_MTLPixelFormat, width: number, height: number, usage: _Metal_MTLTextureUsage, mipmapsMode: TextureResource_MipmapsMode): Promise<TextureResource_DrawableQueue_Descriptor>
Swift declaration
init(pixelFormat: MTLPixelFormat, width: Int, height: Int, usage: MTLTextureUsage, mipmapsMode: TextureResource.MipmapsMode)
get · iOS 15.0+

pixelFormat

TypeScript
get pixelFormat(): Promise<_Metal_MTLPixelFormat>
Swift declaration
var pixelFormat: MTLPixelFormat

The size and bit layout of all pixels in each drawable's texture.

set · iOS 15.0+

pixelFormat

TypeScript
setPixelFormat(value: _Metal_MTLPixelFormat): Promise<void>
Swift declaration
var pixelFormat: MTLPixelFormat

The size and bit layout of all pixels in each drawable's texture.

get · iOS 15.0+

usage

TypeScript
get usage(): Promise<_Metal_MTLTextureUsage>
Swift declaration
var usage: MTLTextureUsage

Options that determine how you can use each drawable's textures.

set · iOS 15.0+

usage

TypeScript
setUsage(value: _Metal_MTLTextureUsage): Promise<void>
Swift declaration
var usage: MTLTextureUsage

Options that determine how you can use each drawable's textures.

get · iOS 15.0+

width

TypeScript
get width(): Promise<number>
Swift declaration
var width: Int

The width of each drawable's texture in pixels.

set · iOS 15.0+

width

TypeScript
setWidth(value: number): Promise<void>
Swift declaration
var width: Int

The width of each drawable's texture in pixels.

get · iOS 15.0+

height

TypeScript
get height(): Promise<number>
Swift declaration
var height: Int

The height of each drawable's texture in pixels.

set · iOS 15.0+

height

TypeScript
setHeight(value: number): Promise<void>
Swift declaration
var height: Int

The height of each drawable's texture in pixels.

get · iOS 18.0+

timeout

TypeScript
get timeout(): Promise<SDKHandle>
Swift declaration
var timeout: Duration { get set }

Specifies a timeout value in seconds when querying nextDrawable(). nextDrawable() will be blocked for up to the specified timeout period for a drawable to become available else throws `NextDrawableError.timeoutReached`. By default this is set to 1 second. Note that if `allowsNextDrawableTimeout` is false, then the timeout parameter will be ignored.

set · iOS 18.0+

timeout

TypeScript
setTimeout(value: SDKHandle): Promise<void>
Swift declaration
var timeout: Duration { get set }

Specifies a timeout value in seconds when querying nextDrawable(). nextDrawable() will be blocked for up to the specified timeout period for a drawable to become available else throws `NextDrawableError.timeoutReached`. By default this is set to 1 second. Note that if `allowsNextDrawableTimeout` is false, then the timeout parameter will be ignored.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →