Top Inners Fields Constructors Methods
com.jogamp.opencl

public abstract Class CLImage<B extends Buffer>

extends CLMemory<B extends Buffer>
Class Inheritance
Known Direct Subclasses
com.jogamp.opencl.CLImage2d, com.jogamp.opencl.CLImage3d
Imports
com.jogamp.common.nio.PointerBuffer, com.jogamp.opencl.impl.CLTLInfoAccessor, com.jogamp.opencl.llb.CLImageBinding, java.nio.Buffer
Author
Michael Bien, et al.

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static class
CLImage.CLImageInfoAccessor

Field Summary

Modifier and TypeField and Description
protected CLImageFormat
format

public final int
height

pack-priv final CLTLInfoAccessor
imageInfo

public final int
width

Inherited from com.jogamp.opencl.CLMemory:
bufferclCapacityelementSizeFLAGSsize

Constructor Summary

AccessConstructor and Description
protected
CLImage(final CLContext context, final B directBuffer, final CLImageFormat format, final int width, final int height, final long id, final int flags)

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

Method Summary

Modifier and TypeMethod and Description
private static CLImage.CLImageInfoAccessor
createAccessor(final CLContext context, final long id)

protected static CLImageFormat
createUninitializedImageFormat()

public int
getElementSize()

Overrides com.jogamp.opencl.CLMemory.getElementSize.

Returns the size of each element of the image memory object given by image.
public CLImageFormat
getFormat()

Returns the image format descriptor specified when image was created.

public int
getHeight()

Returns the height of this image in pixels.

public int
getRowPitch()

Returns the size in bytes of a row of elements of the image object given by image.

public int
getWidth()

Returns width of this image in pixels.

Inherited from com.jogamp.opencl.CLMemory:
cloneWithequalsgetBuffergetCLgetCLCapacitygetCLSizegetConfiggetMapCountgetNIOCapacitygetNIOSizegetSizeImplhashCodeinitCLCapacityisHostPointerFlagisReadOnlyisReadWriteisWriteOnlyregisterDestructorCallbackreleasetoStringuse

Field Detail

formatback to summary
protected CLImageFormat format
heightback to summary
public final int height
imageInfoback to summary
pack-priv final CLTLInfoAccessor imageInfo
widthback to summary
public final int width

Constructor Detail

CLImageback to summary
protected CLImage(final CLContext context, final B directBuffer, final CLImageFormat format, final int width, final int height, final long id, final int flags)
CLImageback to summary
protected CLImage(final CLContext context, final B directBuffer, final CLImageFormat format, final CLImage.CLImageInfoAccessor accessor, final int width, final int height, final long id, final int flags)

Method Detail

createAccessorback to summary
private static CLImage.CLImageInfoAccessor createAccessor(final CLContext context, final long id)
createUninitializedImageFormatback to summary
protected static CLImageFormat createUninitializedImageFormat()
getElementSizeback to summary
public int getElementSize()

Overrides com.jogamp.opencl.CLMemory.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 in CLImageFormat descriptor.

Annotations
@Override
getFormatback to summary
public CLImageFormat getFormat()

Returns the image format descriptor specified when image was created.

getHeightback to summary
public int getHeight()

Returns the height of this image in pixels.

getRowPitchback to summary
public int getRowPitch()

Returns the size in bytes of a row of elements of the image object given by image.

getWidthback to summary
public int getWidth()

Returns width of this image in pixels.

com.jogamp.opencl back to summary

protected final Class CLImage.CLImageInfoAccessor

extends CLTLInfoAccessor
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final CLImageBinding
cl

private final long
id

Inherited from com.jogamp.opencl.impl.CLTLInfoAccessor:
localBBlocalNSB

Constructor Summary

AccessConstructor and Description
public
CLImageInfoAccessor(final CLImageBinding cl, final long id)

Method Summary

Modifier and TypeMethod and Description
public int
getInfo(final int name, final long valueSize, final Buffer value, final PointerBuffer valueSizeRet)

Implements abstract com.jogamp.opencl.impl.CLTLInfoAccessor.getInfo.

Inherited from com.jogamp.opencl.impl.CLTLInfoAccessor:
getBBgetIntsgetLonggetNSBgetStringgetUInt32Long

Field Detail

clback to summary
private final CLImageBinding cl
idback to summary
private final long id

Constructor Detail

CLImageInfoAccessorback to summary
public CLImageInfoAccessor(final CLImageBinding cl, final long id)

Method Detail

getInfoback to summary
public int getInfo(final int name, final long valueSize, final Buffer value, final PointerBuffer valueSizeRet)

Implements abstract com.jogamp.opencl.impl.CLTLInfoAccessor.getInfo.

Annotations
@Override