Struct blaze_rs::memobj::RawMemObject

#[repr(transparent)]
pub struct RawMemObject(_);

A raw OpenCL memory object

Implementations

impl RawMemObject

pub const unsafe fn from_id_unchecked(id: cl_mem) -> Self

pub const unsafe fn from_id(id: cl_mem) -> Option<Self>

pub unsafe fn retain(&self) -> Result<()>

pub const fn id(&self) -> cl_mem

pub const fn id_ref(&self) -> &cl_mem

pub fn id_ref_mut(&mut self) -> &mut cl_mem

pub fn ty(&self) -> Result<MemObjectType>

Returns the memory obejct’s type

pub fn associated_memobject(&self) -> Result<Option<RawMemObject>>

Available on crate feature cl1_1 only.

Return memory object from which memobj is created.

pub fn flags(&self) -> Result<MemFlags>

Return the flags argument value specified when memobj is created.

pub fn size(&self) -> Result<usize>

Return actual size of the data store associated with memobj in bytes.

pub fn host_ptr(&self) -> Result<Option<NonNull<c_void>>>

If memobj is created with a host_ptr specified, return the host_ptr argument value specified when memobj is created.

pub fn map_count(&self) -> Result<u32>

Map count. The map count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for debugging.

pub fn reference_count(&self) -> Result<u32>

Return memobj reference count. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.

pub fn context(&self) -> Result<RawContext>

Return context specified when memory object is created.

pub fn offset(&self) -> Result<usize>

Available on crate feature cl1_1 only.

Return offset if memobj is a sub-buffer object created using create_sub_buffer. Returns 0 if memobj is not a subbuffer object.

pub fn uses_svm_pointer(&self) -> Result<bool>

Available on crate feature cl2 only.

Return true if memobj is a buffer object that was created with CL_MEM_USE_HOST_PTR or is a sub-buffer object of a buffer object that was created with CL_MEM_USE_HOST_PTR and the host_ptr specified when the buffer object was created is a SVM pointer; otherwise returns false.

impl RawMemObject

pub fn on_destruct(&self, f: impl 'static + FnOnce() + Send) -> Result<()>

Available on crate feature cl1_1 only.

Adds a callback to be executed when the memory object is destructed by OpenCL.

pub fn on_destruct_boxed(&self, f: Box<dyn FnOnce() + Send>) -> Result<()>

Available on crate feature cl1_1 only.

pub unsafe fn on_destruct_raw( &self, f: unsafe extern "C" fn(memobj: cl_mem, user_data: *mut c_void), user_data: *mut c_void ) -> Result<()>

Available on crate feature cl1_1 only.

Trait Implementations

impl AsMem for RawMemObject

fn as_mem(&self) -> &RawMemObject

impl AsMutMem for RawMemObject

fn as_mut_mem(&mut self) -> &mut RawMemObject

impl Clone for RawMemObject

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RawMemObject

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

Formats the value using the given formatter.

impl Drop for RawMemObject

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for RawMemObject

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Into<RawMemObject> for RawBuffer

fn into(self) -> RawMemObject

Converts this type into the (usually inferred) input type.

impl PartialEq<RawMemObject> for RawMemObject

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RawMemObject

impl Send for RawMemObject

impl StructuralEq for RawMemObject

impl StructuralPartialEq for RawMemObject

impl Sync for RawMemObject