com.jogamp.opencl
Class CLImage3d<B extends Buffer>

java.lang.Object
  extended by com.jogamp.opencl.CLMemory<B>
      extended by com.jogamp.opencl.CLImage<B>
          extended by com.jogamp.opencl.CLImage3d<B>
All Implemented Interfaces:
AutoCloseable, CLResource
Direct Known Subclasses:
CLGLTexture3d

public class CLImage3d<B extends Buffer>
extends CLImage<B>

Author:
Michael Bien

Nested Class Summary
 
Nested classes/interfaces inherited from class com.jogamp.opencl.CLImage
CLImage.CLImageInfoAccessor
 
Nested classes/interfaces inherited from class com.jogamp.opencl.CLMemory
CLMemory.GLObjectType, CLMemory.Map, CLMemory.Mem
 
Field Summary
protected  CL cl
           
protected  CLContext context
           
 int depth
           
 long ID
          The OpenCL object handle.
 
Fields inherited from class com.jogamp.opencl.CLImage
format, height, width
 
Fields inherited from class com.jogamp.opencl.CLMemory
FLAGS, size
 
Constructor Summary
protected CLImage3d(CLContext context, B directBuffer, CLImageFormat format, CLImage.CLImageInfoAccessor accessor, int width, int height, int depth, long id, int flags)
           
 
Method Summary
<T extends Buffer>
CLImage3d<T>
cloneWith(T directBuffer)
          Returns a new instance of CLMemory pointing to the same CLResource but using a different Buffer.
 void close()
          Deprecated. This method is not intended to be called from client code.
 CLContext getContext()
          Returns the context for this OpenCL object.
 int getDepth()
          Returns the depth of this image in pixels.
 long getID()
          Returns the OpenCL object handle
 CLPlatform getPlatform()
          Returns the platform for this OpenCL object.
 int getSlicePitch()
          Returns the size in bytes of a 2D slice of this 3D image.
 String toString()
           
 
Methods inherited from class com.jogamp.opencl.CLImage
createUninitializedImageFormat, getElementSize, getFormat, getHeight, getRowPitch, getWidth
 
Methods inherited from class com.jogamp.opencl.CLMemory
equals, getBuffer, getCL, getCLCapacity, getCLSize, getConfig, getMapCount, getNIOCapacity, getNIOSize, getSizeImpl, hashCode, isHostPointerFlag, isReadOnly, isReadWrite, isWriteOnly, registerDestructorCallback, release, sizeOfBufferElem, use
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

depth

public final int depth

ID

public final long ID
The OpenCL object handle.


context

protected CLContext context

cl

protected final CL cl
Constructor Detail

CLImage3d

protected CLImage3d(CLContext context,
                    B directBuffer,
                    CLImageFormat format,
                    CLImage.CLImageInfoAccessor accessor,
                    int width,
                    int height,
                    int depth,
                    long id,
                    int flags)
Method Detail

cloneWith

public <T extends Buffer> CLImage3d<T> cloneWith(T directBuffer)
Description copied from class: CLMemory
Returns a new instance of CLMemory pointing to the same CLResource but using a different Buffer.

Specified by:
cloneWith in class CLMemory<B extends Buffer>

getSlicePitch

public int getSlicePitch()
Returns the size in bytes of a 2D slice of this 3D image.


getDepth

public int getDepth()
Returns the depth of this image in pixels.


toString

public String toString()
Overrides:
toString in class CLMemory<B extends Buffer>

close

@Deprecated
public final void close()
Deprecated. This method is not intended to be called from client code.

Implementation detail. TODO remove as soon we have extension methods.

Specified by:
close in interface AutoCloseable
See Also:
AutoCloseable

getContext

public CLContext getContext()
Returns the context for this OpenCL object.


getPlatform

public CLPlatform getPlatform()
Returns the platform for this OpenCL object.


getID

public long getID()
Returns the OpenCL object handle