firefox-main/third_party/rust/objc2-metal/src/generated/MTLFunctionDescriptor.rs

Source code

Revision control

Copy as Markdown

Other Tools

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
use objc2_foundation::*;
use crate::*;
// NS_OPTIONS
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct MTLFunctionOptions(pub NSUInteger);
bitflags::bitflags! {
impl MTLFunctionOptions: NSUInteger {
/// Default usage
#[doc(alias = "MTLFunctionOptionNone")]
const None = 0;
/// Compiles the found function. This enables dynamic linking of this `MTLFunction`.
/// Only supported for `visible` functions.
#[doc(alias = "MTLFunctionOptionCompileToBinary")]
const CompileToBinary = 1<<0;
/// stores and tracks this function in a Metal Pipelines Script
/// This flag is optional and only supported in the context of binary archives.
///
/// This flag is required for inspecting and consuming binary archives with specialized MTLFunctions via the metal-source tool. It is not required for recompilation, nor for storing functions in binary archives. Set this flag only if you intend to use metal-source on a serialized binary archive.
#[doc(alias = "MTLFunctionOptionStoreFunctionInMetalPipelinesScript")]
const StoreFunctionInMetalPipelinesScript = 1<<1;
/// stores and tracks this function in a Metal Pipelines Script
/// This flag is optional and only supported in the context of binary archives.
///
/// This flag is required for inspecting and consuming binary archives with specialized MTLFunctions via the metal-source tool. It is not required for recompilation, nor for storing functions in binary archives. Set this flag only if you intend to use metal-source on a serialized binary archive.
#[doc(alias = "MTLFunctionOptionStoreFunctionInMetalScript")]
#[deprecated]
const StoreFunctionInMetalScript = 1<<1;
/// Function creation fails (i.e nil is returned) if:
/// - A lookup binary archive has been specified
/// - The function has not been found in the archive
#[doc(alias = "MTLFunctionOptionFailOnBinaryArchiveMiss")]
const FailOnBinaryArchiveMiss = 1<<2;
/// Compiles the function to have its function handles return a constant MTLResourceID across
/// all pipeline states. The function needs to be linked to the pipeline that will use this function.
/// This function option can only be used for functions that are compiled with `MTLFunctionOptionCompileToBinary`.
#[doc(alias = "MTLFunctionOptionPipelineIndependent")]
const PipelineIndependent = 1<<3;
}
}
unsafe impl Encode for MTLFunctionOptions {
const ENCODING: Encoding = NSUInteger::ENCODING;
}
unsafe impl RefEncode for MTLFunctionOptions {
const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}
extern_class!(
#[unsafe(super(NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct MTLFunctionDescriptor;
);
extern_conformance!(
unsafe impl NSCopying for MTLFunctionDescriptor {}
);
unsafe impl CopyingHelper for MTLFunctionDescriptor {
type Result = Self;
}
extern_conformance!(
unsafe impl NSObjectProtocol for MTLFunctionDescriptor {}
);
impl MTLFunctionDescriptor {
extern_methods!(
/// Create an autoreleased function descriptor
#[unsafe(method(functionDescriptor))]
#[unsafe(method_family = none)]
pub fn functionDescriptor() -> Retained<MTLFunctionDescriptor>;
/// The name of the `visible` function to find.
#[unsafe(method(name))]
#[unsafe(method_family = none)]
pub fn name(&self) -> Option<Retained<NSString>>;
/// Setter for [`name`][Self::name].
///
/// This is [copied][objc2_foundation::NSCopying::copy] when set.
#[unsafe(method(setName:))]
#[unsafe(method_family = none)]
pub fn setName(&self, name: Option<&NSString>);
/// An optional new name for a `visible` function to allow reuse with different specializations.
#[unsafe(method(specializedName))]
#[unsafe(method_family = none)]
pub fn specializedName(&self) -> Option<Retained<NSString>>;
/// Setter for [`specializedName`][Self::specializedName].
///
/// This is [copied][objc2_foundation::NSCopying::copy] when set.
#[unsafe(method(setSpecializedName:))]
#[unsafe(method_family = none)]
pub fn setSpecializedName(&self, specialized_name: Option<&NSString>);
#[cfg(feature = "MTLFunctionConstantValues")]
/// The set of constant values assigned to the function constants. Compilation fails if you do not provide valid constant values for all required function constants.
#[unsafe(method(constantValues))]
#[unsafe(method_family = none)]
pub fn constantValues(&self) -> Option<Retained<MTLFunctionConstantValues>>;
#[cfg(feature = "MTLFunctionConstantValues")]
/// Setter for [`constantValues`][Self::constantValues].
///
/// This is [copied][objc2_foundation::NSCopying::copy] when set.
#[unsafe(method(setConstantValues:))]
#[unsafe(method_family = none)]
pub fn setConstantValues(&self, constant_values: Option<&MTLFunctionConstantValues>);
/// The options to use for this new `MTLFunction`.
#[unsafe(method(options))]
#[unsafe(method_family = none)]
pub fn options(&self) -> MTLFunctionOptions;
/// Setter for [`options`][Self::options].
#[unsafe(method(setOptions:))]
#[unsafe(method_family = none)]
pub fn setOptions(&self, options: MTLFunctionOptions);
#[cfg(feature = "MTLBinaryArchive")]
/// The array of archives to be searched.
///
/// Binary archives to be searched for precompiled functions during the compilation of this function.
#[unsafe(method(binaryArchives))]
#[unsafe(method_family = none)]
pub fn binaryArchives(
&self,
) -> Option<Retained<NSArray<ProtocolObject<dyn MTLBinaryArchive>>>>;
#[cfg(feature = "MTLBinaryArchive")]
/// Setter for [`binaryArchives`][Self::binaryArchives].
///
/// This is [copied][objc2_foundation::NSCopying::copy] when set.
#[unsafe(method(setBinaryArchives:))]
#[unsafe(method_family = none)]
pub fn setBinaryArchives(
&self,
binary_archives: Option<&NSArray<ProtocolObject<dyn MTLBinaryArchive>>>,
);
);
}
/// Methods declared on superclass `NSObject`.
impl MTLFunctionDescriptor {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub fn init(this: Allocated<Self>) -> Retained<Self>;
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub fn new() -> Retained<Self>;
);
}
impl DefaultRetained for MTLFunctionDescriptor {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}
extern_class!(
#[unsafe(super(MTLFunctionDescriptor, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct MTLIntersectionFunctionDescriptor;
);
extern_conformance!(
unsafe impl NSCopying for MTLIntersectionFunctionDescriptor {}
);
unsafe impl CopyingHelper for MTLIntersectionFunctionDescriptor {
type Result = Self;
}
extern_conformance!(
unsafe impl NSObjectProtocol for MTLIntersectionFunctionDescriptor {}
);
impl MTLIntersectionFunctionDescriptor {
extern_methods!();
}
/// Methods declared on superclass `NSObject`.
impl MTLIntersectionFunctionDescriptor {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub fn init(this: Allocated<Self>) -> Retained<Self>;
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub fn new() -> Retained<Self>;
);
}
impl DefaultRetained for MTLIntersectionFunctionDescriptor {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}