CLImageFormat (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.opencl.CLImageFormat

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class CLImageFormat
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
The image format descriptor struct.
Member documentation
- image_channel_order – specifies the number of channels and the channel layout i.e. the memory layout in which channels are stored in the image
- image_channel_data_type – describes the size of the channel data type. The number of bits per element determined by the image_channel_data_type and image_channel_order must be a power of two.
Layout
```
 struct cl_image_format {
     cl_channel_order image_channel_order;
     cl_channel_type image_channel_data_type;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CLImageFormat.Buffer
An array of CLImageFormat structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CLImageFormat.Buffer` An array of `CLImageFormat` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`IMAGE_CHANNEL_DATA_TYPE` The struct member offsets.
`static int`	`IMAGE_CHANNEL_ORDER` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

CLImageFormat(java.nio.ByteBuffer container)
Creates a CLImageFormat instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`CLImageFormat(java.nio.ByteBuffer container)` Creates a `CLImageFormat` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CLImageFormat`	`calloc()` Returns a new `CLImageFormat` instance allocated with `memCalloc`.
`static CLImageFormat.Buffer`	`calloc(int capacity)` Returns a new `CLImageFormat.Buffer` instance allocated with `memCalloc`.
`static CLImageFormat`	`callocStack()` Returns a new `CLImageFormat` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CLImageFormat.Buffer`	`callocStack(int capacity)` Returns a new `CLImageFormat.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CLImageFormat.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CLImageFormat.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CLImageFormat`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CLImageFormat` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CLImageFormat`	`create()` Returns a new `CLImageFormat` instance allocated with `BufferUtils`.
`static CLImageFormat.Buffer`	`create(int capacity)` Returns a new `CLImageFormat.Buffer` instance allocated with `BufferUtils`.
`static CLImageFormat`	`create(long address)` Returns a new `CLImageFormat` instance for the specified memory address.
`static CLImageFormat.Buffer`	`create(long address, int capacity)` Create a `CLImageFormat.Buffer` instance at the specified memory.
`static CLImageFormat`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static CLImageFormat.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`image_channel_data_type()` Returns the value of the `image_channel_data_type` field.
`CLImageFormat`	`image_channel_data_type(int value)` Sets the specified value to the `image_channel_data_type` field.
`int`	`image_channel_order()` Returns the value of the `image_channel_order` field.
`CLImageFormat`	`image_channel_order(int value)` Sets the specified value to the `image_channel_order` field.
`static CLImageFormat`	`malloc()` Returns a new `CLImageFormat` instance allocated with `memAlloc`.
`static CLImageFormat.Buffer`	`malloc(int capacity)` Returns a new `CLImageFormat.Buffer` instance allocated with `memAlloc`.
`static CLImageFormat`	`mallocStack()` Returns a new `CLImageFormat` instance allocated on the thread-local `MemoryStack`.
`static CLImageFormat.Buffer`	`mallocStack(int capacity)` Returns a new `CLImageFormat.Buffer` instance allocated on the thread-local `MemoryStack`.
`static CLImageFormat.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CLImageFormat.Buffer` instance allocated on the specified `MemoryStack`.
`static CLImageFormat`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CLImageFormat` instance allocated on the specified `MemoryStack`.
`static int`	`nimage_channel_data_type(long struct)` Unsafe version of `image_channel_data_type()`.
`static void`	`nimage_channel_data_type(long struct, int value)` Unsafe version of `image_channel_data_type`.
`static int`	`nimage_channel_order(long struct)` Unsafe version of `image_channel_order()`.
`static void`	`nimage_channel_order(long struct, int value)` Unsafe version of `image_channel_order`.
`CLImageFormat`	`set(CLImageFormat src)` Copies the specified struct data to this struct.
`CLImageFormat`	`set(int image_channel_order, int image_channel_data_type)` Initializes this struct with the specified values.
`int`	`sizeof()`

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - IMAGE_CHANNEL_ORDER
```
public static final int IMAGE_CHANNEL_ORDER
```
    The struct member offsets.
  - IMAGE_CHANNEL_DATA_TYPE
```
public static final int IMAGE_CHANNEL_DATA_TYPE
```
    The struct member offsets.
- Constructor Detail
  - CLImageFormat
```
public CLImageFormat(java.nio.ByteBuffer container)
```
    Creates a CLImageFormat instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
    The created instance holds a strong reference to the container object.
- Method Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - image_channel_order
```
public int image_channel_order()
```
    Returns the value of the image_channel_order field.
  - image_channel_data_type
```
public int image_channel_data_type()
```
    Returns the value of the image_channel_data_type field.
  - image_channel_order
```
public CLImageFormat image_channel_order(int value)
```
    Sets the specified value to the image_channel_order field.
  - image_channel_data_type
```
public CLImageFormat image_channel_data_type(int value)
```
    Sets the specified value to the image_channel_data_type field.
  - set
```
public CLImageFormat set(int image_channel_order,
                         int image_channel_data_type)
```
    Initializes this struct with the specified values.
  - set
```
public CLImageFormat set(CLImageFormat src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static CLImageFormat malloc()
```
    Returns a new CLImageFormat instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static CLImageFormat calloc()
```
    Returns a new CLImageFormat instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static CLImageFormat create()
```
    Returns a new CLImageFormat instance allocated with BufferUtils.
  - create
```
public static CLImageFormat create(long address)
```
    Returns a new CLImageFormat instance for the specified memory address.
  - createSafe
```
@Nullable
public static CLImageFormat createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static CLImageFormat.Buffer malloc(int capacity)
```
    Returns a new CLImageFormat.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static CLImageFormat.Buffer calloc(int capacity)
```
    Returns a new CLImageFormat.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static CLImageFormat.Buffer create(int capacity)
```
    Returns a new CLImageFormat.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static CLImageFormat.Buffer create(long address,
                                          int capacity)
```
    Create a CLImageFormat.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static CLImageFormat.Buffer createSafe(long address,
                                                        int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static CLImageFormat mallocStack()
```
    Returns a new CLImageFormat instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static CLImageFormat callocStack()
```
    Returns a new CLImageFormat instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static CLImageFormat mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CLImageFormat instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static CLImageFormat callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CLImageFormat instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static CLImageFormat.Buffer mallocStack(int capacity)
```
    Returns a new CLImageFormat.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static CLImageFormat.Buffer callocStack(int capacity)
```
    Returns a new CLImageFormat.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static CLImageFormat.Buffer mallocStack(int capacity,
                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new CLImageFormat.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static CLImageFormat.Buffer callocStack(int capacity,
                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new CLImageFormat.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nimage_channel_order
```
public static int nimage_channel_order(long struct)
```
    Unsafe version of image_channel_order().
  - nimage_channel_data_type
```
public static int nimage_channel_data_type(long struct)
```
    Unsafe version of image_channel_data_type().
  - nimage_channel_order
```
public static void nimage_channel_order(long struct,
                                        int value)
```
    Unsafe version of image_channel_order.
  - nimage_channel_data_type
```
public static void nimage_channel_data_type(long struct,
                                            int value)
```
    Unsafe version of image_channel_data_type.

Class CLImageFormat

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

IMAGE_CHANNEL_ORDER

IMAGE_CHANNEL_DATA_TYPE

Constructor Detail

CLImageFormat

Method Detail

sizeof

image_channel_order

image_channel_data_type

image_channel_order

image_channel_data_type

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nimage_channel_order

nimage_channel_data_type

nimage_channel_order

nimage_channel_data_type