Top Description Inners Fields Constructors Methods
org.lwjgl.opencl

public Class CLImageDesc

extends Struct<CLImageDesc>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct cl_image_desc
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Describes the type and dimensions of the image or image array.

Layout


struct cl_image_desc {
    cl_mem_object_type image_type;
    size_t image_width;
    size_t image_height;
    size_t image_depth;
    size_t image_array_size;
    size_t image_row_pitch;
    size_t image_slice_pitch;
    cl_uint num_mip_levels;
    cl_uint num_samples;
    union {
        cl_mem buffer;
        cl_mem mem_object;
    };
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
CLImageDesc.Buffer

An array of CLImageDesc structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BUFFER

The struct member offsets.

public static final int
IMAGE_ARRAY_SIZE

The struct member offsets.

public static final int
IMAGE_DEPTH

The struct member offsets.

public static final int
IMAGE_HEIGHT

The struct member offsets.

public static final int
IMAGE_ROW_PITCH

The struct member offsets.

public static final int
IMAGE_SLICE_PITCH

The struct member offsets.

public static final int
IMAGE_TYPE

The struct member offsets.

public static final int
IMAGE_WIDTH

The struct member offsets.

public static final int
MEM_OBJECT

The struct member offsets.

public static final int
NUM_MIP_LEVELS

The struct member offsets.

public static final int
NUM_SAMPLES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
CLImageDesc(long address, ByteBuffer container)

public
CLImageDesc(ByteBuffer container)

Creates a CLImageDesc instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public long
buffer()

alias for mem_object

public CLImageDesc
buffer(long value)

Sets the specified value to the buffer field.

public static CLImageDesc
calloc()

Returns a new CLImageDesc instance allocated with memCalloc.

public static CLImageDesc.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new CLImageDesc.Buffer instance allocated with memCalloc.

public static CLImageDesc
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static CLImageDesc.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static CLImageDesc
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static CLImageDesc
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static CLImageDesc.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static CLImageDesc.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected CLImageDesc
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 CLImageDesc
create()

Returns a new CLImageDesc instance allocated with BufferUtils.

public static CLImageDesc
create(long address)

Returns a new CLImageDesc instance for the specified memory address.

public static CLImageDesc.Buffer
create(int
the buffer capacity
capacity)

Returns a new CLImageDesc.Buffer instance allocated with BufferUtils.

public static CLImageDesc.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a CLImageDesc.Buffer instance at the specified memory.

public static CLImageDesc
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
image_array_size()

the number of images in the image array.

public CLImageDesc
image_array_size(long value)

Sets the specified value to the image_array_size field.

public long
image_depth()

the depth of the image in pixels.

public CLImageDesc
image_depth(long value)

Sets the specified value to the image_depth field.

public long
image_height()

the height of the image in pixels.

public CLImageDesc
image_height(long value)

Sets the specified value to the image_height field.

public long
image_row_pitch()

the scan-line pitch in bytes.

public CLImageDesc
image_row_pitch(long value)

Sets the specified value to the image_row_pitch field.

public long
image_slice_pitch()

the size in bytes of each 2D slice in the 3D image or the size in bytes of each image in a 1D or 2D image array.

public CLImageDesc
image_slice_pitch(long value)

Sets the specified value to the image_slice_pitch field.

public int
image_type()

describes the image type

public CLImageDesc
image_type(int value)

Sets the specified value to the image_type field.

public long
image_width()

the width of the image in pixels.

public CLImageDesc
image_width(long value)

Sets the specified value to the image_width field.

public static CLImageDesc
malloc()

Returns a new CLImageDesc instance allocated with memAlloc.

public static CLImageDesc.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new CLImageDesc.Buffer instance allocated with memAlloc.

public static CLImageDesc
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new CLImageDesc instance allocated on the specified MemoryStack.

public static CLImageDesc.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static CLImageDesc
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static CLImageDesc
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static CLImageDesc.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static CLImageDesc.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public long
mem_object()

refers to a valid buffer or image memory object.

public CLImageDesc
mem_object(long value)

Sets the specified value to the mem_object field.

public static long
nbuffer(long struct)

Unsafe version of buffer.

public static void
nbuffer(long struct, long value)

Unsafe version of buffer.

public static long
nimage_array_size(long struct)

Unsafe version of image_array_size.

public static void
nimage_array_size(long struct, long value)

Unsafe version of image_array_size.

public static long
nimage_depth(long struct)

Unsafe version of image_depth.

public static void
nimage_depth(long struct, long value)

Unsafe version of image_depth.

public static long
nimage_height(long struct)

Unsafe version of image_height.

public static void
nimage_height(long struct, long value)

Unsafe version of image_height.

public static long
nimage_row_pitch(long struct)

Unsafe version of image_row_pitch.

public static void
nimage_row_pitch(long struct, long value)

Unsafe version of image_row_pitch.

public static long
nimage_slice_pitch(long struct)

Unsafe version of image_slice_pitch.

public static void
nimage_slice_pitch(long struct, long value)

Unsafe version of image_slice_pitch.

public static int
nimage_type(long struct)

Unsafe version of image_type.

public static void
nimage_type(long struct, int value)

Unsafe version of image_type.

public static long
nimage_width(long struct)

Unsafe version of image_width.

public static void
nimage_width(long struct, long value)

Unsafe version of image_width.

public static long
nmem_object(long struct)

Unsafe version of mem_object.

public static void
nmem_object(long struct, long value)

Unsafe version of mem_object.

public static int
nnum_mip_levels(long struct)

Unsafe version of num_mip_levels.

public static void
nnum_mip_levels(long struct, int value)

Unsafe version of num_mip_levels.

public static int
nnum_samples(long struct)

Unsafe version of num_samples.

public static void
nnum_samples(long struct, int value)

Unsafe version of num_samples.

public int
num_mip_levels()

must be 0

public CLImageDesc
num_mip_levels(int value)

Sets the specified value to the num_mip_levels field.

public int
num_samples()

must be 0

public CLImageDesc
num_samples(int value)

Sets the specified value to the num_samples field.

public CLImageDesc

Returns:

this struct
set(CLImageDesc
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).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate