Package org.lwjgl.cuda

Class CUDA_ARRAY3D_DESCRIPTOR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<CUDA_ARRAY3D_DESCRIPTOR>

org.lwjgl.cuda.CUDA_ARRAY3D_DESCRIPTOR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class CUDA_ARRAY3D_DESCRIPTOR
extends Struct<CUDA_ARRAY3D_DESCRIPTOR>
implements NativeResource

Layout

 struct CUDA_ARRAY3D_DESCRIPTOR {
     size_t Width;
     size_t Height;
     size_t Depth;
     CUarray_format Format;
     unsigned int NumChannels;
     unsigned int Flags;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CUDA_ARRAY3D_DESCRIPTOR.Buffer	An array of CUDA_ARRAY3D_DESCRIPTOR 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	DEPTH	The struct member offsets.
static final int	FLAGS	The struct member offsets.
static final int	FORMAT	The struct member offsets.
static final int	HEIGHT	The struct member offsets.
static final int	NUMCHANNELS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	WIDTH	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
CUDA_ARRAY3D_DESCRIPTOR(ByteBuffer container)	Creates a CUDA_ARRAY3D_DESCRIPTOR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static CUDA_ARRAY3D_DESCRIPTOR	calloc()	Returns a new CUDA_ARRAY3D_DESCRIPTOR instance allocated with memCalloc.
static CUDA_ARRAY3D_DESCRIPTOR.Buffer	calloc(int capacity)	Returns a new CUDA_ARRAY3D_DESCRIPTOR.Buffer instance allocated with memCalloc.
static CUDA_ARRAY3D_DESCRIPTOR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new CUDA_ARRAY3D_DESCRIPTOR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static CUDA_ARRAY3D_DESCRIPTOR	calloc(MemoryStack stack)	Returns a new CUDA_ARRAY3D_DESCRIPTOR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static CUDA_ARRAY3D_DESCRIPTOR	callocStack()	Deprecated.
static CUDA_ARRAY3D_DESCRIPTOR.Buffer	callocStack(int capacity)	Deprecated.
static CUDA_ARRAY3D_DESCRIPTOR.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static CUDA_ARRAY3D_DESCRIPTOR	callocStack(MemoryStack stack)	Deprecated.
static CUDA_ARRAY3D_DESCRIPTOR	create()	Returns a new CUDA_ARRAY3D_DESCRIPTOR instance allocated with BufferUtils.
static CUDA_ARRAY3D_DESCRIPTOR.Buffer	create(int capacity)	Returns a new CUDA_ARRAY3D_DESCRIPTOR.Buffer instance allocated with BufferUtils.
static CUDA_ARRAY3D_DESCRIPTOR	create(long address)	Returns a new CUDA_ARRAY3D_DESCRIPTOR instance for the specified memory address.
static CUDA_ARRAY3D_DESCRIPTOR.Buffer	create(long address, int capacity)	Create a CUDA_ARRAY3D_DESCRIPTOR.Buffer instance at the specified memory.
static CUDA_ARRAY3D_DESCRIPTOR	createSafe(long address)	Like create, but returns null if address is NULL.
static CUDA_ARRAY3D_DESCRIPTOR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	Depth()
CUDA_ARRAY3D_DESCRIPTOR	Depth(long value)	Sets the specified value to the Depth field.
int	Flags()
CUDA_ARRAY3D_DESCRIPTOR	Flags(int value)	Sets the specified value to the Flags field.
int	Format()
CUDA_ARRAY3D_DESCRIPTOR	Format(int value)	Sets the specified value to the Format field.
long	Height()
CUDA_ARRAY3D_DESCRIPTOR	Height(long value)	Sets the specified value to the Height field.
static CUDA_ARRAY3D_DESCRIPTOR	malloc()	Returns a new CUDA_ARRAY3D_DESCRIPTOR instance allocated with memAlloc.
static CUDA_ARRAY3D_DESCRIPTOR.Buffer	malloc(int capacity)	Returns a new CUDA_ARRAY3D_DESCRIPTOR.Buffer instance allocated with memAlloc.
static CUDA_ARRAY3D_DESCRIPTOR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new CUDA_ARRAY3D_DESCRIPTOR.Buffer instance allocated on the specified MemoryStack.
static CUDA_ARRAY3D_DESCRIPTOR	malloc(MemoryStack stack)	Returns a new CUDA_ARRAY3D_DESCRIPTOR instance allocated on the specified MemoryStack.
static CUDA_ARRAY3D_DESCRIPTOR	mallocStack()	Deprecated.
static CUDA_ARRAY3D_DESCRIPTOR.Buffer	mallocStack(int capacity)	Deprecated.
static CUDA_ARRAY3D_DESCRIPTOR.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static CUDA_ARRAY3D_DESCRIPTOR	mallocStack(MemoryStack stack)	Deprecated.
static long	nDepth(long struct)	Unsafe version of Depth().
static void	nDepth(long struct, long value)	Unsafe version of Depth.
static int	nFlags(long struct)	Unsafe version of Flags().
static void	nFlags(long struct, int value)	Unsafe version of Flags.
static int	nFormat(long struct)	Unsafe version of Format().
static void	nFormat(long struct, int value)	Unsafe version of Format.
static long	nHeight(long struct)	Unsafe version of Height().
static void	nHeight(long struct, long value)	Unsafe version of Height.
static int	nNumChannels(long struct)	Unsafe version of NumChannels().
static void	nNumChannels(long struct, int value)	Unsafe version of NumChannels.
int	NumChannels()
CUDA_ARRAY3D_DESCRIPTOR	NumChannels(int value)	Sets the specified value to the NumChannels field.
static long	nWidth(long struct)	Unsafe version of Width().
static void	nWidth(long struct, long value)	Unsafe version of Width.
CUDA_ARRAY3D_DESCRIPTOR	set(long Width, long Height, long Depth, int Format, int NumChannels, int Flags)	Initializes this struct with the specified values.
CUDA_ARRAY3D_DESCRIPTOR	set(CUDA_ARRAY3D_DESCRIPTOR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
long	Width()
CUDA_ARRAY3D_DESCRIPTOR	Width(long value)	Sets the specified value to the Width field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

WIDTH

public static final int WIDTH

The struct member offsets.

HEIGHT

public static final int HEIGHT

The struct member offsets.

DEPTH

public static final int DEPTH

The struct member offsets.

FORMAT

public static final int FORMAT

The struct member offsets.

NUMCHANNELS

public static final int NUMCHANNELS

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

Constructor Details

CUDA_ARRAY3D_DESCRIPTOR

public CUDA_ARRAY3D_DESCRIPTOR(ByteBuffer container)

Creates a CUDA_ARRAY3D_DESCRIPTOR 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<CUDA_ARRAY3D_DESCRIPTOR>

Width

public long Width()

Returns:

the value of the Width field.

Height

public long Height()

Returns:

the value of the Height field.

Depth

public long Depth()

Returns:

the value of the Depth field.

Format

public int Format()

Returns:

the value of the Format field.

NumChannels

public int NumChannels()

Returns:

the value of the NumChannels field.

Flags

public int Flags()

Returns:

the value of the Flags field.

Width

public CUDA_ARRAY3D_DESCRIPTOR Width(long value)

Sets the specified value to the Width field.

Height

public CUDA_ARRAY3D_DESCRIPTOR Height(long value)

Sets the specified value to the Height field.

Depth

public CUDA_ARRAY3D_DESCRIPTOR Depth(long value)

Sets the specified value to the Depth field.

Format

public CUDA_ARRAY3D_DESCRIPTOR Format(int value)

Sets the specified value to the Format field.

NumChannels

public CUDA_ARRAY3D_DESCRIPTOR NumChannels(int value)

Sets the specified value to the NumChannels field.

Flags

public CUDA_ARRAY3D_DESCRIPTOR Flags(int value)

Sets the specified value to the Flags field.

set

public CUDA_ARRAY3D_DESCRIPTOR set(long Width,
 long Height,
 long Depth,
 int Format,
 int NumChannels,
 int Flags)

Initializes this struct with the specified values.

set

public CUDA_ARRAY3D_DESCRIPTOR set(CUDA_ARRAY3D_DESCRIPTOR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static CUDA_ARRAY3D_DESCRIPTOR malloc()

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

calloc

public static CUDA_ARRAY3D_DESCRIPTOR calloc()

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

create

public static CUDA_ARRAY3D_DESCRIPTOR create()

Returns a new CUDA_ARRAY3D_DESCRIPTOR instance allocated with BufferUtils.

create

public static CUDA_ARRAY3D_DESCRIPTOR create(long address)

Returns a new CUDA_ARRAY3D_DESCRIPTOR instance for the specified memory address.

createSafe

@Nullable
public static CUDA_ARRAY3D_DESCRIPTOR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static CUDA_ARRAY3D_DESCRIPTOR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static CUDA_ARRAY3D_DESCRIPTOR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static CUDA_ARRAY3D_DESCRIPTOR.Buffer create(int capacity)

Returns a new CUDA_ARRAY3D_DESCRIPTOR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a CUDA_ARRAY3D_DESCRIPTOR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static CUDA_ARRAY3D_DESCRIPTOR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static CUDA_ARRAY3D_DESCRIPTOR callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static CUDA_ARRAY3D_DESCRIPTOR mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static CUDA_ARRAY3D_DESCRIPTOR callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static CUDA_ARRAY3D_DESCRIPTOR malloc(MemoryStack stack)

Returns a new CUDA_ARRAY3D_DESCRIPTOR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static CUDA_ARRAY3D_DESCRIPTOR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new CUDA_ARRAY3D_DESCRIPTOR.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

nWidth

public static long nWidth(long struct)

Unsafe version of Width().

nHeight

public static long nHeight(long struct)

Unsafe version of Height().

nDepth

public static long nDepth(long struct)

Unsafe version of Depth().

nFormat

public static int nFormat(long struct)

Unsafe version of Format().

nNumChannels

public static int nNumChannels(long struct)

Unsafe version of NumChannels().

nFlags

public static int nFlags(long struct)

Unsafe version of Flags().

nWidth

public static void nWidth(long struct,
 long value)

Unsafe version of Width.

nHeight

public static void nHeight(long struct,
 long value)

Unsafe version of Height.

nDepth

public static void nDepth(long struct,
 long value)

Unsafe version of Depth.

nFormat

public static void nFormat(long struct,
 int value)

Unsafe version of Format.

nNumChannels

public static void nNumChannels(long struct,
 int value)

Unsafe version of NumChannels.

nFlags

public static void nFlags(long struct,
 int value)

Unsafe version of Flags.