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::*;
/// struct containing arguments for intersection function buffers.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtlintersectionfunctionbufferarguments?language=objc)
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct MTLIntersectionFunctionBufferArguments {
/// The GPU resource ID of the buffer containing intersection-function handles.
/// Required to be aligned to 8 bytes.
pub intersectionFunctionBuffer: u64,
/// The maximum range in bytes of intersectionFunctionBuffer that can be used
/// for ray tracing.
pub intersectionFunctionBufferSize: u64,
/// The stride between intersection function entries in intersectionFunctionBuffer.
/// The stride needs to be either 0 or aligned to 8 bytes. Note that only the first 12
/// bits of this value are used by Metal.
pub intersectionFunctionStride: u64,
}
unsafe impl Encode for MTLIntersectionFunctionBufferArguments {
const ENCODING: Encoding =
Encoding::Struct("?", &[<u64>::ENCODING, <u64>::ENCODING, <u64>::ENCODING]);
}
unsafe impl RefEncode for MTLIntersectionFunctionBufferArguments {
const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}
/// Signature defining what data is provided to an intersection function. The signature
/// must match across the shading language declaration of the intersection function table,
/// intersection functions in the table, and the intersector using the table.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtlintersectionfunctionsignature?language=objc)
// NS_OPTIONS
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct MTLIntersectionFunctionSignature(pub NSUInteger);
bitflags::bitflags! {
impl MTLIntersectionFunctionSignature: NSUInteger {
/// No signature
#[doc(alias = "MTLIntersectionFunctionSignatureNone")]
const None = 0;
/// The intersection functions can read the built-in instance_id as described in
/// the Metal Shading Language Guide.
#[doc(alias = "MTLIntersectionFunctionSignatureInstancing")]
const Instancing = 1<<0;
/// The triangle intersection functions can read the built-in barycentric_coord
/// and front_facing as described in the Metal Shading Language Guide.
#[doc(alias = "MTLIntersectionFunctionSignatureTriangleData")]
const TriangleData = 1<<1;
/// The intersection functions can query world_space_origin and
/// world_space_direction as described in the Metal Shading Language Guide.
#[doc(alias = "MTLIntersectionFunctionSignatureWorldSpaceData")]
const WorldSpaceData = 1<<2;
/// The intersection functions may be called from intersectors using the
/// instance_motion intersection tag as described in the Metal Shading Language Guide.
#[doc(alias = "MTLIntersectionFunctionSignatureInstanceMotion")]
const InstanceMotion = 1<<3;
/// The intersection functions can query time, motion_start_time,
/// motion_end_time and key_frame_count as described in the Metal Shading Language Guide.
#[doc(alias = "MTLIntersectionFunctionSignaturePrimitiveMotion")]
const PrimitiveMotion = 1<<4;
/// The intersection functions may be called from intersectors using the
/// extended_limits intersection tag as described in the Metal Shading Language Guide.
#[doc(alias = "MTLIntersectionFunctionSignatureExtendedLimits")]
const ExtendedLimits = 1<<5;
/// The intersection functions may be called from intersectors using the
/// max_levels intersection tag as described in the Metal Shading Language Guide.
#[doc(alias = "MTLIntersectionFunctionSignatureMaxLevels")]
const MaxLevels = 1<<6;
/// The curve intersection functions can read the built-in curve_parameter
/// as described in the Metal Shading Language Guide.
#[doc(alias = "MTLIntersectionFunctionSignatureCurveData")]
const CurveData = 1<<7;
/// The intersection function will be used with intersection function buffers
#[doc(alias = "MTLIntersectionFunctionSignatureIntersectionFunctionBuffer")]
const IntersectionFunctionBuffer = 1<<8;
/// The intersection function uses the intersection function buffer user_data pointer
#[doc(alias = "MTLIntersectionFunctionSignatureUserData")]
const UserData = 1<<9;
}
}
unsafe impl Encode for MTLIntersectionFunctionSignature {
const ENCODING: Encoding = NSUInteger::ENCODING;
}
unsafe impl RefEncode for MTLIntersectionFunctionSignature {
const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}
extern_class!(
/// [Apple's documentation](https://developer.apple.com/documentation/metal/mtlintersectionfunctiontabledescriptor?language=objc)
#[unsafe(super(NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct MTLIntersectionFunctionTableDescriptor;
);
extern_conformance!(
unsafe impl NSCopying for MTLIntersectionFunctionTableDescriptor {}
);
unsafe impl CopyingHelper for MTLIntersectionFunctionTableDescriptor {
type Result = Self;
}
extern_conformance!(
unsafe impl NSObjectProtocol for MTLIntersectionFunctionTableDescriptor {}
);
impl MTLIntersectionFunctionTableDescriptor {
extern_methods!(
/// Create an autoreleased intersection function table descriptor
#[unsafe(method(intersectionFunctionTableDescriptor))]
#[unsafe(method_family = none)]
pub fn intersectionFunctionTableDescriptor(
) -> Retained<MTLIntersectionFunctionTableDescriptor>;
/// The number of functions in the table.
#[unsafe(method(functionCount))]
#[unsafe(method_family = none)]
pub fn functionCount(&self) -> NSUInteger;
/// Setter for [`functionCount`][Self::functionCount].
#[unsafe(method(setFunctionCount:))]
#[unsafe(method_family = none)]
pub fn setFunctionCount(&self, function_count: NSUInteger);
);
}
/// Methods declared on superclass `NSObject`.
impl MTLIntersectionFunctionTableDescriptor {
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 MTLIntersectionFunctionTableDescriptor {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}
extern_protocol!(
/// [Apple's documentation](https://developer.apple.com/documentation/metal/mtlintersectionfunctiontable?language=objc)
#[cfg(all(feature = "MTLAllocation", feature = "MTLResource"))]
pub unsafe trait MTLIntersectionFunctionTable: MTLResource {
#[cfg(feature = "MTLBuffer")]
/// # Safety
///
/// - `buffer` may need to be synchronized.
/// - `buffer` may be unretained, you must ensure it is kept alive while in use.
/// - `buffer` contents should be of the correct type.
/// - `offset` might not be bounds-checked.
/// - `index` might not be bounds-checked.
#[unsafe(method(setBuffer:offset:atIndex:))]
#[unsafe(method_family = none)]
unsafe fn setBuffer_offset_atIndex(
&self,
buffer: Option<&ProtocolObject<dyn MTLBuffer>>,
offset: NSUInteger,
index: NSUInteger,
);
#[cfg(feature = "MTLBuffer")]
/// # Safety
///
/// - `buffers` must be a valid pointer.
/// - `offsets` might not be bounds-checked.
/// - `offsets` must be a valid pointer.
/// - `range` might not be bounds-checked.
#[unsafe(method(setBuffers:offsets:withRange:))]
#[unsafe(method_family = none)]
unsafe fn setBuffers_offsets_withRange(
&self,
buffers: NonNull<*const ProtocolObject<dyn MTLBuffer>>,
offsets: NonNull<NSUInteger>,
range: NSRange,
);
#[cfg(feature = "MTLTypes")]
/// Handle of the GPU resource suitable for storing in an Argument Buffer
#[unsafe(method(gpuResourceID))]
#[unsafe(method_family = none)]
fn gpuResourceID(&self) -> MTLResourceID;
#[cfg(feature = "MTLFunctionHandle")]
#[unsafe(method(setFunction:atIndex:))]
#[unsafe(method_family = none)]
fn setFunction_atIndex(
&self,
function: Option<&ProtocolObject<dyn MTLFunctionHandle>>,
index: NSUInteger,
);
#[cfg(feature = "MTLFunctionHandle")]
/// # Safety
///
/// - `functions` must be a valid pointer.
/// - `range` might not be bounds-checked.
#[unsafe(method(setFunctions:withRange:))]
#[unsafe(method_family = none)]
unsafe fn setFunctions_withRange(
&self,
functions: NonNull<*const ProtocolObject<dyn MTLFunctionHandle>>,
range: NSRange,
);
/// # Safety
///
/// `index` might not be bounds-checked.
#[unsafe(method(setOpaqueTriangleIntersectionFunctionWithSignature:atIndex:))]
#[unsafe(method_family = none)]
unsafe fn setOpaqueTriangleIntersectionFunctionWithSignature_atIndex(
&self,
signature: MTLIntersectionFunctionSignature,
index: NSUInteger,
);
/// # Safety
///
/// `range` might not be bounds-checked.
#[unsafe(method(setOpaqueTriangleIntersectionFunctionWithSignature:withRange:))]
#[unsafe(method_family = none)]
unsafe fn setOpaqueTriangleIntersectionFunctionWithSignature_withRange(
&self,
signature: MTLIntersectionFunctionSignature,
range: NSRange,
);
/// # Safety
///
/// `index` might not be bounds-checked.
#[unsafe(method(setOpaqueCurveIntersectionFunctionWithSignature:atIndex:))]
#[unsafe(method_family = none)]
unsafe fn setOpaqueCurveIntersectionFunctionWithSignature_atIndex(
&self,
signature: MTLIntersectionFunctionSignature,
index: NSUInteger,
);
/// # Safety
///
/// `range` might not be bounds-checked.
#[unsafe(method(setOpaqueCurveIntersectionFunctionWithSignature:withRange:))]
#[unsafe(method_family = none)]
unsafe fn setOpaqueCurveIntersectionFunctionWithSignature_withRange(
&self,
signature: MTLIntersectionFunctionSignature,
range: NSRange,
);
#[cfg(feature = "MTLVisibleFunctionTable")]
/// # Safety
///
/// - `function_table` may need to be synchronized.
/// - `function_table` may be unretained, you must ensure it is kept alive while in use.
/// - `bufferIndex` might not be bounds-checked.
#[unsafe(method(setVisibleFunctionTable:atBufferIndex:))]
#[unsafe(method_family = none)]
unsafe fn setVisibleFunctionTable_atBufferIndex(
&self,
function_table: Option<&ProtocolObject<dyn MTLVisibleFunctionTable>>,
buffer_index: NSUInteger,
);
#[cfg(feature = "MTLVisibleFunctionTable")]
/// # Safety
///
/// - `function_tables` must be a valid pointer.
/// - `bufferRange` might not be bounds-checked.
#[unsafe(method(setVisibleFunctionTables:withBufferRange:))]
#[unsafe(method_family = none)]
unsafe fn setVisibleFunctionTables_withBufferRange(
&self,
function_tables: NonNull<*const ProtocolObject<dyn MTLVisibleFunctionTable>>,
buffer_range: NSRange,
);
}
);