-
Notifications
You must be signed in to change notification settings - Fork 44
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Metal: Reexpose safe wrappers for static MTLDevice
getters
#638
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! We should work on fixing this in the generator itself, instead of fixing it locally like this, but for now I'm fine with fixing this locally for Metal.
|
||
// impl<P: MTLDevice> MTLDeviceExt for P {} | ||
|
||
pub fn mtl_device_system_default() -> Option<Id<ProtocolObject<dyn MTLDevice>>> { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would rather have these be something like:
pub extern "C" fn MTLCreateSystemDefaultDevice() -> Option<Retained<ProtocolObject<dyn MTLDevice>>> {
extern "C" {
pub fn MTLCreateSystemDefaultDevice() -> *mut ProtocolObject<dyn MTLDevice>;
}
unsafe { Retained::from_raw(MTLCreateSystemDefaultDevice()) }
}
That is, change the signature of MTLCreateSystemDefaultDevice
to do the Retained::from_raw
step internally.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That would be lovely! I take it from this that we should keep the name to match Objective-C with CamelCase too?
Let me know when you can set that up in the generator, which would save us the hassle of reimplementing. But if you don't get to that in time, landing this now should make it easier to notice that there's some files that can be removed in the future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, I've been (and will be) away for various summer holiday activities in recent times, so I'm a bit out of the loop myself. I think it would be fairly easy to implement generally, but I probably won't have time to do it before August.
I'm fine with pulling this change now, but in any case, I'm probably not going to cut a new release before it's implemented generally (opened #639), so you could also just wait for that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't absolutely need these functions right now (would be nice to start using them in the example in Traverse-Research/gpu-allocator#225).
Shall I leave this PR open then to not forget to remove this custom file when you've resolved #639? Thanks in advance!
@@ -162,7 +162,7 @@ pub type Id<T> = Retained<T>; | |||
|
|||
impl<T: ?Sized> Retained<T> { | |||
#[inline] | |||
pub(crate) unsafe fn new_nonnull(ptr: NonNull<T>) -> Self { | |||
pub unsafe fn new_nonnull(ptr: NonNull<T>) -> Self { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't want to expose this, users should use Retained::from_raw(ptr.as_ptr()).unwrap()
instead as the unwrap should be optimized away (and if it isn't, we have Option::unwrap_unchecked
for that).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm that seems a bit silly when there is an API primitive available that is nicer and easier to read?
from_raw()
uses this under the hood after all, and the only difference I see is the extra + Message
bound to get access to it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree that it is a bit silly; but I'm trying to follow std
here, and the prime examples of smart pointers, Box
and Arc
, only expose Box::from_raw
and Arc::from_raw
, and I don't really want to differ from these here if I can avoid it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I hadn't thought about matching std
at all, where I don't use these functions very often (they're after all only to for raw pointers that originate from Rust at some point, i.e. temporarily creating a "user pointer" for FFI).
Here in objc2
it seems to make sense given that your bindings already generate a NonNull
annotation where applicable.
e4741a7
to
2217830
Compare
2217830
to
8106263
Compare
The safe wrappers for these static functions seem to have been commented out as it is really hard to extend a dynamic
trait
object with some concrete static functions (that exist regardless of a concrete type implementing theMTLDevice
trait). Instead, make them available as free functions prefixed withmtl_device_*()
, to allow users to more easily read the "system default" device or get a list of all devices.