JOCL v2.6.0-rc-20250722
JOCL, OpenCL® API Binding for Java™ (public API).
com.jogamp.opencl.llb.impl.CLImageDescImpl Class Reference

Struct accessor for cl_image_desc. More...

Collaboration diagram for com.jogamp.opencl.llb.impl.CLImageDescImpl:

Public Member Functions

final java.nio.ByteBuffer getBuffer ()
 Return the underlying native direct ByteBuffer. More...
 
final long getDirectBufferAddress ()
 Returns the native address of the underlying native ByteBuffer getBuffer(). More...
 
final CLImageDescImpl setImageType (int src)
 Setter for native field imageType, being a struct owned IntType. More...
 
final int getImageType ()
 Getter for native field imageType, being a struct owned IntType. More...
 
final CLImageDescImpl setImageWidth (long src)
 Setter for native field imageWidth, being a struct owned IntType. More...
 
final long getImageWidth ()
 Getter for native field imageWidth, being a struct owned IntType. More...
 
final CLImageDescImpl setImageHeight (long src)
 Setter for native field imageHeight, being a struct owned IntType. More...
 
final long getImageHeight ()
 Getter for native field imageHeight, being a struct owned IntType. More...
 
final CLImageDescImpl setImageDepth (long src)
 Setter for native field imageDepth, being a struct owned IntType. More...
 
final long getImageDepth ()
 Getter for native field imageDepth, being a struct owned IntType. More...
 
final CLImageDescImpl setImageArraySize (long src)
 Setter for native field imageArraySize, being a struct owned IntType. More...
 
final long getImageArraySize ()
 Getter for native field imageArraySize, being a struct owned IntType. More...
 
final CLImageDescImpl setImageRowPitch (long src)
 Setter for native field imageRowPitch, being a struct owned IntType. More...
 
final long getImageRowPitch ()
 Getter for native field imageRowPitch, being a struct owned IntType. More...
 
final CLImageDescImpl setImageSlicePitch (long src)
 Setter for native field imageSlicePitch, being a struct owned IntType. More...
 
final long getImageSlicePitch ()
 Getter for native field imageSlicePitch, being a struct owned IntType. More...
 
final CLImageDescImpl setNumMipLevels (int src)
 Setter for native field numMipLevels, being a struct owned IntType. More...
 
final int getNumMipLevels ()
 Getter for native field numMipLevels, being a struct owned IntType. More...
 
final CLImageDescImpl setNumSamples (int src)
 Setter for native field numSamples, being a struct owned IntType. More...
 
final int getNumSamples ()
 Getter for native field numSamples, being a struct owned IntType. More...
 

Static Public Member Functions

static boolean usesNativeCode ()
 Returns true if this generated implementation uses native code, otherwise false. More...
 
static int size ()
 Returns the aligned total size of a native instance. More...
 
static CLImageDescImpl create ()
 Returns a new instance with all bytes set to zero. More...
 
