JOCL v2.6.0-rc-20250722
JOCL, OpenCL® API Binding for Java™ (public API).
com.jogamp.opencl.CLImage< B extends Buffer > Class Template Referenceabstract
Inheritance diagram for com.jogamp.opencl.CLImage< B extends Buffer >:
Collaboration diagram for com.jogamp.opencl.CLImage< B extends Buffer >:

Classes

class  CLImageInfoAccessor
 

Public Member Functions

CLImageFormat getFormat ()
 Returns the image format descriptor specified when image was created. More...
 
int getElementSize ()
 Returns the size of each element of the image memory object given by image. More...
 
int getRowPitch ()
 Returns the size in bytes of a row of elements of the image object given by image. More...
 
int getWidth ()
 Returns width of this image in pixels. More...
 
int getHeight ()
 Returns the height of this image in pixels. More...
 
- Public Member Functions inherited from com.jogamp.opencl.CLMemory< B >
void registerDestructorCallback (final CLMemObjectListener listener)
 Registers a callback which will be called by the OpenCL implementation when the memory object is released. More...
 
abstract< T extends Buffer > CLMemory< T > cloneWith (T directBuffer)
 Returns a new instance of CLMemory pointing to the same CLResource but using a different Buffer. More...
 
CLMemory< B > use (final B buffer)
 
getBuffer ()
 Returns the optional NIO buffer for this memory object. More...
 
int getNIOCapacity ()
 Returns the capacity of the wrapped direct buffer or 0 if no buffer available. More...
 
int getNIOSize ()
 Returns the size of the wrapped direct buffer in byte or 0 if no buffer available. More...
 
long getCLSize ()
 Returns the size of the allocated OpenCL memory in bytes. More...
 
int getCLCapacity ()
 Returns the size in buffer elements of this memory object. More...
 
int getElementSize ()
 Returns the size in bytes of a single buffer element. More...
 
EnumSet< MemgetConfig ()
 Returns the configuration of this memory object. More...
 
int getMapCount ()
 Returns the number of buffer mappings. More...
 
boolean isReadOnly ()
 Returns true if this memory object was created with the Mem#READ_ONLY flag. More...
 
boolean isWriteOnly ()
 Returns true if this memory object was created with the Mem#WRITE_ONLY flag. More...
 
boolean isReadWrite ()
 Returns true if this memory object was created with the Mem#READ_WRITE flag. More...
 
void release ()
 Releases the OpenCL resource. More...
 
boolean equals (final Object obj)
 Returns the OpenGL buffer type of this shared buffer. More...
 
int hashCode ()
 
String toString ()
 

Public Attributes

final int width
 
final int height
 

Protected Member Functions

 CLImage (final CLContext context, final B directBuffer, final CLImageFormat format, final int width, final int height, final long id, final int flags)
 
 CLImage (final CLContext context, final B directBuffer, final CLImageFormat format, final CLImageInfoAccessor accessor, final int width, final int height, final long id, final int flags)
 
- Protected Member Functions inherited from com.jogamp.opencl.CLMemory< B >
 CLMemory (final CLContext context, final B directBuffer, final long size, final long id, final int flags)
 
final void initCLCapacity ()
 

Static Protected Member Functions

static CLImageFormat createUninitializedImageFormat ()
 
- Static Protected Member Functions inherited from com.jogamp.opencl.CLMemory< B >
static boolean isHostPointerFlag (final int flags)
 Returns true if a host pointer must be specified on mem object creation. More...
 
static long getSizeImpl (final CLContext context, final long id)
 
static CL getCL (final CLContext context)
 

Protected Attributes

CLImageFormat format
 
- Protected Attributes inherited from com.jogamp.opencl.CLMemory< B >
final int FLAGS
 
long size
 
int elementSize
 
int clCapacity
 

Detailed Description

Author
Michael Bien, et al.

Definition at line 42 of file CLImage.java.

Constructor & Destructor Documentation

◆ CLImage() [1/2]

com.jogamp.opencl.CLImage< B extends Buffer >.CLImage ( final CLContext  context,
final B  directBuffer,
final CLImageFormat  format,
final int  width,
final int  height,
final long  id,
final int  flags 
)
protected

Definition at line 51 of file CLImage.java.

◆ CLImage() [2/2]

com.jogamp.opencl.CLImage< B extends Buffer >.CLImage ( final CLContext  context,
final B  directBuffer,
final CLImageFormat  format,
final CLImageInfoAccessor  accessor,
final int  width,
final int  height,
final long  id,
final int  flags 
)
protected

Definition at line 55 of file CLImage.java.

Here is the call graph for this function:

Member Function Documentation

◆ createUninitializedImageFormat()

static CLImageFormat com.jogamp.opencl.CLImage< B extends Buffer >.createUninitializedImageFormat ( )
staticprotected

Definition at line 67 of file CLImage.java.

◆ getElementSize()

int com.jogamp.opencl.CLImage< B extends Buffer >.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.

Definition at line 83 of file CLImage.java.

Here is the call graph for this function:

◆ getFormat()

CLImageFormat com.jogamp.opencl.CLImage< B extends Buffer >.getFormat ( )

Returns the image format descriptor specified when image was created.

Definition at line 74 of file CLImage.java.

◆ getHeight()

int com.jogamp.opencl.CLImage< B extends Buffer >.getHeight ( )

Returns the height of this image in pixels.

Definition at line 104 of file CLImage.java.

◆ getRowPitch()

int com.jogamp.opencl.CLImage< B extends Buffer >.getRowPitch ( )

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

Definition at line 90 of file CLImage.java.

Here is the call graph for this function:

◆ getWidth()

int com.jogamp.opencl.CLImage< B extends Buffer >.getWidth ( )

Returns width of this image in pixels.

Definition at line 97 of file CLImage.java.

Member Data Documentation

◆ format

CLImageFormat com.jogamp.opencl.CLImage< B extends Buffer >.format
protected

Definition at line 44 of file CLImage.java.

◆ height

final int com.jogamp.opencl.CLImage< B extends Buffer >.height

Definition at line 49 of file CLImage.java.

◆ width

final int com.jogamp.opencl.CLImage< B extends Buffer >.width

Definition at line 48 of file CLImage.java.


The documentation for this class was generated from the following file: