Struct TextureDescriptor 

pub struct TextureDescriptor(/* private fields */);

Configuration for creating textures.

C++ equivalent: MTL::TextureDescriptor

Implementations

impl TextureDescriptor

pub fn new() -> Option<Self>

Create a new texture descriptor.

C++ equivalent: static TextureDescriptor* alloc()->init()

pub fn texture_2d_descriptor( pixel_format: PixelFormat, width: UInteger, height: UInteger, mipmapped: bool, ) -> Option<Self>

Create a descriptor for a 2D texture.

C++ equivalent: static TextureDescriptor* texture2DDescriptor(PixelFormat, NS::UInteger, NS::UInteger, bool)

pub fn texture_cube_descriptor( pixel_format: PixelFormat, size: UInteger, mipmapped: bool, ) -> Option<Self>

Create a descriptor for a cube texture.

C++ equivalent: static TextureDescriptor* textureCubeDescriptor(PixelFormat, NS::UInteger, bool)

pub fn texture_buffer_descriptor( pixel_format: PixelFormat, width: UInteger, resource_options: ResourceOptions, usage: TextureUsage, ) -> Option<Self>

Create a descriptor for a texture buffer.

C++ equivalent: static TextureDescriptor* textureBufferDescriptor(PixelFormat, NS::UInteger, ResourceOptions, TextureUsage)

pub unsafe fn from_raw(ptr: *mut c_void) -> Option<Self>

Create a TextureDescriptor from a raw pointer.

Safety

The pointer must be a valid Metal texture descriptor object.

pub fn as_raw(&self) -> *mut c_void

Get the raw pointer.

pub fn texture_type(&self) -> TextureType

Get the texture type.

pub fn pixel_format(&self) -> PixelFormat

Get the pixel format.

pub fn width(&self) -> UInteger

Get the width.

pub fn height(&self) -> UInteger

Get the height.

pub fn depth(&self) -> UInteger

Get the depth.

pub fn mipmap_level_count(&self) -> UInteger

Get the mipmap level count.

pub fn sample_count(&self) -> UInteger

Get the sample count.

pub fn array_length(&self) -> UInteger

Get the array length.

pub fn storage_mode(&self) -> StorageMode

Get the storage mode.

pub fn cpu_cache_mode(&self) -> CPUCacheMode

Get the CPU cache mode.

pub fn hazard_tracking_mode(&self) -> HazardTrackingMode

Get the hazard tracking mode.

pub fn resource_options(&self) -> ResourceOptions

Get the resource options.

pub fn usage(&self) -> TextureUsage

Get the usage flags.

pub fn allow_gpu_optimized_contents(&self) -> bool

Get whether GPU-optimized contents are allowed.

pub fn compression_type(&self) -> TextureCompressionType

Get the compression type.

pub fn swizzle(&self) -> TextureSwizzleChannels

Get the swizzle channels.

pub fn placement_sparse_page_size(&self) -> SparsePageSize

Get the placement sparse page size.

pub fn set_texture_type(&self, texture_type: TextureType)

Set the texture type.

pub fn set_pixel_format(&self, pixel_format: PixelFormat)

Set the pixel format.

pub fn set_width(&self, width: UInteger)

Set the width.

pub fn set_height(&self, height: UInteger)

Set the height.

pub fn set_depth(&self, depth: UInteger)

Set the depth.

pub fn set_mipmap_level_count(&self, count: UInteger)

Set the mipmap level count.

pub fn set_sample_count(&self, count: UInteger)

Set the sample count.

pub fn set_array_length(&self, length: UInteger)

Set the array length.

pub fn set_storage_mode(&self, mode: StorageMode)

Set the storage mode.

pub fn set_cpu_cache_mode(&self, mode: CPUCacheMode)

Set the CPU cache mode.

pub fn set_hazard_tracking_mode(&self, mode: HazardTrackingMode)

Set the hazard tracking mode.

pub fn set_resource_options(&self, options: ResourceOptions)

Set the resource options.

pub fn set_usage(&self, usage: TextureUsage)

Set the usage flags.

pub fn set_allow_gpu_optimized_contents(&self, allow: bool)

Set whether GPU-optimized contents are allowed.

pub fn set_compression_type(&self, compression_type: TextureCompressionType)

Set the compression type.

pub fn set_swizzle(&self, swizzle: TextureSwizzleChannels)

Set the swizzle channels.

pub fn set_placement_sparse_page_size(&self, size: SparsePageSize)

Set the placement sparse page size.

Trait Implementations

impl Clone for TextureDescriptor

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextureDescriptor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TextureDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl Drop for TextureDescriptor

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for TextureDescriptor

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.

fn as_mut_ptr(&self) -> *mut c_void

Get the raw mutable pointer to the Objective-C object.

fn retain(&self) -> Self

where Self: Clone,

Retain the object, incrementing its reference count.

fn release(&self)

Release the object, decrementing its reference count.

fn autorelease(&self) -> Self

where Self: Clone,

Autorelease the object.

fn retain_count(&self) -> usize

Get the retain count of the object.

impl Send for TextureDescriptor

impl Sync for TextureDescriptor