Struct ocl::Image [−][src]
pub struct Image<T: OclPrm> { /* fields omitted */ }
A section of device memory which represents one or many images.
Use ::builder for an easy way to create. [UNIMPLEMENTED]
Methods
impl<T: OclPrm> Image<T>[src]
impl<T: OclPrm> Image<T>pub fn supported_formats(
context: &Context,
flags: MemFlags,
mem_obj_type: MemObjectType
) -> OclResult<Vec<ImageFormatParseResult>>[src]
pub fn supported_formats(
context: &Context,
flags: MemFlags,
mem_obj_type: MemObjectType
) -> OclResult<Vec<ImageFormatParseResult>>Returns a list of supported image formats.
pub fn builder<'a>() -> ImageBuilder<'a, T>[src]
pub fn builder<'a>() -> ImageBuilder<'a, T>Returns an ImageBuilder. This is the recommended method to create
a new Image.
pub unsafe fn new<'o, Q>(
que_ctx: Q,
flags: MemFlags,
image_format: ImageFormat,
image_desc: ImageDescriptor,
host_data: Option<&[T]>
) -> OclResult<Image<T>> where
Q: Into<QueCtx<'o>>, [src]
pub unsafe fn new<'o, Q>(
que_ctx: Q,
flags: MemFlags,
image_format: ImageFormat,
image_desc: ImageDescriptor,
host_data: Option<&[T]>
) -> OclResult<Image<T>> where
Q: Into<QueCtx<'o>>, Returns a new Image.
Prefer ::builder to create a new image.
pub fn from_gl_texture<'o, Q>(
que_ctx: Q,
flags: MemFlags,
image_desc: ImageDescriptor,
texture_target: GlTextureTarget,
miplevel: cl_GLint,
texture: cl_GLuint
) -> OclResult<Image<T>> where
Q: Into<QueCtx<'o>>, [src]
pub fn from_gl_texture<'o, Q>(
que_ctx: Q,
flags: MemFlags,
image_desc: ImageDescriptor,
texture_target: GlTextureTarget,
miplevel: cl_GLint,
texture: cl_GLuint
) -> OclResult<Image<T>> where
Q: Into<QueCtx<'o>>, Returns a new Image from an existant GL texture2D/3D.
pub fn from_gl_renderbuffer<'o, Q>(
que_ctx: Q,
flags: MemFlags,
image_desc: ImageDescriptor,
renderbuffer: cl_GLuint
) -> OclResult<Image<T>> where
Q: Into<QueCtx<'o>>, [src]
pub fn from_gl_renderbuffer<'o, Q>(
que_ctx: Q,
flags: MemFlags,
image_desc: ImageDescriptor,
renderbuffer: cl_GLuint
) -> OclResult<Image<T>> where
Q: Into<QueCtx<'o>>, Returns a new Image from an existant renderbuffer.
pub fn cmd(&self) -> ImageCmd<T>[src]
pub fn cmd(&self) -> ImageCmd<T>Returns an image command builder used to read, write, copy, etc.
Call .enq() to enqueue the command.
See the command builder documentation for more details.
pub fn read<'c, 'd>(&'c self, data: &'d mut [T]) -> ImageCmd<'c, T> where
'd: 'c, [src]
pub fn read<'c, 'd>(&'c self, data: &'d mut [T]) -> ImageCmd<'c, T> where
'd: 'c, Returns an image command builder set to read.
Call .enq() to enqueue the command.
See the command builder documentation for more details.
pub fn write<'c, 'd>(&'c self, data: &'d [T]) -> ImageCmd<'c, T> where
'd: 'c, [src]
pub fn write<'c, 'd>(&'c self, data: &'d [T]) -> ImageCmd<'c, T> where
'd: 'c, Returns an image command builder set to write.
Call .enq() to enqueue the command.
See the command builder documentation for more details.
pub unsafe fn map<'c>(&'c self) -> ImageMapCmd<'c, T>[src]
pub unsafe fn map<'c>(&'c self) -> ImageMapCmd<'c, T>Returns a command builder used to map data for reading or writing.
Call .enq() to enqueue the command.
Safety
The caller must ensure that only one mapping of a particular memory region exists at a time.
See the command builder documentation for more details.
pub fn set_default_queue<'a>(&'a mut self, queue: Queue) -> &'a mut Image<T>[src]
pub fn set_default_queue<'a>(&'a mut self, queue: Queue) -> &'a mut Image<T>Changes the default queue.
Returns a ref for chaining i.e.:
image.set_default_queue(queue).write(....);
[NOTE]: Even when used as above, the queue is changed permanently, not just for the one call. Changing the queue is cheap so feel free to change as often as needed.
The new queue must be associated with a valid device.
pub fn default_queue(&self) -> Option<&Queue>[src]
pub fn default_queue(&self) -> Option<&Queue>Returns a reference to the default queue.
pub fn dims(&self) -> &SpatialDims[src]
pub fn dims(&self) -> &SpatialDimsReturns this image's dimensions.
pub fn pixel_count(&self) -> usize[src]
pub fn pixel_count(&self) -> usizeReturns the total number of pixels in this image.
pub fn pixel_element_len(&self) -> usize[src]
pub fn pixel_element_len(&self) -> usizeReturns the length of each pixel element.
pub fn element_count(&self) -> usize[src]
pub fn element_count(&self) -> usizeReturns the total number of pixel elements in this image. Equivalent to its length.
pub fn info(&self, info_kind: ImageInfo) -> OclResult<ImageInfoResult>[src]
pub fn info(&self, info_kind: ImageInfo) -> OclResult<ImageInfoResult>Get information about this image.
pub fn mem_info(&self, info_kind: MemInfo) -> OclResult<MemInfoResult>[src]
pub fn mem_info(&self, info_kind: MemInfo) -> OclResult<MemInfoResult>Returns info about this image's memory.
pub fn as_core(&self) -> &MemCore[src]
pub fn as_core(&self) -> &MemCoreReturns a reference to the core pointer wrapper, usable by functions in
the core module.
Methods from Deref<Target = MemCore>
Trait Implementations
impl<T: Clone + OclPrm> Clone for Image<T>[src]
impl<T: Clone + OclPrm> Clone for Image<T>fn clone(&self) -> Image<T>[src]
fn clone(&self) -> Image<T>Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
fn clone_from(&mut self, source: &Self)Performs copy-assignment from source. Read more
impl<T: Debug + OclPrm> Debug for Image<T>[src]
impl<T: Debug + OclPrm> Debug for Image<T>fn fmt(&self, f: &mut Formatter) -> Result[src]
fn fmt(&self, f: &mut Formatter) -> ResultFormats the value using the given formatter. Read more
impl<T: OclPrm> Display for Image<T>[src]
impl<T: OclPrm> Display for Image<T>fn fmt(&self, f: &mut Formatter) -> Result[src]
fn fmt(&self, f: &mut Formatter) -> ResultFormats the value using the given formatter. Read more
impl<T: OclPrm> Deref for Image<T>[src]
impl<T: OclPrm> Deref for Image<T>type Target = MemCore
The resulting type after dereferencing.
fn deref(&self) -> &MemCore[src]
fn deref(&self) -> &MemCoreDereferences the value.
impl<T: OclPrm> DerefMut for Image<T>[src]
impl<T: OclPrm> DerefMut for Image<T>impl<T: OclPrm> AsMem<T> for Image<T>[src]
impl<T: OclPrm> AsMem<T> for Image<T>impl<'a, T> MemCmdRw for Image<T> where
T: OclPrm, [src]
impl<'a, T> MemCmdRw for Image<T> where
T: OclPrm, impl<'a, T> MemCmdRw for &'a Image<T> where
T: OclPrm, [src]
impl<'a, T> MemCmdRw for &'a Image<T> where
T: OclPrm, impl<'a, T> MemCmdRw for &'a mut Image<T> where
T: OclPrm, [src]
impl<'a, T> MemCmdRw for &'a mut Image<T> where
T: OclPrm, impl<'a, T> MemCmdAll for Image<T> where
T: OclPrm, [src]
impl<'a, T> MemCmdAll for Image<T> where
T: OclPrm, impl<'a, T> MemCmdAll for &'a Image<T> where
T: OclPrm, [src]
impl<'a, T> MemCmdAll for &'a Image<T> where
T: OclPrm, impl<'a, T> MemCmdAll for &'a mut Image<T> where
T: OclPrm, [src]
impl<'a, T> MemCmdAll for &'a mut Image<T> where
T: OclPrm,