static CLImageDescImpl create (java.nio.ByteBuffer buf)
 Returns a new instance using the given ByteBuffer having at least {#link size()} bytes capacity. More...
 
static CLImageDescImpl derefPointer (final long addr)
 Returns new instance dereferencing ByteBuffer at given native address addr with size size(). More...
 

Detailed Description

Struct accessor for cl_image_desc.

Author
Wade Walker, GlueGen, et al.

Definition at line 33 of file CLImageDescImpl.java.

Member Function Documentation

◆ create() [1/2]

static CLImageDescImpl com.jogamp.opencl.llb.impl.CLImageDescImpl.create ( )
static

Returns a new instance with all bytes set to zero.

Definition at line 71 of file CLImageDescImpl.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ create() [2/2]

static CLImageDescImpl com.jogamp.opencl.llb.impl.CLImageDescImpl.create ( java.nio.ByteBuffer  buf)
static

Returns a new instance using the given ByteBuffer having at least {#link size()} bytes capacity.

The ByteBuffer will be ByteBuffer#rewind() and native-order set.

Definition at line 76 of file CLImageDescImpl.java.

◆ derefPointer()

static CLImageDescImpl com.jogamp.opencl.llb.impl.CLImageDescImpl.derefPointer ( final long  addr)
static

Returns new instance dereferencing ByteBuffer at given native address addr with size size().

Definition at line 81 of file CLImageDescImpl.java.

Here is the call graph for this function:

◆ getBuffer()

final java.nio.ByteBuffer com.jogamp.opencl.llb.impl.CLImageDescImpl.getBuffer ( )

Return the underlying native direct ByteBuffer.

Definition at line 91 of file CLImageDescImpl.java.

Here is the caller graph for this function:

◆ getDirectBufferAddress()

final long com.jogamp.opencl.llb.impl.CLImageDescImpl.getDirectBufferAddress ( )

Returns the native address of the underlying native ByteBuffer getBuffer().

Definition at line 96 of file CLImageDescImpl.java.

◆ getImageArraySize()

final long com.jogamp.opencl.llb.impl.CLImageDescImpl.getImageArraySize ( )

Getter for native field imageArraySize, being a struct owned IntType.

Native Field Signature (IntType) typedef 'size_t', size[fixed false, lnx64 8], const[false], is[primitive, int]

Definition at line 201 of file CLImageDescImpl.java.

◆ getImageDepth()

final long com.jogamp.opencl.llb.impl.CLImageDescImpl.getImageDepth ( )

Getter for native field imageDepth, being a struct owned IntType.

Native Field Signature (IntType) typedef 'size_t', size[fixed false, lnx64 8], const[false], is[primitive, int]

Definition at line 180 of file CLImageDescImpl.java.

◆ getImageHeight()

final long com.jogamp.opencl.llb.impl.CLImageDescImpl.getImageHeight ( )

Getter for native field imageHeight, being a struct owned IntType.

Native Field Signature (IntType) typedef 'size_t', size[fixed false, lnx64 8], const[false], is[primitive, int]

Definition at line 159 of file CLImageDescImpl.java.

◆ getImageRowPitch()

final long com.jogamp.opencl.llb.impl.CLImageDescImpl.getImageRowPitch ( )

Getter for native field imageRowPitch, being a struct owned IntType.

Native Field Signature (IntType) typedef 'size_t', size[fixed false, lnx64 8], const[false], is[primitive, int]

Definition at line 222 of file CLImageDescImpl.java.

◆ getImageSlicePitch()

final long com.jogamp.opencl.llb.impl.CLImageDescImpl.getImageSlicePitch ( )

Getter for native field imageSlicePitch, being a struct owned IntType.

Native Field Signature (IntType) typedef 'size_t', size[fixed false, lnx64 8], const[false], is[primitive, int]

Definition at line 243 of file CLImageDescImpl.java.

◆ getImageType()

final int com.jogamp.opencl.llb.impl.CLImageDescImpl.getImageType ( )

Getter for native field imageType, being a struct owned IntType.

Native Field Signature (IntType) typedef 'cl_mem_object_type', size[fixed true, lnx64 4], const[false], is[primitive, int]

Definition at line 117 of file CLImageDescImpl.java.

◆ getImageWidth()

final long com.jogamp.opencl.llb.impl.CLImageDescImpl.getImageWidth ( )

Getter for native field imageWidth, being a struct owned IntType.

Native Field Signature (IntType) typedef 'size_t', size[fixed false, lnx64 8], const[false], is[primitive, int]

Definition at line 138 of file CLImageDescImpl.java.

◆ getNumMipLevels()

final int com.jogamp.opencl.llb.impl.CLImageDescImpl.getNumMipLevels ( )

Getter for native field numMipLevels, being a struct owned IntType.

Native Field Signature (IntType) typedef 'cl_uint', size[fixed true, lnx64 4], const[false], is[primitive, int]

Definition at line 264 of file CLImageDescImpl.java.

◆ getNumSamples()

final int com.jogamp.opencl.llb.impl.CLImageDescImpl.getNumSamples ( )

Getter for native field numSamples, being a struct owned IntType.

Native Field Signature (IntType) typedef 'cl_uint', size[fixed true, lnx64 4], const[false], is[primitive, int]

Definition at line 285 of file CLImageDescImpl.java.

◆ setImageArraySize()

final CLImageDescImpl com.jogamp.opencl.llb.impl.CLImageDescImpl.setImageArraySize ( long  src)

Setter for native field imageArraySize, being a struct owned IntType.

Native Field Signature (IntType) typedef 'size_t', size[fixed false, lnx64 8], const[false], is[primitive, int]

Definition at line 190 of file CLImageDescImpl.java.

◆ setImageDepth()

final CLImageDescImpl com.jogamp.opencl.llb.impl.CLImageDescImpl.setImageDepth ( long  src)

Setter for native field imageDepth, being a struct owned IntType.

Native Field Signature (IntType) typedef 'size_t', size[fixed false, lnx64 8], const[false], is[primitive, int]

Definition at line 169 of file CLImageDescImpl.java.

◆ setImageHeight()

final CLImageDescImpl com.jogamp.opencl.llb.impl.CLImageDescImpl.setImageHeight ( long  src)

Setter for native field imageHeight, being a struct owned IntType.

Native Field Signature (IntType) typedef 'size_t', size[fixed false, lnx64 8], const[false], is[primitive, int]

Definition at line 148 of file CLImageDescImpl.java.

◆ setImageRowPitch()

final CLImageDescImpl com.jogamp.opencl.llb.impl.CLImageDescImpl.setImageRowPitch ( long  src)

Setter for native field imageRowPitch, being a struct owned IntType.

Native Field Signature (IntType) typedef 'size_t', size[fixed false, lnx64 8], const[false], is[primitive, int]

Definition at line 211 of file CLImageDescImpl.java.

◆ setImageSlicePitch()

final CLImageDescImpl com.jogamp.opencl.llb.impl.CLImageDescImpl.setImageSlicePitch ( long  src)

Setter for native field imageSlicePitch, being a struct owned IntType.

Native Field Signature (IntType) typedef 'size_t', size[fixed false, lnx64 8], const[false], is[primitive, int]

Definition at line 232 of file CLImageDescImpl.java.

◆ setImageType()

final CLImageDescImpl com.jogamp.opencl.llb.impl.CLImageDescImpl.setImageType ( int  src)

Setter for native field imageType, being a struct owned IntType.

Native Field Signature (IntType) typedef 'cl_mem_object_type', size[fixed true, lnx64 4], const[false], is[primitive, int]

Definition at line 106 of file CLImageDescImpl.java.

◆ setImageWidth()

final CLImageDescImpl com.jogamp.opencl.llb.impl.CLImageDescImpl.setImageWidth ( long  src)

Setter for native field imageWidth, being a struct owned IntType.

Native Field Signature (IntType) typedef 'size_t', size[fixed false, lnx64 8], const[false], is[primitive, int]

Definition at line 127 of file CLImageDescImpl.java.

◆ setNumMipLevels()

final CLImageDescImpl com.jogamp.opencl.llb.impl.CLImageDescImpl.setNumMipLevels ( int  src)

Setter for native field numMipLevels, being a struct owned IntType.

Native Field Signature (IntType) typedef 'cl_uint', size[fixed true, lnx64 4], const[false], is[primitive, int]

Definition at line 253 of file CLImageDescImpl.java.

◆ setNumSamples()

final CLImageDescImpl com.jogamp.opencl.llb.impl.CLImageDescImpl.setNumSamples ( int  src)

Setter for native field numSamples, being a struct owned IntType.

Native Field Signature (IntType) typedef 'cl_uint', size[fixed true, lnx64 4], const[false], is[primitive, int]

Definition at line 274 of file CLImageDescImpl.java.

◆ size()

static int com.jogamp.opencl.llb.impl.CLImageDescImpl.size ( )
static

Returns the aligned total size of a native instance.

Definition at line 66 of file CLImageDescImpl.java.

Here is the caller graph for this function:

◆ usesNativeCode()

static boolean com.jogamp.opencl.llb.impl.CLImageDescImpl.usesNativeCode ( )
static

Returns true if this generated implementation uses native code, otherwise false.

Definition at line 61 of file CLImageDescImpl.java.


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