Struct OpenClMem 

pub struct OpenClMem { /* private fields */ }

cl_mem handle paired with its producing cl_command_queue.

row_pitch is meaningful only for cl_mem BUFFER objects holding image data with non-tight rows; see the documentation on the OpenCl variant for the full contract.

Implementations

impl OpenClMem

pub unsafe fn try_from_raw( mem: *mut c_void, queue: *mut c_void, row_pitch: u32, keep_alive: Option<KeepAlive>, ) -> Result<Self, InvalidHandleError>

Wrap a raw cl_mem together with the cl_command_queue that produced it. Borrowing: the handle is stored non-owningly, this type has no Drop, and every obligation below extends to each Clone.

Safety

• mem must be a live cl_mem whose OpenCL reference count is at least one.
• queue must be a live cl_command_queue on a context that owns mem. Consumers enqueue against queue naming mem; an unrelated context makes that an invalid-object call at best and undefined at worst. Null for either is rejected as InvalidHandleError::NullPointer and is not a caller obligation.
• Refcount: neither clRetainMemObject nor clRetainCommandQueue is called here, and there is no Drop that releases. The caller’s references on both objects must outlive this value and every Clone of it — pass a keep_alive anchor that holds them, or carry the obligation directly when it is None. Releasing either while a clone survives is a use-after-free.
• row_pitch is meaningful only when mem is a BUFFER object holding image rows that are not tightly packed; it must then be the real row stride in bytes, since consumers index rows by it. Pass 0 for image objects and tightly-packed buffers.
• Cross-thread: OpenClMem is Send + Sync. OpenCL objects are thread-safe under the 1.2+ spec, but a single cl_command_queue is only safe to enqueue on concurrently because the runtime serialises it — the caller must still not assume ordering between its own enqueues and the consumer’s.

pub fn mem(&self) -> *mut c_void

pub fn queue(&self) -> *mut c_void

pub fn row_pitch(&self) -> u32

pub fn keep_alive(&self) -> Option<&KeepAlive>

Trait Implementations

impl Clone for OpenClMem

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenClMem

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

Formats the value using the given formatter.

impl Send for OpenClMem

impl Sync for OpenClMem