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

Struct accessor for cl_image_format. More...

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

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 CLImageFormatImpl setImageChannelOrder (int src)
 Setter for native field imageChannelOrder, being a struct owned IntType. More...
 
final int getImageChannelOrder ()
 Getter for native field imageChannelOrder, being a struct owned IntType. More...
 
final CLImageFormatImpl setImageChannelDataType (int src)
 Setter for native field imageChannelDataType, being a struct owned IntType. More...
 
final int getImageChannelDataType ()
 Getter for native field imageChannelDataType, 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 CLImageFormatImpl create ()
 Returns a new instance with all bytes set to zero. More...
 
static CLImageFormatImpl create (java.nio.ByteBuffer buf)
 Returns a new instance using the given ByteBuffer having at least {#link size()} bytes capacity. More...
 
static CLImageFormatImpl 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_format.

Author
Michael Bien, GlueGen, et al.

Definition at line 33 of file CLImageFormatImpl.java.

Member Function Documentation

◆ create() [1/2]

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

Returns a new instance with all bytes set to zero.

Definition at line 57 of file CLImageFormatImpl.java.

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

◆ create() [2/2]

static CLImageFormatImpl com.jogamp.opencl.llb.impl.CLImageFormatImpl.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 62 of file CLImageFormatImpl.java.

◆ derefPointer()

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

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

Definition at line 67 of file CLImageFormatImpl.java.

Here is the call graph for this function:

◆ getBuffer()

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

Return the underlying native direct ByteBuffer.

Definition at line 77 of file CLImageFormatImpl.java.

Here is the caller graph for this function:

◆ getDirectBufferAddress()

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

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

Definition at line 82 of file CLImageFormatImpl.java.

◆ getImageChannelDataType()

final int com.jogamp.opencl.llb.impl.CLImageFormatImpl.getImageChannelDataType ( )

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

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

Definition at line 124 of file CLImageFormatImpl.java.

Here is the caller graph for this function:

◆ getImageChannelOrder()

final int com.jogamp.opencl.llb.impl.CLImageFormatImpl.getImageChannelOrder ( )

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

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

Definition at line 103 of file CLImageFormatImpl.java.

Here is the caller graph for this function:

◆ setImageChannelDataType()

final CLImageFormatImpl com.jogamp.opencl.llb.impl.CLImageFormatImpl.setImageChannelDataType ( int  src)

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

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

Definition at line 113 of file CLImageFormatImpl.java.

Here is the caller graph for this function:

◆ setImageChannelOrder()

final CLImageFormatImpl com.jogamp.opencl.llb.impl.CLImageFormatImpl.setImageChannelOrder ( int  src)

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

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

Definition at line 92 of file CLImageFormatImpl.java.

Here is the caller graph for this function:

◆ size()

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

Returns the aligned total size of a native instance.

Definition at line 52 of file CLImageFormatImpl.java.

Here is the caller graph for this function:

◆ usesNativeCode()

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

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

Definition at line 47 of file CLImageFormatImpl.java.


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