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

Represents the OpenCL image format with its channeltype and order. More...

Collaboration diagram for com.jogamp.opencl.CLImageFormat:

Classes

enum  ChannelOrder
 Specifies the number of channels and the channel layout i.e. More...
 
enum  ChannelType
 Describes the size of the channel data type. More...
 

Public Member Functions

 CLImageFormat (final ChannelOrder order, final ChannelType type)
 
CLImageFormat setImageChannelOrder (final ChannelOrder order)
 
CLImageFormat setImageChannelDataType (final ChannelType type)
 
ChannelOrder getImageChannelOrder ()
 
ChannelType getImageChannelDataType ()
 
CLImageFormatImpl getFormatImpl ()
 Returns the struct accessor for the cl_image_format struct. More...
 
String toString ()
 
boolean equals (final Object obj)
 
int hashCode ()
 

Detailed Description

Represents the OpenCL image format with its channeltype and order.

Author
Michael Bien
See also
CLContext::getSupportedImage2dFormats(com.jogamp.opencl.CLMemory.Mem[])
CLContext::getSupportedImage3dFormats(com.jogamp.opencl.CLMemory.Mem[])

Definition at line 41 of file CLImageFormat.java.

Constructor & Destructor Documentation

◆ CLImageFormat()

com.jogamp.opencl.CLImageFormat.CLImageFormat ( final ChannelOrder  order,
final ChannelType  type 
)

Definition at line 53 of file CLImageFormat.java.

Here is the call graph for this function:

Member Function Documentation

◆ equals()

boolean com.jogamp.opencl.CLImageFormat.equals ( final Object  obj)

Definition at line 90 of file CLImageFormat.java.

Here is the call graph for this function:

◆ getFormatImpl()

CLImageFormatImpl com.jogamp.opencl.CLImageFormat.getFormatImpl ( )

Returns the struct accessor for the cl_image_format struct.

Definition at line 80 of file CLImageFormat.java.

◆ getImageChannelDataType()

ChannelType com.jogamp.opencl.CLImageFormat.getImageChannelDataType ( )

Definition at line 73 of file CLImageFormat.java.

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

◆ getImageChannelOrder()

ChannelOrder com.jogamp.opencl.CLImageFormat.getImageChannelOrder ( )

Definition at line 69 of file CLImageFormat.java.

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

◆ hashCode()

int com.jogamp.opencl.CLImageFormat.hashCode ( )

Definition at line 108 of file CLImageFormat.java.

Here is the call graph for this function:

◆ setImageChannelDataType()

CLImageFormat com.jogamp.opencl.CLImageFormat.setImageChannelDataType ( final ChannelType  type)

Definition at line 64 of file CLImageFormat.java.

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

◆ setImageChannelOrder()

CLImageFormat com.jogamp.opencl.CLImageFormat.setImageChannelOrder ( final ChannelOrder  order)

Definition at line 59 of file CLImageFormat.java.

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

◆ toString()

String com.jogamp.opencl.CLImageFormat.toString ( )

Definition at line 85 of file CLImageFormat.java.

Here is the call graph for this function:

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