Struct IOSurfaceRef

Source
#[repr(C)]
pub struct IOSurfaceRef { /* private fields */ }
Available on crate feature IOSurfaceRef only.
Expand description

Implementations§

Source§

impl IOSurfaceRef

Source

pub unsafe fn new(properties: &CFDictionary) -> Option<CFRetained<IOSurfaceRef>>

Available on crate feature objc2-core-foundation only.
Source

pub fn lookup(csid: IOSurfaceID) -> Option<CFRetained<IOSurfaceRef>>

Available on crate features IOSurfaceTypes and objc2-core-foundation only.
Source

pub fn id(self: &IOSurfaceRef) -> IOSurfaceID

Available on crate feature IOSurfaceTypes only.
Source

pub unsafe fn lock( self: &IOSurfaceRef, options: IOSurfaceLockOptions, seed: *mut u32, ) -> kern_return_t

Available on crate features IOSurfaceTypes and libc only.
Source

pub unsafe fn unlock( self: &IOSurfaceRef, options: IOSurfaceLockOptions, seed: *mut u32, ) -> kern_return_t

Available on crate features IOSurfaceTypes and libc only.
Source

pub fn alloc_size(self: &IOSurfaceRef) -> usize

Source

pub fn width(self: &IOSurfaceRef) -> usize

Source

pub fn height(self: &IOSurfaceRef) -> usize

Source

pub fn bytes_per_element(self: &IOSurfaceRef) -> usize

Source

pub fn bytes_per_row(self: &IOSurfaceRef) -> usize

Source

pub fn base_address(self: &IOSurfaceRef) -> NonNull<c_void>

Source

pub fn element_width(self: &IOSurfaceRef) -> usize

Source

pub fn element_height(self: &IOSurfaceRef) -> usize

Source

pub fn pixel_format(self: &IOSurfaceRef) -> u32

Source

pub fn seed(self: &IOSurfaceRef) -> u32

Source

pub fn plane_count(self: &IOSurfaceRef) -> usize

Source

pub fn width_of_plane(self: &IOSurfaceRef, plane_index: usize) -> usize

Source

pub fn height_of_plane(self: &IOSurfaceRef, plane_index: usize) -> usize

Source

pub fn bytes_per_element_of_plane( self: &IOSurfaceRef, plane_index: usize, ) -> usize

Source

pub fn bytes_per_row_of_plane(self: &IOSurfaceRef, plane_index: usize) -> usize

Source

pub fn base_address_of_plane( self: &IOSurfaceRef, plane_index: usize, ) -> NonNull<c_void>

Source

pub fn element_width_of_plane(self: &IOSurfaceRef, plane_index: usize) -> usize

Source

pub fn element_height_of_plane(self: &IOSurfaceRef, plane_index: usize) -> usize

Source

pub fn number_of_components_of_plane( self: &IOSurfaceRef, plane_index: usize, ) -> usize

Source

pub fn name_of_component_of_plane( self: &IOSurfaceRef, plane_index: usize, component_index: usize, ) -> IOSurfaceComponentName

Source

pub fn type_of_component_of_plane( self: &IOSurfaceRef, plane_index: usize, component_index: usize, ) -> IOSurfaceComponentType

Source

pub fn range_of_component_of_plane( self: &IOSurfaceRef, plane_index: usize, component_index: usize, ) -> IOSurfaceComponentRange

Source

pub fn bit_depth_of_component_of_plane( self: &IOSurfaceRef, plane_index: usize, component_index: usize, ) -> usize

Source

pub fn bit_offset_of_component_of_plane( self: &IOSurfaceRef, plane_index: usize, component_index: usize, ) -> usize

Source

pub fn subsampling(self: &IOSurfaceRef) -> IOSurfaceSubsampling

Source§

impl IOSurfaceRef

Source

pub unsafe fn set_value(self: &IOSurfaceRef, key: &CFString, value: &CFType)

Available on crate feature objc2-core-foundation only.
Source

pub fn value(self: &IOSurfaceRef, key: &CFString) -> Option<CFRetained<CFType>>

Available on crate feature objc2-core-foundation only.
Source

pub fn remove_value(self: &IOSurfaceRef, key: &CFString)

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn set_values(self: &IOSurfaceRef, keys_and_values: &CFDictionary)

Available on crate feature objc2-core-foundation only.
Source

pub fn all_values(self: &IOSurfaceRef) -> Option<CFRetained<CFDictionary>>

Available on crate feature objc2-core-foundation only.
Source

pub fn remove_all_values(self: &IOSurfaceRef)

Source

pub fn create_mach_port(self: &IOSurfaceRef) -> mach_port_t

Available on crate feature libc only.
Source

pub fn lookup_from_mach_port( port: mach_port_t, ) -> Option<CFRetained<IOSurfaceRef>>

Available on crate features libc and objc2-core-foundation only.
Source

pub fn property_maximum(property: &CFString) -> usize

Available on crate feature objc2-core-foundation only.
Source

pub fn property_alignment(property: &CFString) -> usize

Available on crate feature objc2-core-foundation only.
Source

pub fn align_property(property: &CFString, value: usize) -> usize

Available on crate feature objc2-core-foundation only.
Source

pub fn increment_use_count(self: &IOSurfaceRef)

Source

pub fn decrement_use_count(self: &IOSurfaceRef)

Source

pub fn use_count(self: &IOSurfaceRef) -> i32

Source

pub fn is_in_use(self: &IOSurfaceRef) -> bool

Source

pub fn allows_pixel_size_casting(self: &IOSurfaceRef) -> bool

Source

pub unsafe fn set_purgeable( self: &IOSurfaceRef, new_state: u32, old_state: *mut u32, ) -> kern_return_t

Available on crate feature libc only.

Methods from Deref<Target = CFType>§

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: ConcreteType,

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

Source

pub fn retain_count(&self) -> usize

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations§

Source§

impl AsRef<AnyObject> for IOSurfaceRef

Source§

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl AsRef<CFType> for IOSurfaceRef

Source§

fn as_ref(&self) -> &CFType

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl AsRef<IOSurfaceRef> for IOSurfaceRef

Source§

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Borrow<AnyObject> for IOSurfaceRef

Source§

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value. Read more
Source§

impl Borrow<CFType> for IOSurfaceRef

Source§

fn borrow(&self) -> &CFType

Immutably borrows from an owned value. Read more
Source§

impl ConcreteType for IOSurfaceRef

Available on crate feature objc2-core-foundation only.
Source§

fn type_id() -> CFTypeID

Get the unique CFTypeID identifier for the type. Read more
Source§

impl Debug for IOSurfaceRef

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Deref for IOSurfaceRef

Source§

type Target = CFType

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl Hash for IOSurfaceRef

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Message for IOSurfaceRef

Source§

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more
Source§

impl PartialEq for IOSurfaceRef

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl RefEncode for IOSurfaceRef

Source§

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type. Read more
Source§

impl Type for IOSurfaceRef

Source§

fn retain(&self) -> CFRetained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more
Source§

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant
Helper for easier transition from the core-foundation crate.
Source§

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>
where Self: Sized,

👎Deprecated: use CFRetained::retain
Helper for easier transition from the core-foundation crate. Read more
Source§

fn as_CFTypeRef(&self) -> &CFType
where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)
Helper for easier transition from the core-foundation crate.
Source§

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>
where Self: Sized,

👎Deprecated: use CFRetained::from_raw
Helper for easier transition from the core-foundation crate. Read more
Source§

impl Eq for IOSurfaceRef

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,