Package com.jogamp.opencl
Class CLImage<B extends Buffer>
- java.lang.Object
-
- com.jogamp.opencl.CLObject
-
- com.jogamp.opencl.CLMemory<B>
-
- com.jogamp.opencl.CLImage<B>
-
- All Implemented Interfaces:
AutoCloseable,CLResource
public abstract class CLImage<B extends Buffer> extends CLMemory<B>
- Author:
- Michael Bien, et al.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static classCLImage.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 protected CLImageFormatformatintheightintwidth-
Fields inherited from class com.jogamp.opencl.CLMemory
clCapacity, elementSize, FLAGS, size
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedCLImage(CLContext context, B directBuffer, CLImageFormat format, int width, int height, long id, int flags)protectedCLImage(CLContext context, B directBuffer, CLImageFormat format, CLImage.CLImageInfoAccessor accessor, int width, int height, long id, int flags)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidclose()Deprecated.This method is not intended to be called from client code.protected static CLImageFormatcreateUninitializedImageFormat()intgetElementSize()Returns the size of each element of the image memory object given by image.CLImageFormatgetFormat()Returns the image format descriptor specified when image was created.intgetHeight()Returns the height of this image in pixels.intgetRowPitch()Returns the size in bytes of a row of elements of the image object given by image.intgetWidth()Returns width of this image in pixels.booleanisReleased()Returns true ifCLResource.release()has been called.-
Methods inherited from class com.jogamp.opencl.CLMemory
cloneWith, equals, getBuffer, getCL, getCLCapacity, getCLSize, getConfig, getMapCount, getNIOCapacity, getNIOSize, getSizeImpl, hashCode, initCLCapacity, isHostPointerFlag, isReadOnly, isReadWrite, isWriteOnly, registerDestructorCallback, release, toString, use
-
Methods inherited from class com.jogamp.opencl.CLObject
getContext, getID, getPlatform
-
-
-
-
Field Detail
-
format
protected CLImageFormat format
-
width
public final int width
-
height
public final int height
-
-
Constructor Detail
-
CLImage
protected CLImage(CLContext context, B directBuffer, CLImageFormat format, int width, int height, long id, int flags)
-
CLImage
protected CLImage(CLContext context, B directBuffer, CLImageFormat format, CLImage.CLImageInfoAccessor accessor, int width, int height, long id, int flags)
-
-
Method Detail
-
createUninitializedImageFormat
protected static CLImageFormat createUninitializedImageFormat()
-
getFormat
public CLImageFormat getFormat()
Returns the image format descriptor specified when image was created.
-
getElementSize
public int getElementSize()
Returns the size of each element of the image memory object given by image. An element is made up of n channels. The value of n is given inCLImageFormatdescriptor.- Overrides:
getElementSizein classCLMemory<B extends Buffer>
-
getRowPitch
public int getRowPitch()
Returns the size in bytes of a row of elements of the image object given by image.
-
getWidth
public int getWidth()
Returns width of this image in pixels.
-
getHeight
public int getHeight()
Returns the height of this image in pixels.
-
close
@Deprecated public final void close()
Deprecated.This method is not intended to be called from client code.Implementation detail, satisfyingAutoCloseable. Might be remove as soon we have extension methods, but shall validate with Java 1.5 specs.- Specified by:
closein interfaceAutoCloseable- See Also:
AutoCloseable
-
isReleased
public boolean isReleased()
Description copied from interface:CLResourceReturns true ifCLResource.release()has been called.- Specified by:
isReleasedin interfaceCLResource
-
-