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

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

Access	Constructor and Description
protected	CLImageFormat(long address, ByteBuffer container)
public	CLImageFormat(ByteBuffer container) Creates a `CLImageFormat` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static CLImageFormat	calloc() Returns a new `CLImageFormat` instance allocated with `memCalloc`.
public static CLImageFormat.Buffer	calloc(int the buffer capacity capacity) Returns a new `CLImageFormat.Buffer` instance allocated with `memCalloc`.
public static CLImageFormat	calloc(MemoryStack the stack from which to allocate stack) Returns a new `CLImageFormat` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static CLImageFormat.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `CLImageFormat.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static CLImageFormat	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static CLImageFormat	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static CLImageFormat.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static CLImageFormat.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected CLImageFormat	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static CLImageFormat	create() Returns a new `CLImageFormat` instance allocated with `BufferUtils`.
public static CLImageFormat	create(long address) Returns a new `CLImageFormat` instance for the specified memory address.
public static CLImageFormat.Buffer	create(int the buffer capacity capacity) Returns a new `CLImageFormat.Buffer` instance allocated with `BufferUtils`.
public static CLImageFormat.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `CLImageFormat.Buffer` instance at the specified memory.
public static CLImageFormat	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static CLImageFormat.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	image_channel_data_type() describes the size of the channel data type.
public CLImageFormat	image_channel_data_type(int value) Sets the specified value to the `image_channel_data_type` field.
public int	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
public CLImageFormat	image_channel_order(int value) Sets the specified value to the `image_channel_order` field.
public static CLImageFormat	malloc() Returns a new `CLImageFormat` instance allocated with `memAlloc`.
public static CLImageFormat.Buffer	malloc(int the buffer capacity capacity) Returns a new `CLImageFormat.Buffer` instance allocated with `memAlloc`.
public static CLImageFormat	malloc(MemoryStack the stack from which to allocate stack) Returns a new `CLImageFormat` instance allocated on the specified `MemoryStack`.
public static CLImageFormat.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `CLImageFormat.Buffer` instance allocated on the specified `MemoryStack`.
public static CLImageFormat	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static CLImageFormat	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static CLImageFormat.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static CLImageFormat.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	nimage_channel_data_type(long struct) Unsafe version of `image_channel_data_type`.
public static void	nimage_channel_data_type(long struct, int value) Unsafe version of `image_channel_data_type`.
public static int	nimage_channel_order(long struct) Unsafe version of `image_channel_order`.
public static void	nimage_channel_order(long struct, int value) Unsafe version of `image_channel_order`.
public CLImageFormat	set(int image_channel_order, int image_channel_data_type) Initializes this struct with the specified values.
public CLImageFormat	Returns: this struct set(CLImageFormat the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

IMAGE_CHANNEL_DATA_TYPE	back to summary
public static final int IMAGE_CHANNEL_DATA_TYPE The struct member offsets.

IMAGE_CHANNEL_ORDER	back to summary
public static final int IMAGE_CHANNEL_ORDER The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

CLImageFormat	back to summary
protected CLImageFormat(long address, ByteBuffer container)

CLImageFormat back to summary

CLImageFormat	back to summary
public CLImageFormat(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.

public CLImageFormat(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

calloc	back to summary
public static CLImageFormat calloc() Returns a new `CLImageFormat` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static CLImageFormat.Buffer calloc(int capacity) Returns a new `CLImageFormat.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static CLImageFormat.Buffer calloc(int capacity)

Returns a new CLImageFormat.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static CLImageFormat calloc(MemoryStack stack) Returns a new `CLImageFormat` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static CLImageFormat calloc(MemoryStack stack)

Returns a new CLImageFormat instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static CLImageFormat.Buffer calloc(int capacity, MemoryStack stack) Returns a new `CLImageFormat.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static CLImageFormat.Buffer calloc(int capacity, MemoryStack stack)

Returns a new CLImageFormat.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

callocStack back to summary

callocStack	back to summary
public static CLImageFormat callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static CLImageFormat callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static CLImageFormat callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static CLImageFormat callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static CLImageFormat.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static CLImageFormat.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static CLImageFormat.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static CLImageFormat.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations

@Deprecated

create back to summary

create	back to summary
protected CLImageFormat create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected CLImageFormat create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static CLImageFormat create() Returns a new `CLImageFormat` instance allocated with `BufferUtils`.

create	back to summary
public static CLImageFormat create(long address) Returns a new `CLImageFormat` instance for the specified memory address.

create back to summary

create	back to summary
public static CLImageFormat.Buffer create(int capacity) Returns a new `CLImageFormat.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static CLImageFormat.Buffer create(int capacity)

