Package org.lwjgl.opencl

Class CLImageFormat

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<CLImageFormat>

org.lwjgl.opencl.CLImageFormat

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class CLImageFormat
extends Struct<CLImageFormat>
implements NativeResource

 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	Description
static class	CLImageFormat.Buffer	An array of CLImageFormat structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	IMAGE_CHANNEL_DATA_TYPE	The struct member offsets.
static final int	IMAGE_CHANNEL_ORDER	The struct member offsets.
static final 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	Description
CLImageFormat(ByteBuffer container)	Creates a CLImageFormat instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new CLImageFormat.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static CLImageFormat	calloc(MemoryStack stack)	Returns a new CLImageFormat instance allocated on the specified MemoryStack and initializes all its bits to zero.
static CLImageFormat	callocStack()	Deprecated.
static CLImageFormat.Buffer	callocStack(int capacity)	Deprecated.
static CLImageFormat.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static CLImageFormat	callocStack(MemoryStack stack)	Deprecated.
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 @Nullable CLImageFormat	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable CLImageFormat.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	image_channel_data_type()
CLImageFormat	image_channel_data_type(int value)	Sets the specified value to the image_channel_data_type field.
int	image_channel_order()
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new CLImageFormat.Buffer instance allocated on the specified MemoryStack.
static CLImageFormat	malloc(MemoryStack stack)	Returns a new CLImageFormat instance allocated on the specified MemoryStack.
static CLImageFormat	mallocStack()	Deprecated.
static CLImageFormat.Buffer	mallocStack(int capacity)	Deprecated.
static CLImageFormat.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static CLImageFormat	mallocStack(MemoryStack stack)	Deprecated.
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(int image_channel_order, int image_channel_data_type)	Initializes this struct with the specified values.
CLImageFormat	set(CLImageFormat src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 Details

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 Details

CLImageFormat

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<CLImageFormat>

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

public static @Nullable 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

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static CLImageFormat mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static CLImageFormat callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static CLImageFormat mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static CLImageFormat callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static CLImageFormat.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static CLImageFormat.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static CLImageFormat malloc(MemoryStack stack)

Returns a new CLImageFormat instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

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.