@bloomengine/engine 0.4.0 → 0.4.2

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

@@ -0,0 +1,443 @@
+// 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::*;
+
+/// See <https://developer.apple.com/documentation/metal/mtlloadaction>
+#[repr(u64)]
+#[derive(Copy, Clone, Debug)]
+pub enum MTLLoadAction {
+    DontCare = 0,
+    Load = 1,
+    Clear = 2,
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlstoreaction>
+#[repr(u64)]
+#[derive(Copy, Clone, Debug)]
+pub enum MTLStoreAction {
+    DontCare = 0,
+    Store = 1,
+    MultisampleResolve = 2,
+    StoreAndMultisampleResolve = 3,
+    Unknown = 4,
+    CustomSampleDepthStore = 5,
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlclearcolor>
+#[repr(C)]
+#[derive(Copy, Clone, Debug)]
+pub struct MTLClearColor {
+    pub red: f64,
+    pub green: f64,
+    pub blue: f64,
+    pub alpha: f64,
+}
+
+impl MTLClearColor {
+    #[inline]
+    pub fn new(red: f64, green: f64, blue: f64, alpha: f64) -> Self {
+        Self {
+            red,
+            green,
+            blue,
+            alpha,
+        }
+    }
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlmultisamplestencilresolvefilter>
+#[repr(u32)]
+#[allow(non_camel_case_types)]
+pub enum MTLMultisampleStencilResolveFilter {
+    Sample0 = 0,
+    DepthResolvedSample = 1,
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlrenderpassattachmentdescriptor>
+pub enum MTLRenderPassAttachmentDescriptor {}
+
+foreign_obj_type! {
+    type CType = MTLRenderPassAttachmentDescriptor;
+    pub struct RenderPassAttachmentDescriptor;
+}
+
+impl RenderPassAttachmentDescriptorRef {
+    pub fn texture(&self) -> Option<&TextureRef> {
+        unsafe { msg_send![self, texture] }
+    }
+
+    pub fn set_texture(&self, texture: Option<&TextureRef>) {
+        unsafe { msg_send![self, setTexture: texture] }
+    }
+
+    pub fn level(&self) -> NSUInteger {
+        unsafe { msg_send![self, level] }
+    }
+
+    pub fn set_level(&self, level: NSUInteger) {
+        unsafe { msg_send![self, setLevel: level] }
+    }
+
+    pub fn slice(&self) -> NSUInteger {
+        unsafe { msg_send![self, slice] }
+    }
+
+    pub fn set_slice(&self, slice: NSUInteger) {
+        unsafe { msg_send![self, setSlice: slice] }
+    }
+
+    pub fn depth_plane(&self) -> NSUInteger {
+        unsafe { msg_send![self, depthPlane] }
+    }
+
+    pub fn set_depth_plane(&self, depth_plane: NSUInteger) {
+        unsafe { msg_send![self, setDepthPlane: depth_plane] }
+    }
+
+    pub fn resolve_texture(&self) -> Option<&TextureRef> {
+        unsafe { msg_send![self, resolveTexture] }
+    }
+
+    pub fn set_resolve_texture(&self, resolve_texture: Option<&TextureRef>) {
+        unsafe { msg_send![self, setResolveTexture: resolve_texture] }
+    }
+
+    pub fn resolve_level(&self) -> NSUInteger {
+        unsafe { msg_send![self, resolveLevel] }
+    }
+
+    pub fn set_resolve_level(&self, resolve_level: NSUInteger) {
+        unsafe { msg_send![self, setResolveLevel: resolve_level] }
+    }
+
+    pub fn resolve_slice(&self) -> NSUInteger {
+        unsafe { msg_send![self, resolveSlice] }
+    }
+
+    pub fn set_resolve_slice(&self, resolve_slice: NSUInteger) {
+        unsafe { msg_send![self, setResolveSlice: resolve_slice] }
+    }
+
+    pub fn resolve_depth_plane(&self) -> NSUInteger {
+        unsafe { msg_send![self, resolveDepthPlane] }
+    }
+
+    pub fn set_resolve_depth_plane(&self, resolve_depth_plane: NSUInteger) {
+        unsafe { msg_send![self, setResolveDepthPlane: resolve_depth_plane] }
+    }
+
+    pub fn load_action(&self) -> MTLLoadAction {
+        unsafe { msg_send![self, loadAction] }
+    }
+
+    pub fn set_load_action(&self, load_action: MTLLoadAction) {
+        unsafe { msg_send![self, setLoadAction: load_action] }
+    }
+
+    pub fn store_action(&self) -> MTLStoreAction {
+        unsafe { msg_send![self, storeAction] }
+    }
+
+    pub fn set_store_action(&self, store_action: MTLStoreAction) {
+        unsafe { msg_send![self, setStoreAction: store_action] }
+    }
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlrenderpasscolorattachmentdescriptor>
+pub enum MTLRenderPassColorAttachmentDescriptor {}
+
+foreign_obj_type! {
+    type CType = MTLRenderPassColorAttachmentDescriptor;
+    pub struct RenderPassColorAttachmentDescriptor;
+    type ParentType = RenderPassAttachmentDescriptor;
+}
+
+impl RenderPassColorAttachmentDescriptor {
+    pub fn new() -> Self {
+        unsafe {
+            let class = class!(MTLRenderPassColorAttachmentDescriptor);
+            msg_send![class, new]
+        }
+    }
+}
+
+impl RenderPassColorAttachmentDescriptorRef {
+    pub fn clear_color(&self) -> MTLClearColor {
+        unsafe { msg_send![self, clearColor] }
+    }
+
+    pub fn set_clear_color(&self, clear_color: MTLClearColor) {
+        unsafe { msg_send![self, setClearColor: clear_color] }
+    }
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlrenderpassdepthattachmentdescriptor>
+pub enum MTLRenderPassDepthAttachmentDescriptor {}
+
+foreign_obj_type! {
+    type CType = MTLRenderPassDepthAttachmentDescriptor;
+    pub struct RenderPassDepthAttachmentDescriptor;
+    type ParentType = RenderPassAttachmentDescriptor;
+}
+
+impl RenderPassDepthAttachmentDescriptorRef {
+    pub fn clear_depth(&self) -> f64 {
+        unsafe { msg_send![self, clearDepth] }
+    }
+
+    pub fn set_clear_depth(&self, clear_depth: f64) {
+        unsafe { msg_send![self, setClearDepth: clear_depth] }
+    }
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlrenderpassstencilattachmentdescriptor>
+pub enum MTLRenderPassStencilAttachmentDescriptor {}
+
+foreign_obj_type! {
+    type CType = MTLRenderPassStencilAttachmentDescriptor;
+    pub struct RenderPassStencilAttachmentDescriptor;
+    type ParentType = RenderPassAttachmentDescriptor;
+}
+
+impl RenderPassStencilAttachmentDescriptorRef {
+    pub fn clear_stencil(&self) -> u32 {
+        unsafe { msg_send![self, clearStencil] }
+    }
+
+    pub fn set_clear_stencil(&self, clear_stencil: u32) {
+        unsafe { msg_send![self, setClearStencil: clear_stencil] }
+    }
+
+    pub fn stencil_resolve_filter(&self) -> MTLMultisampleStencilResolveFilter {
+        unsafe { msg_send![self, stencilResolveFilter] }
+    }
+
+    pub fn set_stencil_resolve_filter(
+        &self,
+        stencil_resolve_filter: MTLMultisampleStencilResolveFilter,
+    ) {
+        unsafe { msg_send![self, setStencilResolveFilter: stencil_resolve_filter] }
+    }
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlrenderpasscolorattachmentdescriptorarray>
+pub enum MTLRenderPassColorAttachmentDescriptorArray {}
+
+foreign_obj_type! {
+    type CType = MTLRenderPassColorAttachmentDescriptorArray;
+    pub struct RenderPassColorAttachmentDescriptorArray;
+}
+
+impl RenderPassColorAttachmentDescriptorArrayRef {
+    pub fn object_at(&self, index: NSUInteger) -> Option<&RenderPassColorAttachmentDescriptorRef> {
+        unsafe { msg_send![self, objectAtIndexedSubscript: index] }
+    }
+
+    pub fn set_object_at(
+        &self,
+        index: NSUInteger,
+        attachment: Option<&RenderPassColorAttachmentDescriptorRef>,
+    ) {
+        unsafe {
+            msg_send![self, setObject:attachment
+                     atIndexedSubscript:index]
+        }
+    }
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlrenderpasssamplebufferattachmentdescriptor>
+pub enum MTLRenderPassSampleBufferAttachmentDescriptor {}
+
+foreign_obj_type! {
+    type CType = MTLRenderPassSampleBufferAttachmentDescriptor;
+    pub struct RenderPassSampleBufferAttachmentDescriptor;
+}
+
+impl RenderPassSampleBufferAttachmentDescriptor {
+    pub fn new() -> Self {
+        let class = class!(MTLRenderPassSampleBufferAttachmentDescriptor);
+        unsafe { msg_send![class, new] }
+    }
+}
+
+impl RenderPassSampleBufferAttachmentDescriptorRef {
+    pub fn sample_buffer(&self) -> Option<&CounterSampleBufferRef> {
+        unsafe { msg_send![self, sampleBuffer] }
+    }
+
+    pub fn set_sample_buffer(&self, sample_buffer: &CounterSampleBufferRef) {
+        unsafe { msg_send![self, setSampleBuffer: sample_buffer] }
+    }
+
+    pub fn start_of_vertex_sample_index(&self) -> NSUInteger {
+        unsafe { msg_send![self, startOfVertexSampleIndex] }
+    }
+
+    pub fn set_start_of_vertex_sample_index(&self, start_of_vertex_sample_index: NSUInteger) {
+        unsafe {
+            msg_send![
+                self,
+                setStartOfVertexSampleIndex: start_of_vertex_sample_index
+            ]
+        }
+    }
+
+    pub fn end_of_vertex_sample_index(&self) -> NSUInteger {
+        unsafe { msg_send![self, endOfVertexSampleIndex] }
+    }
+
+    pub fn set_end_of_vertex_sample_index(&self, end_of_vertex_sample_index: NSUInteger) {
+        unsafe { msg_send![self, setEndOfVertexSampleIndex: end_of_vertex_sample_index] }
+    }
+
+    pub fn start_of_fragment_sample_index(&self) -> NSUInteger {
+        unsafe { msg_send![self, startOfFragmentSampleIndex] }
+    }
+
+    pub fn set_start_of_fragment_sample_index(&self, start_of_fragment_sample_index: NSUInteger) {
+        unsafe {
+            msg_send![
+                self,
+                setStartOfFragmentSampleIndex: start_of_fragment_sample_index
+            ]
+        }
+    }
+
+    pub fn end_of_fragment_sample_index(&self) -> NSUInteger {
+        unsafe { msg_send![self, endOfFragmentSampleIndex] }
+    }
+
+    pub fn set_end_of_fragment_sample_index(&self, end_of_fragment_sample_index: NSUInteger) {
+        unsafe {
+            msg_send![
+                self,
+                setEndOfFragmentSampleIndex: end_of_fragment_sample_index
+            ]
+        }
+    }
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlrenderpasssamplebufferattachmentdescriptorarray>
+pub enum MTLRenderPassSampleBufferAttachmentDescriptorArray {}
+
+foreign_obj_type! {
+    type CType = MTLRenderPassSampleBufferAttachmentDescriptorArray;
+    pub struct RenderPassSampleBufferAttachmentDescriptorArray;
+}
+
+impl RenderPassSampleBufferAttachmentDescriptorArrayRef {
+    pub fn object_at(
+        &self,
+        index: NSUInteger,
+    ) -> Option<&RenderPassSampleBufferAttachmentDescriptorRef> {
+        unsafe { msg_send![self, objectAtIndexedSubscript: index] }
+    }
+
+    pub fn set_object_at(
+        &self,
+        index: NSUInteger,
+        attachment: Option<&RenderPassSampleBufferAttachmentDescriptorRef>,
+    ) {
+        unsafe {
+            msg_send![self, setObject:attachment
+                     atIndexedSubscript:index]
+        }
+    }
+}
+
+/// ## Important!
+/// When configuring a [`MTLTextureDescriptor`] object for use with an attachment, set its usage
+/// value to renderTarget if you already know that you intend to use the resulting MTLTexture object in
+/// an attachment. This may significantly improve your app’s performance with certain hardware.
+///
+/// See <https://developer.apple.com/documentation/metal/mtlrenderpassdescriptor>
+pub enum MTLRenderPassDescriptor {}
+
+foreign_obj_type! {
+    type CType = MTLRenderPassDescriptor;
+    pub struct RenderPassDescriptor;
+}
+
+impl RenderPassDescriptor {
+    /// Creates a default render pass descriptor with no attachments.
+    pub fn new<'a>() -> &'a RenderPassDescriptorRef {
+        unsafe { msg_send![class!(MTLRenderPassDescriptor), renderPassDescriptor] }
+    }
+}
+
+impl RenderPassDescriptorRef {
+    pub fn color_attachments(&self) -> &RenderPassColorAttachmentDescriptorArrayRef {
+        unsafe { msg_send![self, colorAttachments] }
+    }
+
+    pub fn depth_attachment(&self) -> Option<&RenderPassDepthAttachmentDescriptorRef> {
+        unsafe { msg_send![self, depthAttachment] }
+    }
+
+    pub fn set_depth_attachment(
+        &self,
+        depth_attachment: Option<&RenderPassDepthAttachmentDescriptorRef>,
+    ) {
+        unsafe { msg_send![self, setDepthAttachment: depth_attachment] }
+    }
+
+    pub fn stencil_attachment(&self) -> Option<&RenderPassStencilAttachmentDescriptorRef> {
+        unsafe { msg_send![self, stencilAttachment] }
+    }
+
+    pub fn set_stencil_attachment(
+        &self,
+        stencil_attachment: Option<&RenderPassStencilAttachmentDescriptorRef>,
+    ) {
+        unsafe { msg_send![self, setStencilAttachment: stencil_attachment] }
+    }
+
+    pub fn visibility_result_buffer(&self) -> Option<&BufferRef> {
+        unsafe { msg_send![self, visibilityResultBuffer] }
+    }
+
+    pub fn set_visibility_result_buffer(&self, buffer: Option<&BufferRef>) {
+        unsafe { msg_send![self, setVisibilityResultBuffer: buffer] }
+    }
+
+    pub fn render_target_array_length(&self) -> NSUInteger {
+        unsafe { msg_send![self, renderTargetArrayLength] }
+    }
+
+    pub fn set_render_target_array_length(&self, length: NSUInteger) {
+        unsafe { msg_send![self, setRenderTargetArrayLength: length] }
+    }
+
+    pub fn render_target_width(&self) -> NSUInteger {
+        unsafe { msg_send![self, renderTargetWidth] }
+    }
+
+    pub fn set_render_target_width(&self, size: NSUInteger) {
+        unsafe { msg_send![self, setRenderTargetWidth: size] }
+    }
+
+    pub fn render_target_height(&self) -> NSUInteger {
+        unsafe { msg_send![self, renderTargetHeight] }
+    }
+
+    pub fn set_render_target_height(&self, size: NSUInteger) {
+        unsafe { msg_send![self, setRenderTargetHeight: size] }
+    }
+
+    pub fn default_raster_sample_count(&self) -> NSUInteger {
+        unsafe { msg_send![self, defaultRasterSampleCount] }
+    }
+
+    pub fn set_default_raster_sample_count(&self, count: NSUInteger) {
+        unsafe { msg_send![self, setDefaultRasterSampleCount: count] }
+    }
+
+    pub fn sample_buffer_attachments(&self) -> &RenderPassSampleBufferAttachmentDescriptorArrayRef {
+        unsafe { msg_send![self, sampleBufferAttachments] }
+    }
+}

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

@@ -0,0 +1,182 @@
+// 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::*;
+use objc::runtime::{NO, YES};
+
+/// See <https://developer.apple.com/documentation/metal/mtlpurgeablestate>
+#[repr(u64)]
+#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
+pub enum MTLPurgeableState {
+    KeepCurrent = 1,
+    NonVolatile = 2,
+    Volatile = 3,
+    Empty = 4,
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlcpucachemode>
+#[repr(u64)]
+#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
+pub enum MTLCPUCacheMode {
+    DefaultCache = 0,
+    WriteCombined = 1,
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlstoragemode>
+#[repr(u64)]
+#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
+pub enum MTLStorageMode {
+    Shared = 0,
+    Managed = 1,
+    Private = 2,
+    /// Only available on macos(11.0), macCatalyst(14.0), ios(10.0)
+    Memoryless = 3,
+}
+
+/// Only available on macos(10.15), ios(13.0)
+///
+/// See <https://developer.apple.com/documentation/metal/mtlhazardtrackingmode>
+#[repr(u64)]
+#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
+pub enum MTLHazardTrackingMode {
+    Default = 0,
+    Untracked = 1,
+    Tracked = 2,
+}
+
+pub const MTLResourceCPUCacheModeShift: NSUInteger = 0;
+pub const MTLResourceCPUCacheModeMask: NSUInteger = 0xf << MTLResourceCPUCacheModeShift;
+pub const MTLResourceStorageModeShift: NSUInteger = 4;
+pub const MTLResourceStorageModeMask: NSUInteger = 0xf << MTLResourceStorageModeShift;
+pub const MTLResourceHazardTrackingModeShift: NSUInteger = 8;
+pub const MTLResourceHazardTrackingModeMask: NSUInteger = 0x3 << MTLResourceHazardTrackingModeShift;
+
+bitflags::bitflags! {
+    /// See <https://developer.apple.com/documentation/metal/mtlresourceoptions>
+    #[allow(non_upper_case_globals)]
+    #[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
+    pub struct MTLResourceOptions: NSUInteger {
+        const CPUCacheModeDefaultCache  = (MTLCPUCacheMode::DefaultCache as NSUInteger) << MTLResourceCPUCacheModeShift;
+        const CPUCacheModeWriteCombined = (MTLCPUCacheMode::WriteCombined as NSUInteger) << MTLResourceCPUCacheModeShift;
+
+        const StorageModeShared  = (MTLStorageMode::Shared as NSUInteger)  << MTLResourceStorageModeShift;
+        const StorageModeManaged = (MTLStorageMode::Managed as NSUInteger) << MTLResourceStorageModeShift;
+        const StorageModePrivate = (MTLStorageMode::Private as NSUInteger) << MTLResourceStorageModeShift;
+        const StorageModeMemoryless = (MTLStorageMode::Memoryless as NSUInteger) << MTLResourceStorageModeShift;
+
+        /// Only available on macos(10.13), ios(10.0)
+        const HazardTrackingModeDefault = (MTLHazardTrackingMode::Default as NSUInteger) << MTLResourceHazardTrackingModeShift;
+        /// Only available on macos(10.13), ios(10.0)
+        const HazardTrackingModeUntracked = (MTLHazardTrackingMode::Untracked as NSUInteger) << MTLResourceHazardTrackingModeShift;
+        /// Only available on macos(10.15), ios(13.0)
+        const HazardTrackingModeTracked = (MTLHazardTrackingMode::Tracked as NSUInteger) << MTLResourceHazardTrackingModeShift;
+    }
+}
+
+bitflags::bitflags! {
+    /// Options that describe how a graphics or compute function uses an argument buffer’s resource.
+    ///
+    /// Enabling certain options for certain resources determines whether the Metal driver should
+    /// convert the resource to another format (for example, whether to decompress a color render target).
+    ///
+    /// See <https://developer.apple.com/documentation/metal/mtlresourceusage>
+    #[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
+    pub struct MTLResourceUsage: NSUInteger {
+        /// An option that enables reading from the resource.
+        const Read   = 1 << 0;
+        /// An option that enables writing to the resource.
+        const Write  = 1 << 1;
+        /// An option that enables sampling from the resource.
+        ///
+        /// Specify this option only if the resource is a texture.
+        const Sample = 1 << 2;
+    }
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlsizeandalign>
+#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
+#[repr(C)]
+pub struct MTLSizeAndAlign {
+    pub size: NSUInteger,
+    pub align: NSUInteger,
+}
+
+/// See <https://developer.apple.com/documentation/metal/mtlresource>
+pub enum MTLResource {}
+
+foreign_obj_type! {
+    type CType = MTLResource;
+    pub struct Resource;
+    type ParentType = NsObject;
+}
+
+impl ResourceRef {
+    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] }
+    }
+
+    pub fn set_purgeable_state(&self, state: MTLPurgeableState) -> MTLPurgeableState {
+        unsafe { msg_send![self, setPurgeableState: state] }
+    }
+
+    /// Only available on macOS 10.13+ & iOS 10.11+
+    pub fn allocated_size(&self) -> NSUInteger {
+        unsafe { msg_send![self, allocatedSize] }
+    }
+
+    /// 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] }
+    }
+
+    /// Only available on macos(10.13), ios(10.0)
+    pub fn heap(&self) -> &HeapRef {
+        unsafe { msg_send![self, heap] }
+    }
+
+    /// Only available on macos(10.15), ios(13.0)
+    pub fn heap_offset(&self) -> NSUInteger {
+        unsafe { msg_send![self, heapOffset] }
+    }
+
+    /// Only available on macos(10.13), ios(10.0)
+    pub fn make_aliasable(&self) {
+        unsafe { msg_send![self, makeAliasable] }
+    }
+
+    /// Only available on macos(10.13), ios(10.0)
+    pub fn is_aliasable(&self) -> bool {
+        unsafe { msg_send_bool![self, isAliasable] }
+    }
+}