1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
use std::{ops::Range, os::raw::c_void, ptr::NonNull};
use objc2::{Message, extern_protocol, msg_send, rc::Retained, runtime::ProtocolObject};
use objc2_foundation::NSRange;
use objc2_io_surface::IOSurfaceRef;
use crate::{
MTLBuffer, MTLDevice, MTLPixelFormat, MTLRegion, MTLResource, MTLResourceID, MTLSharedTextureHandle,
MTLTextureCompressionType, MTLTextureSparseTier, MTLTextureSwizzleChannels, MTLTextureType, MTLTextureUsage,
};
extern_protocol!(
/// MTLTexture represents a collection of 1D, 2D, or 3D images.
///
/// Each image in a texture is a 1D, 2D, 2DMultisample, or 3D image. The texture contains one or more images arranged in a mipmap stack. If there are multiple mipmap stacks, each one is referred to as a slice of the texture. 1D, 2D, 2DMultisample, and 3D textures have a single slice. In 1DArray and 2DArray textures, every slice is an array element. A Cube texture always has 6 slices, one for each face. In a CubeArray texture, each set of six slices is one element in the array.
///
/// Most APIs that operate on individual images in a texture address those images via a tuple of a Slice, and Mipmap Level within that slice.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/metal/mtltexture?language=objc)
pub unsafe trait MTLTexture: MTLResource {
/// The resource this texture was created from. It may be a texture or a buffer. If this texture is not reusing storage of another MTLResource, then nil is returned.
#[deprecated = "Use parentTexture or buffer instead"]
#[unsafe(method(rootResource))]
#[unsafe(method_family = none)]
fn root_resource(&self) -> Option<Retained<ProtocolObject<dyn MTLResource>>>;
/// The texture this texture view was created from, or nil if this is not a texture view or it was not created from a texture.
#[unsafe(method(parentTexture))]
#[unsafe(method_family = none)]
fn parent_texture(&self) -> Option<Retained<ProtocolObject<dyn MTLTexture>>>;
/// The base level of the texture this texture view was created from, or 0 if this is not a texture view.
#[unsafe(method(parentRelativeLevel))]
#[unsafe(method_family = none)]
fn parent_relative_level(&self) -> usize;
/// The base slice of the texture this texture view was created from, or 0 if this is not a texture view.
#[unsafe(method(parentRelativeSlice))]
#[unsafe(method_family = none)]
fn parent_relative_slice(&self) -> usize;
/// The buffer this texture view was created from, or nil if this is not a texture view or it was not created from a buffer.
#[unsafe(method(buffer))]
#[unsafe(method_family = none)]
fn buffer(&self) -> Option<Retained<ProtocolObject<dyn MTLBuffer>>>;
/// The offset of the buffer this texture view was created from, or 0 if this is not a texture view.
#[unsafe(method(bufferOffset))]
#[unsafe(method_family = none)]
fn buffer_offset(&self) -> usize;
/// The bytesPerRow of the buffer this texture view was created from, or 0 if this is not a texture view.
#[unsafe(method(bufferBytesPerRow))]
#[unsafe(method_family = none)]
fn buffer_bytes_per_row(&self) -> usize;
/// If this texture was created from an IOSurface, this returns a reference to that IOSurface. iosurface is nil if this texture was not created from an IOSurface.
#[unsafe(method(iosurface))]
#[unsafe(method_family = none)]
fn iosurface(&self) -> Option<Retained<IOSurfaceRef>>;
/// If this texture was created from an IOSurface, this returns the plane of the IOSurface from which the texture was created. iosurfacePlane is 0 if this texture was not created from an IOSurface.
#[unsafe(method(iosurfacePlane))]
#[unsafe(method_family = none)]
fn iosurface_plane(&self) -> usize;
/// The type of this texture.
#[unsafe(method(textureType))]
#[unsafe(method_family = none)]
fn texture_type(&self) -> MTLTextureType;
/// The MTLPixelFormat that is used to interpret this texture's contents.
#[unsafe(method(pixelFormat))]
#[unsafe(method_family = none)]
fn pixel_format(&self) -> MTLPixelFormat;
/// The width of the MTLTexture instance in pixels.
#[unsafe(method(width))]
#[unsafe(method_family = none)]
fn width(&self) -> usize;
/// The height of the MTLTexture instance in pixels.
///
/// . height is 1 if the texture is 1D.
#[unsafe(method(height))]
#[unsafe(method_family = none)]
fn height(&self) -> usize;
/// The depth of this MTLTexture instance in pixels.
///
/// If this MTLTexture is not a 3D texture, the depth is 1
#[unsafe(method(depth))]
#[unsafe(method_family = none)]
fn depth(&self) -> usize;
/// The number of mipmap levels in each slice of this MTLTexture.
#[unsafe(method(mipmapLevelCount))]
#[unsafe(method_family = none)]
fn mipmap_level_count(&self) -> usize;
/// The number of samples in each pixel of this MTLTexture.
///
/// If this texture is any type other than 2DMultisample, samples is 1.
#[unsafe(method(sampleCount))]
#[unsafe(method_family = none)]
fn sample_count(&self) -> usize;
/// The number of array elements in this MTLTexture.
///
/// For non-Array texture types, arrayLength is 1.
#[unsafe(method(arrayLength))]
#[unsafe(method_family = none)]
fn array_length(&self) -> usize;
/// Description of texture usage.
#[unsafe(method(usage))]
#[unsafe(method_family = none)]
fn usage(&self) -> MTLTextureUsage;
/// If YES, this texture can be shared with other processes.
///
/// Texture can be shared across process addres space boundaries through use of sharedTextureHandle and XPC.
#[unsafe(method(isShareable))]
#[unsafe(method_family = none)]
fn is_shareable(&self) -> bool;
/// If YES, this texture can only be used with a MTLAttachmentDescriptor, and cannot be used as a texture argument for MTLRenderCommandEncoder, MTLBlitCommandEncoder, or MTLComputeCommandEncoder. Furthermore, when this property's value is YES, readPixels/writePixels may not be used with this texture.
///
/// Textures obtained from CAMetalDrawables may have this property set to YES, depending on the value of frameBufferOnly passed to their parent CAMetalLayer. Textures created directly by the application will not have any restrictions.
#[unsafe(method(isFramebufferOnly))]
#[unsafe(method_family = none)]
fn is_framebuffer_only(&self) -> bool;
/// For sparse textures this property returns index of first mipmap that is packed in tail.
/// Mapping this mipmap level will map all subsequent mipmap levels.
#[optional]
#[unsafe(method(firstMipmapInTail))]
#[unsafe(method_family = none)]
fn first_mipmap_in_tail(&self) -> usize;
/// Amount of memory in bytes required to map sparse texture tail.
#[optional]
#[unsafe(method(tailSizeInBytes))]
#[unsafe(method_family = none)]
fn tail_size_in_bytes(&self) -> usize;
#[optional]
#[unsafe(method(isSparse))]
#[unsafe(method_family = none)]
fn is_sparse(&self) -> bool;
/// Allow GPU-optimization for the contents texture. The default value is true.
///
/// Useful for opting-out of GPU-optimization when implicit optimization (e.g. RT writes) is regressing CPU-read-back performance. See the documentation for optimizeContentsForGPUAccess: and optimizeContentsForCPUAccess: APIs.
#[unsafe(method(allowGPUOptimizedContents))]
#[unsafe(method_family = none)]
fn allow_gpu_optimized_contents(&self) -> bool;
/// Returns the compression type of the texture
///
/// See the compressionType property on MTLTextureDescriptor
#[unsafe(method(compressionType))]
#[unsafe(method_family = none)]
fn compression_type(&self) -> MTLTextureCompressionType;
/// Handle of the GPU resource suitable for storing in an Argument Buffer
#[unsafe(method(gpuResourceID))]
#[unsafe(method_family = none)]
fn gpu_resource_id(&self) -> MTLResourceID;
/// Convenience for getBytes:bytesPerRow:bytesPerImage:fromRegion:mipmapLevel:slice: that doesn't require slice related arguments
///
/// # Safety
///
/// `pixel_bytes` must be a valid pointer.
#[unsafe(method(getBytes:bytesPerRow:fromRegion:mipmapLevel:))]
#[unsafe(method_family = none)]
fn get_bytes(
&self,
pixel_bytes: NonNull<c_void>,
bytes_per_row: usize,
region: MTLRegion,
level: usize,
);
/// Copies a block of pixels from a texture slice into the application's memory.
///
/// # Safety
///
/// `pixel_bytes` must be a valid pointer.
#[unsafe(method(getBytes:bytesPerRow:bytesPerImage:fromRegion:mipmapLevel:slice:))]
#[unsafe(method_family = none)]
fn get_bytes_bytes_with_bytes_per_image_slice(
&self,
pixel_bytes: NonNull<c_void>,
bytes_per_row: usize,
bytes_per_image: usize,
region: MTLRegion,
level: usize,
slice: usize,
);
/// Convenience for replaceRegion:mipmapLevel:slice:withBytes:bytesPerRow:bytesPerImage: that doesn't require slice related arguments
///
/// # Safety
///
/// `pixel_bytes` must be a valid pointer.
#[unsafe(method(replaceRegion:mipmapLevel:withBytes:bytesPerRow:))]
#[unsafe(method_family = none)]
fn replace_region(
&self,
region: MTLRegion,
level: usize,
pixel_bytes: NonNull<c_void>,
bytes_per_row: usize,
);
/// Copy a block of pixel data from the caller's pointer into a texture slice.
///
/// # Safety
///
/// `pixel_bytes` must be a valid pointer.
#[unsafe(method(replaceRegion:mipmapLevel:slice:withBytes:bytesPerRow:bytesPerImage:))]
#[unsafe(method_family = none)]
fn replace_region_with_slice_bytes_per_image(
&self,
region: MTLRegion,
level: usize,
slice: usize,
pixel_bytes: NonNull<c_void>,
bytes_per_row: usize,
bytes_per_image: usize,
);
/// Create a new texture which shares the same storage as the source texture, but with a different (but compatible) pixel format.
#[unsafe(method(newTextureViewWithPixelFormat:))]
#[unsafe(method_family = new)]
fn new_texture_view_with_pixel_format(
&self,
pixel_format: MTLPixelFormat,
) -> Option<Retained<ProtocolObject<dyn MTLTexture>>>;
/// Create a new texture which shares the same storage as the source texture, but with a different (but compatible) pixel format, texture type, levels, slices and swizzle.
#[unsafe(method(newTextureViewWithPixelFormat:textureType:levels:slices:swizzle:))]
#[unsafe(method_family = new)]
fn new_texture_view_with_pixel_format_texture_type_levels_slices_swizzle(
&self,
pixel_format: MTLPixelFormat,
texture_type: MTLTextureType,
level_range: NSRange,
slice_range: NSRange,
swizzle: MTLTextureSwizzleChannels,
) -> Option<Retained<ProtocolObject<dyn MTLTexture>>>;
/// Create a new texture handle, that can be shared across process addres space boundaries.
#[unsafe(method(newSharedTextureHandle))]
#[unsafe(method_family = new)]
fn new_shared_texture_handle(&self) -> Option<Retained<MTLSharedTextureHandle>>;
/// For Metal texture objects that are remote views, this returns the texture associated with the storage on the originating device.
#[unsafe(method(remoteStorageTexture))]
#[unsafe(method_family = none)]
fn remote_storage_texture(&self) -> Option<Retained<ProtocolObject<dyn MTLTexture>>>;
/// On Metal devices that support peer to peer transfers, this method is used to create a remote texture view on another device
/// within the peer group. The receiver must use MTLStorageModePrivate or be backed by an IOSurface.
#[unsafe(method(newRemoteTextureViewForDevice:))]
#[unsafe(method_family = new)]
fn new_remote_texture_view_for_device(
&self,
device: &ProtocolObject<dyn MTLDevice>,
) -> Option<Retained<ProtocolObject<dyn MTLTexture>>>;
/// The channel swizzle used when reading or sampling from this texture
#[unsafe(method(swizzle))]
#[unsafe(method_family = none)]
fn swizzle(&self) -> MTLTextureSwizzleChannels;
/// Query support tier for sparse textures.
#[unsafe(method(sparseTextureTier))]
#[unsafe(method_family = none)]
fn sparse_texture_tier(&self) -> MTLTextureSparseTier;
}
);
#[allow(unused)]
pub trait TextureExt: MTLTexture + Message {
/// Create a new texture which shares the same storage as the source texture, but with a different (but compatible) pixel format, texture type, levels and slices.
fn new_texture_view_with_pixel_format_texture_type_levels_slices(
&self,
pixel_format: MTLPixelFormat,
texture_type: MTLTextureType,
level_range: Range<usize>,
slice_range: Range<usize>,
) -> Option<Retained<ProtocolObject<dyn MTLTexture>>>;
}
impl TextureExt for ProtocolObject<dyn MTLTexture> {
fn new_texture_view_with_pixel_format_texture_type_levels_slices(
&self,
pixel_format: MTLPixelFormat,
texture_type: MTLTextureType,
level_range: Range<usize>,
slice_range: Range<usize>,
) -> Option<Retained<ProtocolObject<dyn MTLTexture>>> {
unsafe {
msg_send![
self,
newTextureViewWithPixelFormat: pixel_format,
textureType: texture_type,
levels: Into::<NSRange>::into(level_range),
slices: Into::<NSRange>::into(slice_range),
]
}
}
}