Returns a new CLImageFormat.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static CLImageFormat.Buffer create(long address, int capacity) Create a `CLImageFormat.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static CLImageFormat.Buffer create(long address, int capacity)

Create a CLImageFormat.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static CLImageFormat createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static CLImageFormat createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static CLImageFormat.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static CLImageFormat.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations

@Nullable

image_channel_data_type back to summary

image_channel_data_type	back to summary
public int 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. Annotations @NativeType:cl_channel_type

public int 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.

Annotations

@NativeType:cl_channel_type

image_channel_data_type	back to summary
public CLImageFormat image_channel_data_type(int value) Sets the specified value to the `image_channel_data_type` field.

image_channel_order	back to summary
public int 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 Annotations @NativeType:cl_channel_order

image_channel_order

back to summary

public int 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

Annotations

@NativeType:cl_channel_order

image_channel_order	back to summary
public CLImageFormat image_channel_order(int value) Sets the specified value to the `image_channel_order` field.

malloc	back to summary
public static CLImageFormat malloc() Returns a new `CLImageFormat` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static CLImageFormat.Buffer malloc(int capacity) Returns a new `CLImageFormat.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static CLImageFormat.Buffer malloc(int capacity)

Returns a new CLImageFormat.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static CLImageFormat malloc(MemoryStack stack) Returns a new `CLImageFormat` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static CLImageFormat malloc(MemoryStack stack)

Returns a new CLImageFormat instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static CLImageFormat.Buffer malloc(int capacity, MemoryStack stack) Returns a new `CLImageFormat.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static CLImageFormat.Buffer malloc(int capacity, MemoryStack stack)

Returns a new CLImageFormat.Buffer instance allocated on the specified MemoryStack.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static CLImageFormat mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static CLImageFormat mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static CLImageFormat mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static CLImageFormat mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static CLImageFormat.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static CLImageFormat.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static CLImageFormat.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static CLImageFormat.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations

@Deprecated

nimage_channel_data_type	back to summary
public static int nimage_channel_data_type(long struct) Unsafe version of `image_channel_data_type`.

nimage_channel_data_type	back to summary
public static void nimage_channel_data_type(long struct, int value) Unsafe version of `image_channel_data_type`.

nimage_channel_order	back to summary
public static int nimage_channel_order(long struct) Unsafe version of `image_channel_order`.

nimage_channel_order	back to summary
public static void nimage_channel_order(long struct, int value) Unsafe version of `image_channel_order`.

set	back to summary
public CLImageFormat set(int image_channel_order, int image_channel_data_type) Initializes this struct with the specified values.

set	back to summary
public CLImageFormat set(CLImageFormat src) Copies the specified struct data to this struct. Parameters src:CLImageFormat the source struct Returns:CLImageFormat this struct

set

back to summary

public CLImageFormat set(CLImageFormat src)

Copies the specified struct data to this struct.

Parameters

src:CLImageFormat: the source struct

Returns:CLImageFormat

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

org.lwjgl.opencl back to summary

public Class CLImageFormat.Buffer

Class Inheritance

extends StructBuffer<CLImageFormat, CLImageFormat.Buffer>
implements NativeResource

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of CLImageFormat structs.

Field Summary

Modifier and Type	Field and Description
private static final CLImageFormat	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `CLImageFormat.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
protected CLImageFormat	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `CLImageFormat#image_channel_data_type` field. image_channel_data_type()
public CLImageFormat.Buffer	image_channel_data_type(int value) Sets the specified value to the `CLImageFormat#image_channel_data_type` field.
public int	Returns: the value of the `CLImageFormat#image_channel_order` field. image_channel_order()
public CLImageFormat.Buffer	image_channel_order(int value) Sets the specified value to the `CLImageFormat#image_channel_order` field.
protected CLImageFormat.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final CLImageFormat ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `CLImageFormat.Buffer` instance backed by the specified container. Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by `CLImageFormat#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new CLImageFormat.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by CLImageFormat#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactory

back to summary

protected CLImageFormat getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

image_channel_data_type	back to summary
public int image_channel_data_type() Returns:int the value of the `CLImageFormat#image_channel_data_type` field. Annotations @NativeType:cl_channel_type

image_channel_data_type	back to summary
public CLImageFormat.Buffer image_channel_data_type(int value) Sets the specified value to the `CLImageFormat#image_channel_data_type` field.

image_channel_order	back to summary
public int image_channel_order() Returns:int the value of the `CLImageFormat#image_channel_order` field. Annotations @NativeType:cl_channel_order

image_channel_order	back to summary
public CLImageFormat.Buffer image_channel_order(int value) Sets the specified value to the `CLImageFormat#image_channel_order` field.

self

back to summary

protected CLImageFormat.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

public Class CLImageFormat

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class CLImageFormat.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail