Struct opencl3::memory::Pipe

pub struct Pipe { /* fields omitted */ }

An OpenCL pipe.
Has methods to return information from calls to clGetPipeInfo with the appropriate parameters.
Implements the Drop trait to call release_mem_object when the object is dropped.

Implementations

impl Pipe

pub fn new(pipe: cl_mem) -> Pipe

pub fn create(
    context: &Context,
    flags: cl_mem_flags,
    pipe_packet_size: cl_uint,
    pipe_max_packets: cl_uint
) -> Result<Pipe>

pub fn pipe_packet_size(&self) -> Result<cl_uint>

pub fn pipe_max_packets(&self) -> Result<cl_uint>

pub fn pipe_properties(&self) -> Result<Vec<intptr_t>>

pub fn get_data(&self, param_name: cl_pipe_info) -> Result<Vec<u8>>

Get data about an OpenCL pipe object.
Calls clGetPipeInfo to get the desired information about the pipe object.

Trait Implementations

impl ClMem for Pipe

fn get(&self) -> cl_mem

fn get_mut(&mut self) -> cl_mem

fn mem_type(&self) -> Result<cl_mem_object_type>

fn flags(&self) -> Result<cl_mem_flags>

fn size(&self) -> Result<size_t>

fn host_ptr(&self) -> Result<intptr_t>

fn map_count(&self) -> Result<cl_uint>

fn reference_count(&self) -> Result<cl_uint>

fn context(&self) -> Result<cl_context>

fn associated_memobject(&self) -> Result<cl_mem>

fn offset(&self) -> Result<size_t>

fn uses_svm_pointer(&self) -> Result<cl_uint>

fn properties(&self) -> Result<Vec<cl_ulong>>

CL_VERSION_3_0

fn get_mem_data(&self, param_name: cl_mem_info) -> Result<Vec<u8>>

Get memory data about an OpenCL memory object. Calls clGetMemObjectInfo to get the desired data about the memory object.

fn gl_object_info(&self) -> Result<(gl_uint, gl_uint)>

Query an OpenGL object used to create an OpenCL memory object.

impl Debug for Pipe

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

Formats the value using the given formatter.

impl Drop for Pipe

fn drop(&mut self)

Executes the destructor for this type.

impl From<*mut c_void> for Pipe

fn from(pipe: cl_mem) -> Self

Performs the conversion.

impl From<Pipe> for cl_mem

fn from(value: Pipe) -> Self

Performs the conversion.