<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `Image` struct in crate `ocl`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Image">
<title>ocl::Image - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../dark.css">
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
<script src="../storage.js"></script>
</head>
<body class="rustdoc struct">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
<p class='location'>Struct Image</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.supported_formats">supported_formats</a><a href="#method.builder">builder</a><a href="#method.new">new</a><a href="#method.from_gl_texture">from_gl_texture</a><a href="#method.from_gl_renderbuffer">from_gl_renderbuffer</a><a href="#method.cmd">cmd</a><a href="#method.read">read</a><a href="#method.write">write</a><a href="#method.map">map</a><a href="#method.set_default_queue">set_default_queue</a><a href="#method.default_queue">default_queue</a><a href="#method.dims">dims</a><a href="#method.pixel_count">pixel_count</a><a href="#method.pixel_element_len">pixel_element_len</a><a href="#method.element_count">element_count</a><a href="#method.info">info</a><a href="#method.mem_info">mem_info</a><a href="#method.as_core">as_core</a></div><a class="sidebar-title" href="#deref-methods">Methods from Deref<Target=MemCore></a><div class="sidebar-links"><a href="#method.as_ptr">as_ptr</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Display">Display</a><a href="#impl-Deref">Deref</a><a href="#impl-DerefMut">DerefMut</a><a href="#impl-AsMem%3CT%3E">AsMem<T></a><a href="#impl-MemCmdRw">MemCmdRw</a><a href="#impl-MemCmdAll">MemCmdAll</a></div></div><p class='location'><a href='index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'Image', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>ocl</a>::<wbr><a class="struct" href=''>Image</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>−</span>]
</a>
</span><a class='srclink' href='../src/ocl/standard/image.rs.html#659-665' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Image<T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> { /* fields omitted */ }</pre><div class='docblock'><p>A section of device memory which represents one or many images.</p>
<p>Use <code>::builder</code> for an easy way to create. [UNIMPLEMENTED]</p>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#667-965' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.supported_formats' class="method"><span id='supported_formats.v' class='invisible'><code>pub fn <a href='#method.supported_formats' class='fnname'>supported_formats</a>(<br> context: &<a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a>, <br> flags: <a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>, <br> mem_obj_type: <a class="enum" href="../ocl/enums/enum.MemObjectType.html" title="enum ocl::enums::MemObjectType">MemObjectType</a><br>) -> <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="type" href="../ocl_core/types/structs/type.ImageFormatParseResult.html" title="type ocl_core::types::structs::ImageFormatParseResult">ImageFormatParseResult</a>>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#669-672' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a list of supported image formats.</p>
</div><h4 id='method.builder' class="method"><span id='builder.v' class='invisible'><code>pub fn <a href='#method.builder' class='fnname'>builder</a><'a>() -> <a class="struct" href="../ocl/builders/struct.ImageBuilder.html" title="struct ocl::builders::ImageBuilder">ImageBuilder</a><'a, T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#676-678' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns an <code>ImageBuilder</code>. This is the recommended method to create
a new <code>Image</code>.</p>
</div><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub unsafe fn <a href='#method.new' class='fnname'>new</a><'o, Q>(<br> que_ctx: Q, <br> flags: <a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>, <br> image_format: <a class="struct" href="../ocl/builders/struct.ImageFormat.html" title="struct ocl::builders::ImageFormat">ImageFormat</a>, <br> image_desc: <a class="struct" href="../ocl/builders/struct.ImageDescriptor.html" title="struct ocl::builders::ImageDescriptor">ImageDescriptor</a>, <br> host_data: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[T]</a>><br>) -> <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a><<a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><QueCtx<'o>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#683-716' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>Image</code>.</p>
<p>Prefer <code>::builder</code> to create a new image.</p>
</div><h4 id='method.from_gl_texture' class="method"><span id='from_gl_texture.v' class='invisible'><code>pub fn <a href='#method.from_gl_texture' class='fnname'>from_gl_texture</a><'o, Q>(<br> que_ctx: Q, <br> flags: <a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>, <br> image_desc: <a class="struct" href="../ocl/builders/struct.ImageDescriptor.html" title="struct ocl::builders::ImageDescriptor">ImageDescriptor</a>, <br> texture_target: <a class="enum" href="../ocl_core/enum.GlTextureTarget.html" title="enum ocl_core::GlTextureTarget">GlTextureTarget</a>, <br> miplevel: <a class="type" href="../ocl/prm/type.cl_GLint.html" title="type ocl::prm::cl_GLint">cl_GLint</a>, <br> texture: <a class="type" href="../ocl/prm/type.cl_GLuint.html" title="type ocl::prm::cl_GLuint">cl_GLuint</a><br>) -> <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a><<a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><QueCtx<'o>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#721-762' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>Image</code> from an existant GL texture2D/3D.</p>
</div><h4 id='method.from_gl_renderbuffer' class="method"><span id='from_gl_renderbuffer.v' class='invisible'><code>pub fn <a href='#method.from_gl_renderbuffer' class='fnname'>from_gl_renderbuffer</a><'o, Q>(<br> que_ctx: Q, <br> flags: <a class="struct" href="../ocl/flags/struct.MemFlags.html" title="struct ocl::flags::MemFlags">MemFlags</a>, <br> image_desc: <a class="struct" href="../ocl/builders/struct.ImageDescriptor.html" title="struct ocl::builders::ImageDescriptor">ImageDescriptor</a>, <br> renderbuffer: <a class="type" href="../ocl/prm/type.cl_GLuint.html" title="type ocl::prm::cl_GLuint">cl_GLuint</a><br>) -> <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a><<a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T>> <span class="where fmt-newline">where<br> Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><QueCtx<'o>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#767-798' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>Image</code> from an existant renderbuffer.</p>
</div><h4 id='method.cmd' class="method"><span id='cmd.v' class='invisible'><code>pub fn <a href='#method.cmd' class='fnname'>cmd</a>(&self) -> <a class="struct" href="../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#806-809' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns an image command builder used to read, write, copy, etc.</p>
<p>Call <code>.enq()</code> to enqueue the command.</p>
<p>See the <a href="struct.ImageCmd">command builder documentation</a>
for more details.</p>
</div><h4 id='method.read' class="method"><span id='read.v' class='invisible'><code>pub fn <a href='#method.read' class='fnname'>read</a><'c, 'd>(&'c self, data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'d mut [T]</a>) -> <a class="struct" href="../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T> <span class="where fmt-newline">where<br> 'd: 'c, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#817-820' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns an image command builder set to read.</p>
<p>Call <code>.enq()</code> to enqueue the command.</p>
<p>See the <a href="struct.ImageCmd#method.read">command builder documentation</a>
for more details.</p>
</div><h4 id='method.write' class="method"><span id='write.v' class='invisible'><code>pub fn <a href='#method.write' class='fnname'>write</a><'c, 'd>(&'c self, data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'d [T]</a>) -> <a class="struct" href="../ocl/builders/struct.ImageCmd.html" title="struct ocl::builders::ImageCmd">ImageCmd</a><'c, T> <span class="where fmt-newline">where<br> 'd: 'c, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#828-831' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns an image command builder set to write.</p>
<p>Call <code>.enq()</code> to enqueue the command.</p>
<p>See the <a href="struct.ImageCmd#method.write">command builder documentation</a>
for more details.</p>
</div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><code>pub unsafe fn <a href='#method.map' class='fnname'>map</a><'c>(&'c self) -> ImageMapCmd<'c, T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#846-849' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a command builder used to map data for reading or writing.</p>
<p>Call <code>.enq()</code> to enqueue the command.</p>
<h2 id="safety" class="section-header"><a href="#safety">Safety</a></h2>
<p>The caller must ensure that only one mapping of a particular memory
region exists at a time.</p>
<p>See the <a href="struct.ImageCmd#method.map">command builder documentation</a>
for more details.</p>
</div><h4 id='method.set_default_queue' class="method"><span id='set_default_queue.v' class='invisible'><code>pub fn <a href='#method.set_default_queue' class='fnname'>set_default_queue</a><'a>(&'a mut self, queue: <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>) -> &'a mut <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#878-882' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Changes the default queue.</p>
<p>Returns a ref for chaining i.e.:</p>
<p><code>image.set_default_queue(queue).write(....);</code></p>
<p>[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.</p>
<p>The new queue must be associated with a valid device.</p>
</div><h4 id='method.default_queue' class="method"><span id='default_queue.v' class='invisible'><code>pub fn <a href='#method.default_queue' class='fnname'>default_queue</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#885-887' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a reference to the default queue.</p>
</div><h4 id='method.dims' class="method"><span id='dims.v' class='invisible'><code>pub fn <a href='#method.dims' class='fnname'>dims</a>(&self) -> &<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#890-892' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns this image's dimensions.</p>
</div><h4 id='method.pixel_count' class="method"><span id='pixel_count.v' class='invisible'><code>pub fn <a href='#method.pixel_count' class='fnname'>pixel_count</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#895-897' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the total number of pixels in this image.</p>
</div><h4 id='method.pixel_element_len' class="method"><span id='pixel_element_len.v' class='invisible'><code>pub fn <a href='#method.pixel_element_len' class='fnname'>pixel_element_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#900-902' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the length of each pixel element.</p>
</div><h4 id='method.element_count' class="method"><span id='element_count.v' class='invisible'><code>pub fn <a href='#method.element_count' class='fnname'>element_count</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#905-907' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the total number of pixel elements in this image. Equivalent to its length.</p>
</div><h4 id='method.info' class="method"><span id='info.v' class='invisible'><code>pub fn <a href='#method.info' class='fnname'>info</a>(&self, info_kind: <a class="enum" href="../ocl/enums/enum.ImageInfo.html" title="enum ocl::enums::ImageInfo">ImageInfo</a>) -> <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a><<a class="enum" href="../ocl/enums/enum.ImageInfoResult.html" title="enum ocl::enums::ImageInfoResult">ImageInfoResult</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#910-916' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Get information about this image.</p>
</div><h4 id='method.mem_info' class="method"><span id='mem_info.v' class='invisible'><code>pub fn <a href='#method.mem_info' class='fnname'>mem_info</a>(&self, info_kind: <a class="enum" href="../ocl/enums/enum.MemInfo.html" title="enum ocl::enums::MemInfo">MemInfo</a>) -> <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a><<a class="enum" href="../ocl/enums/enum.MemInfoResult.html" title="enum ocl::enums::MemInfoResult">MemInfoResult</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#919-925' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns info about this image's memory.</p>
</div><h4 id='method.as_core' class="method"><span id='as_core.v' class='invisible'><code>pub fn <a href='#method.as_core' class='fnname'>as_core</a>(&self) -> &<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#930-932' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a reference to the core pointer wrapper, usable by functions in
the <code>core</code> module.</p>
</div></div>
<h2 id='deref-methods' class='small-section-header'>
Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = <a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a>><a href='#deref-methods' class='anchor'></a>
</h2>
<div class='impl-items'><h4 id='method.as_ptr' class="method"><span id='as_ptr.v' class='invisible'><code>pub fn <a href='#method.as_ptr' class='fnname'>as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../libc/enum.c_void.html" title="enum libc::c_void">c_void</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl_core/types/abs.rs.html#693-695' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a pointer, do not store it.</p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#658' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#658' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#658' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#658' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Display' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T></code><a href='#impl-Display' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#967-973' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#968-972' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Deref' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T></code><a href='#impl-Deref' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#975-981' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.Target' class="type"><span id='Target.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target' class="type">Target</a> = <a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span></h4>
<div class='docblock'><p>The resulting type after dereferencing.</p>
</div><h4 id='method.deref' class="method"><span id='deref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&self) -> &<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#978-980' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Dereferences the value.</p>
</div></div><h3 id='impl-DerefMut' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T></code><a href='#impl-DerefMut' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#983-987' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.deref_mut' class="method"><span id='deref_mut.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html#tymethod.deref_mut' class='fnname'>deref_mut</a>(&mut self) -> &mut <a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#984-986' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Mutably dereferences the value.</p>
</div></div><h3 id='impl-AsMem%3CT%3E' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>> <a class="trait" href="../ocl_core/types/abs/trait.AsMem.html" title="trait ocl_core::types::abs::AsMem">AsMem</a><T> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T></code><a href='#impl-AsMem%3CT%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#989-993' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.as_mem' class="method"><span id='as_mem.v' class='invisible'><code>fn <a href='../ocl_core/types/abs/trait.AsMem.html#tymethod.as_mem' class='fnname'>as_mem</a>(&self) -> &<a class="struct" href="../ocl_core/types/abs/struct.Mem.html" title="struct ocl_core::types::abs::Mem">MemCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#990-992' title='goto source code'>[src]</a></span></h4>
</div><h3 id='impl-MemCmdRw' class='impl'><span class='in-band'><code>impl<'a, T> <a class="trait" href="../ocl_core/types/abs/trait.MemCmdRw.html" title="trait ocl_core::types::abs::MemCmdRw">MemCmdRw</a> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>, </span></code><a href='#impl-MemCmdRw' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#995' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 id='impl-MemCmdRw-1' class='impl'><span class='in-band'><code>impl<'a, T> <a class="trait" href="../ocl_core/types/abs/trait.MemCmdRw.html" title="trait ocl_core::types::abs::MemCmdRw">MemCmdRw</a> for &'a <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>, </span></code><a href='#impl-MemCmdRw-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#996' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 id='impl-MemCmdRw-2' class='impl'><span class='in-band'><code>impl<'a, T> <a class="trait" href="../ocl_core/types/abs/trait.MemCmdRw.html" title="trait ocl_core::types::abs::MemCmdRw">MemCmdRw</a> for &'a mut <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>, </span></code><a href='#impl-MemCmdRw-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#997' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 id='impl-MemCmdAll' class='impl'><span class='in-band'><code>impl<'a, T> <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a> for <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>, </span></code><a href='#impl-MemCmdAll' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#998' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 id='impl-MemCmdAll-1' class='impl'><span class='in-band'><code>impl<'a, T> <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a> for &'a <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>, </span></code><a href='#impl-MemCmdAll-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#999' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 id='impl-MemCmdAll-2' class='impl'><span class='in-band'><code>impl<'a, T> <a class="trait" href="../ocl_core/types/abs/trait.MemCmdAll.html" title="trait ocl_core::types::abs::MemCmdAll">MemCmdAll</a> for &'a mut <a class="struct" href="../ocl/struct.Image.html" title="struct ocl::Image">Image</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>, </span></code><a href='#impl-MemCmdAll-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/image.rs.html#1000' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>⏎</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "ocl";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>