@bloomengine/engine 0.4.0 → 0.4.2

package/native/tvos/metal-patched/src/heap.rs

@@ -0,0 +1,281 @@
+// Copyright 2016 GFX developers
+//
+// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
+// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
+// http://opensource.org/licenses/MIT>, at your option. This file may not be
+// copied, modified, or distributed except according to those terms.
+
+use super::*;
+
+/// Only available on macos(10.15), ios(13.0)
+///
+/// See <https://developer.apple.com/documentation/metal/mtlheaptype/>
+#[repr(u64)]
+#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
+pub enum MTLHeapType {
+    Automatic = 0,
+    Placement = 1,
+    /// Only available on macos(11.0), macCatalyst(14.0)
+    Sparse = 2,
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlheap/>
+pub enum MTLHeap {}
+
+foreign_obj_type! {
+    type CType = MTLHeap;
+    pub struct Heap;
+}
+
+impl HeapRef {
+    pub fn device(&self) -> &DeviceRef {
+        unsafe { msg_send![self, device] }
+    }
+
+    pub fn label(&self) -> &str {
+        unsafe {
+            let label = msg_send![self, label];
+            crate::nsstring_as_str(label)
+        }
+    }
+
+    pub fn set_label(&self, label: &str) {
+        unsafe {
+            let nslabel = crate::nsstring_from_str(label);
+            let () = msg_send![self, setLabel: nslabel];
+        }
+    }
+
+    pub fn cpu_cache_mode(&self) -> MTLCPUCacheMode {
+        unsafe { msg_send![self, cpuCacheMode] }
+    }
+
+    pub fn storage_mode(&self) -> MTLStorageMode {
+        unsafe { msg_send![self, storageMode] }
+    }
+
+    /// Only available on macos(10.15), ios(13.0)
+    pub fn hazard_tracking_mode(&self) -> MTLHazardTrackingMode {
+        unsafe { msg_send![self, hazardTrackingMode] }
+    }
+
+    /// Only available on macos(10.15), ios(13.0)
+    pub fn resource_options(&self) -> MTLResourceOptions {
+        unsafe { msg_send![self, resourceOptions] }
+    }
+
+    pub fn set_purgeable_state(&self, state: MTLPurgeableState) -> MTLPurgeableState {
+        unsafe { msg_send![self, setPurgeableState: state] }
+    }
+
+    pub fn size(&self) -> NSUInteger {
+        unsafe { msg_send![self, size] }
+    }
+
+    pub fn used_size(&self) -> NSUInteger {
+        unsafe { msg_send![self, usedSize] }
+    }
+
+    /// Only available on macos(10.15), ios(13.0)
+    pub fn heap_type(&self) -> MTLHeapType {
+        unsafe { msg_send![self, type] }
+    }
+
+    /// Only available on macos(10.13), ios(11.0)
+    pub fn current_allocated_size(&self) -> NSUInteger {
+        unsafe { msg_send![self, currentAllocatedSize] }
+    }
+
+    pub fn max_available_size_with_alignment(&self, alignment: NSUInteger) -> NSUInteger {
+        unsafe { msg_send![self, maxAvailableSizeWithAlignment: alignment] }
+    }
+
+    pub fn new_buffer(&self, length: u64, options: MTLResourceOptions) -> Option<Buffer> {
+        unsafe {
+            let ptr: *mut MTLBuffer = msg_send![self, newBufferWithLength:length
+                                                                  options:options];
+            if !ptr.is_null() {
+                Some(Buffer::from_ptr(ptr))
+            } else {
+                None
+            }
+        }
+    }
+
+    pub fn new_texture(&self, descriptor: &TextureDescriptorRef) -> Option<Texture> {
+        unsafe {
+            let ptr: *mut MTLTexture = msg_send![self, newTextureWithDescriptor: descriptor];
+            if !ptr.is_null() {
+                Some(Texture::from_ptr(ptr))
+            } else {
+                None
+            }
+        }
+    }
+
+    /// Only available on macOS 10.15+ & iOS 13.0+
+    pub fn new_buffer_with_offset(
+        &self,
+        length: u64,
+        options: MTLResourceOptions,
+        offset: u64,
+    ) -> Option<Buffer> {
+        unsafe {
+            let ptr: *mut MTLBuffer = msg_send![self, newBufferWithLength:length
+                                                                  options:options
+                                                                  offset:offset];
+            if !ptr.is_null() {
+                Some(Buffer::from_ptr(ptr))
+            } else {
+                None
+            }
+        }
+    }
+
+    /// Only available on macOS 10.15+ & iOS 13.0+
+    pub fn new_texture_with_offset(
+        &self,
+        descriptor: &TextureDescriptorRef,
+        offset: u64,
+    ) -> Option<Texture> {
+        unsafe {
+            let ptr: *mut MTLTexture = msg_send![self, newTextureWithDescriptor:descriptor
+                                                                         offset:offset];
+            if !ptr.is_null() {
+                Some(Texture::from_ptr(ptr))
+            } else {
+                None
+            }
+        }
+    }
+
+    /// Only available on macOS 13.0+ & iOS 16.0+
+    pub fn new_acceleration_structure_with_descriptor(
+        &self,
+        descriptor: &AccelerationStructureDescriptorRef,
+    ) -> Option<AccelerationStructure> {
+        unsafe {
+            let ptr: *mut MTLAccelerationStructure =
+                msg_send![self, newAccelerationStructureWithDescriptor: descriptor];
+            if !ptr.is_null() {
+                Some(AccelerationStructure::from_ptr(ptr))
+            } else {
+                None
+            }
+        }
+    }
+
+    /// Only available on macOS 13.0+ & iOS 16.0+
+    pub fn new_acceleration_structure_with_descriptor_offset(
+        &self,
+        descriptor: &AccelerationStructureDescriptorRef,
+        offset: u64,
+    ) -> Option<AccelerationStructure> {
+        unsafe {
+            let ptr: *mut MTLAccelerationStructure = msg_send![self, newAccelerationStructureWithDescriptor:descriptor
+                                                                     offset:offset];
+            if !ptr.is_null() {
+                Some(AccelerationStructure::from_ptr(ptr))
+            } else {
+                None
+            }
+        }
+    }
+
+    /// Only available on macOS 13.0+ & iOS 16.0+
+    pub fn new_acceleration_structure_with_size(&self, size: u64) -> Option<AccelerationStructure> {
+        unsafe {
+            let ptr: *mut MTLAccelerationStructure =
+                msg_send![self, newAccelerationStructureWithSize:size];
+            if !ptr.is_null() {
+                Some(AccelerationStructure::from_ptr(ptr))
+            } else {
+                None
+            }
+        }
+    }
+
+    /// Only available on macOS 13.0+ & iOS 16.0+
+    pub fn new_acceleration_structure_with_size_offset(
+        &self,
+        size: u64,
+        offset: u64,
+    ) -> Option<AccelerationStructure> {
+        unsafe {
+            let ptr: *mut MTLAccelerationStructure = msg_send![self, newAccelerationStructureWithSize:size
+                                                                     offset:offset];
+            if !ptr.is_null() {
+                Some(AccelerationStructure::from_ptr(ptr))
+            } else {
+                None
+            }
+        }
+    }
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlheapdescriptor/>
+pub enum MTLHeapDescriptor {}
+
+foreign_obj_type! {
+    type CType = MTLHeapDescriptor;
+    pub struct HeapDescriptor;
+}
+
+impl HeapDescriptor {
+    pub fn new() -> Self {
+        unsafe {
+            let class = class!(MTLHeapDescriptor);
+            msg_send![class, new]
+        }
+    }
+}
+
+impl HeapDescriptorRef {
+    pub fn cpu_cache_mode(&self) -> MTLCPUCacheMode {
+        unsafe { msg_send![self, cpuCacheMode] }
+    }
+
+    pub fn set_cpu_cache_mode(&self, mode: MTLCPUCacheMode) {
+        unsafe { msg_send![self, setCpuCacheMode: mode] }
+    }
+
+    pub fn storage_mode(&self) -> MTLStorageMode {
+        unsafe { msg_send![self, storageMode] }
+    }
+
+    pub fn set_storage_mode(&self, mode: MTLStorageMode) {
+        unsafe { msg_send![self, setStorageMode: mode] }
+    }
+
+    pub fn size(&self) -> NSUInteger {
+        unsafe { msg_send![self, size] }
+    }
+
+    pub fn set_size(&self, size: NSUInteger) {
+        unsafe { msg_send![self, setSize: size] }
+    }
+
+    /// Only available on macos(10.15), ios(13.0)
+    pub fn hazard_tracking_mode(&self) -> MTLHazardTrackingMode {
+        unsafe { msg_send![self, hazardTrackingMode] }
+    }
+
+    /// Only available on macos(10.15), ios(13.0)
+    pub fn set_hazard_tracking_mode(&self, hazard_tracking_mode: MTLHazardTrackingMode) {
+        unsafe { msg_send![self, setHazardTrackingMode: hazard_tracking_mode] }
+    }
+
+    /// Only available on macos(10.15), ios(13.0)
+    pub fn resource_options(&self) -> MTLResourceOptions {
+        unsafe { msg_send![self, resourceOptions] }
+    }
+
+    /// Only available on macos(10.15), ios(13.0)
+    pub fn heap_type(&self) -> MTLHeapType {
+        unsafe { msg_send![self, type] }
+    }
+    /// Only available on macos(10.15), ios(13.0)
+    pub fn set_heap_type(&self, type_: MTLHeapType) {
+        unsafe { msg_send![self, setType: type_] }
+    }
+}

package/native/tvos/metal-patched/src/indirect_encoder.rs

@@ -0,0 +1,344 @@
+use super::*;
+
+bitflags::bitflags! {
+    /// See <https://developer.apple.com/documentation/metal/mtlindirectcommandtype/>
+    #[allow(non_upper_case_globals)]
+    #[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
+    pub struct MTLIndirectCommandType: NSUInteger {
+        const Draw                      = 1 << 0;
+        const DrawIndexed               = 1 << 1;
+        const DrawPatches               = 1 << 2;
+        const DrawIndexedPatches        = 1 << 3;
+        const ConcurrentDispatch        = 1 << 4;
+        const ConcurrentDispatchThreads = 1 << 5;
+    }
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlindirectcommandbufferdescriptor/>
+pub enum MTLIndirectCommandBufferDescriptor {}
+
+foreign_obj_type! {
+    type CType = MTLIndirectCommandBufferDescriptor;
+    pub struct IndirectCommandBufferDescriptor;
+}
+
+impl IndirectCommandBufferDescriptor {
+    pub fn new() -> Self {
+        let class = class!(MTLIndirectCommandBufferDescriptor);
+        unsafe { msg_send![class, new] }
+    }
+}
+
+impl IndirectCommandBufferDescriptorRef {
+    pub fn command_types(&self) -> MTLIndirectCommandType {
+        unsafe { msg_send![self, commandTypes] }
+    }
+
+    pub fn set_command_types(&self, types: MTLIndirectCommandType) {
+        unsafe { msg_send![self, setCommandTypes: types] }
+    }
+
+    pub fn inherit_buffers(&self) -> bool {
+        unsafe { msg_send_bool![self, inheritBuffers] }
+    }
+
+    pub fn set_inherit_buffers(&self, inherit: bool) {
+        unsafe { msg_send![self, setInheritBuffers: inherit] }
+    }
+
+    pub fn inherit_pipeline_state(&self) -> bool {
+        unsafe { msg_send_bool![self, inheritPipelineState] }
+    }
+
+    pub fn set_inherit_pipeline_state(&self, inherit: bool) {
+        unsafe { msg_send![self, setInheritPipelineState: inherit] }
+    }
+
+    pub fn max_vertex_buffer_bind_count(&self) -> NSUInteger {
+        unsafe { msg_send![self, maxVertexBufferBindCount] }
+    }
+
+    pub fn set_max_vertex_buffer_bind_count(&self, count: NSUInteger) {
+        unsafe { msg_send![self, setMaxVertexBufferBindCount: count] }
+    }
+
+    pub fn max_fragment_buffer_bind_count(&self) -> NSUInteger {
+        unsafe { msg_send![self, maxFragmentBufferBindCount] }
+    }
+
+    pub fn set_max_fragment_buffer_bind_count(&self, count: NSUInteger) {
+        unsafe { msg_send![self, setMaxFragmentBufferBindCount: count] }
+    }
+
+    pub fn max_kernel_buffer_bind_count(&self) -> NSUInteger {
+        unsafe { msg_send![self, maxKernelBufferBindCount] }
+    }
+
+    pub fn set_max_kernel_buffer_bind_count(&self, count: NSUInteger) {
+        unsafe { msg_send![self, setMaxKernelBufferBindCount: count] }
+    }
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlindirectcommandbuffer/>
+pub enum MTLIndirectCommandBuffer {}
+
+foreign_obj_type! {
+    type CType = MTLIndirectCommandBuffer;
+    pub struct IndirectCommandBuffer;
+    type ParentType = Resource;
+}
+
+impl IndirectCommandBufferRef {
+    pub fn size(&self) -> NSUInteger {
+        unsafe { msg_send![self, size] }
+    }
+
+    pub fn indirect_render_command_at_index(&self, index: NSUInteger) -> &IndirectRenderCommandRef {
+        unsafe { msg_send![self, indirectRenderCommandAtIndex: index] }
+    }
+
+    pub fn indirect_compute_command_at_index(
+        &self,
+        index: NSUInteger,
+    ) -> &IndirectComputeCommandRef {
+        unsafe { msg_send![self, indirectComputeCommandAtIndex: index] }
+    }
+
+    pub fn reset_with_range(&self, range: crate::NSRange) {
+        unsafe { msg_send![self, resetWithRange: range] }
+    }
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlindirectrendercommand/>
+pub enum MTLIndirectRenderCommand {}
+
+foreign_obj_type! {
+    type CType = MTLIndirectRenderCommand;
+    pub struct IndirectRenderCommand;
+}
+
+impl IndirectRenderCommandRef {
+    pub fn set_render_pipeline_state(&self, pipeline_state: &RenderPipelineStateRef) {
+        unsafe { msg_send![self, setRenderPipelineState: pipeline_state] }
+    }
+
+    pub fn set_vertex_buffer(
+        &self,
+        index: NSUInteger,
+        buffer: Option<&BufferRef>,
+        offset: NSUInteger,
+    ) {
+        unsafe {
+            msg_send![self,
+                setVertexBuffer: buffer
+                offset: offset
+                atIndex: index
+            ]
+        }
+    }
+
+    pub fn set_fragment_buffer(
+        &self,
+        index: NSUInteger,
+        buffer: Option<&BufferRef>,
+        offset: NSUInteger,
+    ) {
+        unsafe {
+            msg_send![self,
+                setFragmentBuffer:buffer
+                offset:offset
+                atIndex:index
+            ]
+        }
+    }
+
+    pub fn draw_primitives(
+        &self,
+        primitive_type: MTLPrimitiveType,
+        vertex_start: NSUInteger,
+        vertex_count: NSUInteger,
+        instance_count: NSUInteger,
+        base_instance: NSUInteger,
+    ) {
+        unsafe {
+            msg_send![self,
+                drawPrimitives: primitive_type
+                vertexStart: vertex_start
+                vertexCount: vertex_count
+                instanceCount: instance_count
+                baseInstance: base_instance
+            ]
+        }
+    }
+
+    pub fn draw_indexed_primitives(
+        &self,
+        primitive_type: MTLPrimitiveType,
+        index_count: NSUInteger,
+        index_type: MTLIndexType,
+        index_buffer: &BufferRef,
+        index_buffer_offset: NSUInteger,
+        instance_count: NSUInteger,
+        base_vertex: NSUInteger,
+        base_instance: NSUInteger,
+    ) {
+        unsafe {
+            msg_send![self,
+                drawIndexedPrimitives: primitive_type
+                indexCount: index_count
+                indexType: index_type
+                indexBuffer: index_buffer
+                indexBufferOffset: index_buffer_offset
+                instanceCount: instance_count
+                baseVertex: base_vertex
+                baseInstance: base_instance
+            ]
+        }
+    }
+
+    pub fn draw_patches(
+        &self,
+        number_of_patch_control_points: NSUInteger,
+        patch_start: NSUInteger,
+        patch_count: NSUInteger,
+        patch_index_buffer: &BufferRef,
+        patch_index_buffer_offset: NSUInteger,
+        instance_count: NSUInteger,
+        base_instance: NSUInteger,
+        tesselation_factor_buffer: &BufferRef,
+        tesselation_factor_buffer_offset: NSUInteger,
+        tesselation_factor_buffer_instance_stride: NSUInteger,
+    ) {
+        unsafe {
+            msg_send![self,
+                drawPatches: number_of_patch_control_points
+                patchStart: patch_start
+                patchCount: patch_count
+                patchIndexBuffer: patch_index_buffer
+                patchIndexBufferOffset: patch_index_buffer_offset
+                instanceCount: instance_count
+                baseInstance: base_instance
+                tessellationFactorBuffer: tesselation_factor_buffer
+                tessellationFactorBufferOffset: tesselation_factor_buffer_offset
+                tessellationFactorBufferInstanceStride: tesselation_factor_buffer_instance_stride
+            ]
+        }
+    }
+
+    pub fn draw_indexed_patches(
+        &self,
+        number_of_patch_control_points: NSUInteger,
+        patch_start: NSUInteger,
+        patch_count: NSUInteger,
+        patch_index_buffer: &BufferRef,
+        patch_index_buffer_offset: NSUInteger,
+        control_point_index_buffer: &BufferRef,
+        control_point_index_buffer_offset: NSUInteger,
+        instance_count: NSUInteger,
+        base_instance: NSUInteger,
+        tesselation_factor_buffer: &BufferRef,
+        tesselation_factor_buffer_offset: NSUInteger,
+        tesselation_factor_buffer_instance_stride: NSUInteger,
+    ) {
+        unsafe {
+            msg_send![self,
+                drawIndexedPatches: number_of_patch_control_points
+                patchStart: patch_start
+                patchCount: patch_count
+                patchIndexBuffer: patch_index_buffer
+                patchIndexBufferOffset: patch_index_buffer_offset
+                controlPointIndexBuffer: control_point_index_buffer
+                controlPointIndexBufferOffset: control_point_index_buffer_offset
+                instanceCount: instance_count
+                baseInstance: base_instance
+                tessellationFactorBuffer: tesselation_factor_buffer
+                tessellationFactorBufferOffset: tesselation_factor_buffer_offset
+                tessellationFactorBufferInstanceStride: tesselation_factor_buffer_instance_stride
+            ]
+        }
+    }
+
+    pub fn reset(&self) {
+        unsafe { msg_send![self, reset] }
+    }
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlindirectcomputecommand/>
+pub enum MTLIndirectComputeCommand {}
+
+foreign_obj_type! {
+    type CType = MTLIndirectComputeCommand;
+    pub struct IndirectComputeCommand;
+}
+
+impl IndirectComputeCommandRef {
+    pub fn set_compute_pipeline_state(&self, state: &ComputePipelineStateRef) {
+        unsafe { msg_send![self, setComputePipelineState: state] }
+    }
+
+    pub fn set_kernel_buffer(
+        &self,
+        index: NSUInteger,
+        buffer: Option<&BufferRef>,
+        offset: NSUInteger,
+    ) {
+        unsafe {
+            msg_send![self,
+                setKernelBuffer: buffer
+                offset: offset
+                atIndex: index
+            ]
+        }
+    }
+
+    pub fn set_threadgroup_memory_length(&self, index: NSUInteger, length: NSUInteger) {
+        unsafe {
+            msg_send![self,
+                setThreadgroupMemoryLength: length
+                atIndex: index
+            ]
+        }
+    }
+
+    pub fn set_stage_in_region(&self, region: MTLRegion) {
+        unsafe { msg_send![self, setStageInRegion: region] }
+    }
+
+    pub fn set_barrier(&self) {
+        unsafe { msg_send![self, setBarrier] }
+    }
+
+    pub fn clear_barrier(&self) {
+        unsafe { msg_send![self, clearBarrier] }
+    }
+
+    pub fn concurrent_dispatch_threadgroups(
+        &self,
+        thread_groups_per_grid: MTLSize,
+        threads_per_threadgroup: MTLSize,
+    ) {
+        unsafe {
+            msg_send![self,
+                concurrentDispatchThreadgroups: thread_groups_per_grid
+                threadsPerThreadgroup: threads_per_threadgroup
+            ]
+        }
+    }
+
+    pub fn concurrent_dispatch_threads(
+        &self,
+        thread_groups_per_grid: MTLSize,
+        threads_per_threadgroup: MTLSize,
+    ) {
+        unsafe {
+            msg_send![self,
+                concurrentDispatchThreads: thread_groups_per_grid
+                threadsPerThreadgroup: threads_per_threadgroup
+            ]
+        }
+    }
+
+    pub fn reset(&self) {
+        unsafe { msg_send![self, reset] }
+    }
+}