Package com.jogamp.opencl

Class CLImage3d<B extends Buffer>

java.lang.Object

com.jogamp.opencl.CLObject

com.jogamp.opencl.CLMemory<B>

com.jogamp.opencl.CLImage<B>

com.jogamp.opencl.CLImage3d<B>

All Implemented Interfaces:

AutoCloseable, CLResource, AutoCloseable

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

Fields

Modifier and Type	Field	Description
int	depth

Fields inherited from class com.jogamp.opencl.CLImage

format, height, width

Fields inherited from class com.jogamp.opencl.CLMemory

clCapacity, elementSize, FLAGS, size

Fields inherited from class com.jogamp.opencl.CLObject

context, ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
<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.
int	getDepth()	Returns the depth of this image in pixels.
int	getSlicePitch()	Returns the size in bytes of a 2D slice of this 3D image.
boolean	isReleased()	Returns true if CLResource.release() has been called.
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, initCLCapacity, isHostPointerFlag, isReadOnly, isReadWrite, isWriteOnly, registerDestructorCallback, release, use

Methods inherited from class com.jogamp.opencl.CLObject

getContext, getID, getPlatform

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

depth

public final int depth

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, satisfying AutoCloseable. Might be remove as soon we have extension methods, but shall validate with Java 1.5 specs.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface AutoCloseable

See Also:

AutoCloseable

isReleased

public boolean isReleased()

Description copied from interface: CLResource

Returns true if CLResource.release() has been called.

Specified by:

isReleased in interface CLResource