Struct CompileOptions 

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

Options for compiling shader source code.

C++ equivalent: MTL::CompileOptions

Implementations

impl CompileOptions

pub fn new() -> Option<Self>

Create new compile options.

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

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

Create a CompileOptions from a raw pointer.

Safety

The pointer must be a valid Metal compile options object.

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

Get the raw pointer.

pub fn fast_math_enabled(&self) -> bool

Get whether fast math is enabled.

C++ equivalent: bool fastMathEnabled() const

pub fn set_fast_math_enabled(&self, enabled: bool)

Set whether fast math is enabled.

C++ equivalent: void setFastMathEnabled(bool)

pub fn language_version(&self) -> LanguageVersion

Get the language version.

C++ equivalent: LanguageVersion languageVersion() const

pub fn set_language_version(&self, version: LanguageVersion)

Set the language version.

C++ equivalent: void setLanguageVersion(LanguageVersion)

pub fn preserve_invariance(&self) -> bool

Get whether to preserve invariance.

C++ equivalent: bool preserveInvariance() const

pub fn set_preserve_invariance(&self, preserve: bool)

Set whether to preserve invariance.

C++ equivalent: void setPreserveInvariance(bool)

pub fn optimization_level(&self) -> LibraryOptimizationLevel

Get the optimization level.

C++ equivalent: LibraryOptimizationLevel optimizationLevel() const

pub fn set_optimization_level(&self, level: LibraryOptimizationLevel)

Set the optimization level.

C++ equivalent: void setOptimizationLevel(MTL::LibraryOptimizationLevel)

pub fn math_mode(&self) -> MathMode

Get the math mode.

C++ equivalent: MathMode mathMode() const

pub fn set_math_mode(&self, mode: MathMode)

Set the math mode.

C++ equivalent: void setMathMode(MTL::MathMode)

pub fn math_floating_point_functions(&self) -> MathFloatingPointFunctions

Get the math floating point functions precision.

C++ equivalent: MathFloatingPointFunctions mathFloatingPointFunctions() const

pub fn set_math_floating_point_functions( &self, funcs: MathFloatingPointFunctions, )

Set the math floating point functions precision.

C++ equivalent: void setMathFloatingPointFunctions(MTL::MathFloatingPointFunctions)

pub fn compile_symbol_visibility(&self) -> CompileSymbolVisibility

Get the compile symbol visibility.

C++ equivalent: CompileSymbolVisibility compileSymbolVisibility() const

pub fn set_compile_symbol_visibility(&self, visibility: CompileSymbolVisibility)

Set the compile symbol visibility.

C++ equivalent: void setCompileSymbolVisibility(MTL::CompileSymbolVisibility)

pub fn library_type(&self) -> LibraryType

Get the library type.

C++ equivalent: LibraryType libraryType() const

pub fn set_library_type(&self, lib_type: LibraryType)

Set the library type.

C++ equivalent: void setLibraryType(MTL::LibraryType)

pub fn install_name(&self) -> Option<String>

Get the install name (for dynamic libraries).

C++ equivalent: NS::String* installName() const

pub fn set_install_name(&self, name: &str)

Set the install name (for dynamic libraries).

C++ equivalent: void setInstallName(const NS::String*)

pub fn allow_referencing_undefined_symbols(&self) -> bool

Get whether to allow referencing undefined symbols.

C++ equivalent: bool allowReferencingUndefinedSymbols() const

pub fn set_allow_referencing_undefined_symbols(&self, allow: bool)

Set whether to allow referencing undefined symbols.

C++ equivalent: void setAllowReferencingUndefinedSymbols(bool)

pub fn enable_logging(&self) -> bool

Get whether logging is enabled.

C++ equivalent: bool enableLogging() const

pub fn set_enable_logging(&self, enable: bool)

Set whether logging is enabled.

C++ equivalent: void setEnableLogging(bool)

pub fn max_total_threads_per_threadgroup(&self) -> UInteger

Get the maximum total threads per threadgroup.

C++ equivalent: NS::UInteger maxTotalThreadsPerThreadgroup() const

pub fn set_max_total_threads_per_threadgroup(&self, count: UInteger)

Set the maximum total threads per threadgroup.

C++ equivalent: void setMaxTotalThreadsPerThreadgroup(NS::UInteger)

pub fn required_threads_per_threadgroup(&self) -> Size

Get the required threads per threadgroup.

C++ equivalent: Size requiredThreadsPerThreadgroup() const

pub fn set_required_threads_per_threadgroup(&self, size: Size)

Set the required threads per threadgroup.

C++ equivalent: void setRequiredThreadsPerThreadgroup(MTL::Size)

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

Get the preprocessor macros dictionary.

Returns the dictionary of preprocessor macros as a raw pointer. Use mtl_foundation::Dictionary to work with the returned value.

C++ equivalent: NS::Dictionary* preprocessorMacros() const

pub unsafe fn set_preprocessor_macros_raw(&self, dict: *const c_void)

Set the preprocessor macros dictionary.

Takes a raw pointer to an NSDictionary containing the preprocessor macros.

C++ equivalent: void setPreprocessorMacros(const NS::Dictionary*)

Safety

The dictionary pointer must be valid or null.

Trait Implementations

impl Clone for CompileOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CompileOptions

fn default() -> Self

Returns the “default value” for a type.

impl Drop for CompileOptions

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for CompileOptions

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 CompileOptions

impl Sync for CompileOptions