Top Description Inners Fields Constructors Methods
org.lwjgl.cuda

public Class CUDA_ARRAY_DESCRIPTOR

extends Struct<CUDA_ARRAY_DESCRIPTOR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


struct CUDA_ARRAY_DESCRIPTOR {
    size_t Width;
    size_t Height;
    CUarray_format Format;
    unsigned int NumChannels;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
CUDA_ARRAY_DESCRIPTOR.Buffer

An array of CUDA_ARRAY_DESCRIPTOR structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FORMAT

The struct member offsets.

public static final int
HEIGHT

The struct member offsets.

public static final int
NUMCHANNELS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
WIDTH

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
CUDA_ARRAY_DESCRIPTOR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static CUDA_ARRAY_DESCRIPTOR
calloc()

Returns a new CUDA_ARRAY_DESCRIPTOR instance allocated with memCalloc.

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

Returns a new CUDA_ARRAY_DESCRIPTOR.Buffer instance allocated with memCalloc.

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

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

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

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

public static CUDA_ARRAY_DESCRIPTOR
callocStack()

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

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

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

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

Returns a new CUDA_ARRAY_DESCRIPTOR instance allocated with BufferUtils.

public static CUDA_ARRAY_DESCRIPTOR
create(long address)

Returns a new CUDA_ARRAY_DESCRIPTOR instance for the specified memory address.

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

Returns a new CUDA_ARRAY_DESCRIPTOR.Buffer instance allocated with BufferUtils.

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

Create a CUDA_ARRAY_DESCRIPTOR.Buffer instance at the specified memory.

public static CUDA_ARRAY_DESCRIPTOR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the Format field.
Format()

public CUDA_ARRAY_DESCRIPTOR
Format(int value)

Sets the specified value to the Format field.

public long

Returns:

the value of the Height field.
Height()

public CUDA_ARRAY_DESCRIPTOR
Height(long value)

Sets the specified value to the Height field.

public static CUDA_ARRAY_DESCRIPTOR
malloc()

Returns a new CUDA_ARRAY_DESCRIPTOR instance allocated with memAlloc.

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

Returns a new CUDA_ARRAY_DESCRIPTOR.Buffer instance allocated with memAlloc.

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

Returns a new CUDA_ARRAY_DESCRIPTOR instance allocated on the specified MemoryStack.

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

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

public static CUDA_ARRAY_DESCRIPTOR
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static int
nFormat(long struct)

Unsafe version of Format.

public static void
nFormat(long struct, int value)

Unsafe version of Format.

public static long
nHeight(long struct)

Unsafe version of Height.

public static void
nHeight(long struct, long value)

Unsafe version of Height.

public static int
nNumChannels(long struct)

Unsafe version of NumChannels.

public static void
nNumChannels(long struct, int value)

Unsafe version of NumChannels.

public int

Returns:

the value of the NumChannels field.
NumChannels()

public CUDA_ARRAY_DESCRIPTOR
NumChannels(int value)

Sets the specified value to the NumChannels field.

public static long
nWidth(long struct)

Unsafe version of Width.

public static void
nWidth(long struct, long value)

Unsafe version of Width.

public CUDA_ARRAY_DESCRIPTOR
set(long Width, long Height, int Format, int NumChannels)

Initializes this struct with the specified values.

public CUDA_ARRAY_DESCRIPTOR

Returns:

this struct
set(CUDA_ARRAY_DESCRIPTOR
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).
public long

Returns:

the value of the Width field.
Width()

public CUDA_ARRAY_DESCRIPTOR
Width(long value)

Sets the specified value to the Width field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

FORMATback to summary
public static final int FORMAT

The struct member offsets.

HEIGHTback to summary
public static final int HEIGHT

The struct member offsets.

NUMCHANNELSback to summary
public static final int NUMCHANNELS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

WIDTHback to summary
public static final int WIDTH

The struct member offsets.

Constructor Detail

CUDA_ARRAY_DESCRIPTORback to summary
protected CUDA_ARRAY_DESCRIPTOR(long address, ByteBuffer container)
CUDA_ARRAY_DESCRIPTORback to summary
public CUDA_ARRAY_DESCRIPTOR(ByteBuffer container)

Creates a CUDA_ARRAY_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 Detail

callocback to summary
public static CUDA_ARRAY_DESCRIPTOR calloc()

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

callocback to summary
public static CUDA_ARRAY_DESCRIPTOR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CUDA_ARRAY_DESCRIPTOR calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static CUDA_ARRAY_DESCRIPTOR.Buffer calloc(int capacity, MemoryStack stack)

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

callocStackback to summary
public static CUDA_ARRAY_DESCRIPTOR callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static CUDA_ARRAY_DESCRIPTOR callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static CUDA_ARRAY_DESCRIPTOR.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static CUDA_ARRAY_DESCRIPTOR.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected CUDA_ARRAY_DESCRIPTOR 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
createback to summary
public static CUDA_ARRAY_DESCRIPTOR create()

Returns a new CUDA_ARRAY_DESCRIPTOR instance allocated with BufferUtils.

createback to summary
public static CUDA_ARRAY_DESCRIPTOR create(long address)

Returns a new CUDA_ARRAY_DESCRIPTOR instance for the specified memory address.

createback to summary
public static CUDA_ARRAY_DESCRIPTOR.Buffer create(int capacity)

Returns a new CUDA_ARRAY_DESCRIPTOR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static CUDA_ARRAY_DESCRIPTOR.Buffer create(long address, int capacity)

Create a CUDA_ARRAY_DESCRIPTOR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CUDA_ARRAY_DESCRIPTOR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static CUDA_ARRAY_DESCRIPTOR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
Formatback to summary
public int Format()
Returns:int

the value of the Format field.

Annotations
@NativeType:CUarray_format
Formatback to summary
public CUDA_ARRAY_DESCRIPTOR Format(int value)

Sets the specified value to the Format field.

Heightback to summary
public long Height()
Returns:long

the value of the Height field.

Annotations
@NativeType:size_t
Heightback to summary
public CUDA_ARRAY_DESCRIPTOR Height(long value)

Sets the specified value to the Height field.

mallocback to summary
public static CUDA_ARRAY_DESCRIPTOR malloc()

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

mallocback to summary
public static CUDA_ARRAY_DESCRIPTOR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CUDA_ARRAY_DESCRIPTOR malloc(MemoryStack stack)

Returns a new CUDA_ARRAY_DESCRIPTOR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static CUDA_ARRAY_DESCRIPTOR.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static CUDA_ARRAY_DESCRIPTOR mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static CUDA_ARRAY_DESCRIPTOR mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static CUDA_ARRAY_DESCRIPTOR.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static CUDA_ARRAY_DESCRIPTOR.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
nFormatback to summary
public static int nFormat(long struct)

Unsafe version of Format.

nFormatback to summary
public static void nFormat(long struct, int value)

Unsafe version of Format.

nHeightback to summary
public static long nHeight(long struct)

Unsafe version of Height.

nHeightback to summary
public static void nHeight(long struct, long value)

Unsafe version of Height.

nNumChannelsback to summary
public static int nNumChannels(long struct)

Unsafe version of NumChannels.

nNumChannelsback to summary
public static void nNumChannels(long struct, int value)

Unsafe version of NumChannels.

NumChannelsback to summary
public int NumChannels()
Returns:int

the value of the NumChannels field.

Annotations
@NativeType:unsigned int
NumChannelsback to summary
public CUDA_ARRAY_DESCRIPTOR NumChannels(int value)

Sets the specified value to the NumChannels field.

nWidthback to summary
public static long nWidth(long struct)

Unsafe version of Width.

nWidthback to summary
public static void nWidth(long struct, long value)

Unsafe version of Width.

setback to summary
public CUDA_ARRAY_DESCRIPTOR set(long Width, long Height, int Format, int NumChannels)

Initializes this struct with the specified values.

setback to summary
public CUDA_ARRAY_DESCRIPTOR set(CUDA_ARRAY_DESCRIPTOR src)

Copies the specified struct data to this struct.

Parameters
src:CUDA_ARRAY_DESCRIPTOR

the source struct

Returns:CUDA_ARRAY_DESCRIPTOR

this struct

sizeofback to summary
public int sizeof()

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

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

Returns sizeof(struct).

Annotations
@Override
Widthback to summary
public long Width()
Returns:long

the value of the Width field.

Annotations
@NativeType:size_t
Widthback to summary
public CUDA_ARRAY_DESCRIPTOR Width(long value)

Sets the specified value to the Width field.

org.lwjgl.cuda back to summary

public Class CUDA_ARRAY_DESCRIPTOR.Buffer

extends StructBuffer<CUDA_ARRAY_DESCRIPTOR, CUDA_ARRAY_DESCRIPTOR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of CUDA_ARRAY_DESCRIPTOR structs.

Field Summary

Modifier and TypeField and Description
private static final CUDA_ARRAY_DESCRIPTOR
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CUDA_ARRAY_DESCRIPTOR.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 TypeMethod and Description
public int

Returns:

the value of the Format field.
Format()

public CUDA_ARRAY_DESCRIPTOR.Buffer
Format(int value)

Sets the specified value to the Format field.

protected CUDA_ARRAY_DESCRIPTOR
getElementFactory()

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

public long

Returns:

the value of the Height field.
Height()

public CUDA_ARRAY_DESCRIPTOR.Buffer
Height(long value)

Sets the specified value to the Height field.

public int

Returns:

the value of the NumChannels field.
NumChannels()

public CUDA_ARRAY_DESCRIPTOR.Buffer
NumChannels(int value)

Sets the specified value to the NumChannels field.

protected CUDA_ARRAY_DESCRIPTOR.Buffer
self()

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

public long

Returns:

the value of the Width field.
Width()

public CUDA_ARRAY_DESCRIPTOR.Buffer
Width(long value)

Sets the specified value to the Width field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CUDA_ARRAY_DESCRIPTOR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new CUDA_ARRAY_DESCRIPTOR.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 CUDA_ARRAY_DESCRIPTOR#SIZEOF, and its mark will be undefined.

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

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

Method Detail

Formatback to summary
public int Format()
Returns:int

the value of the Format field.

Annotations
@NativeType:CUarray_format
Formatback to summary
public CUDA_ARRAY_DESCRIPTOR.Buffer Format(int value)

Sets the specified value to the Format field.

getElementFactoryback to summary
protected CUDA_ARRAY_DESCRIPTOR getElementFactory()

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

Annotations
@Override
Heightback to summary
public long Height()
Returns:long

the value of the Height field.

Annotations
@NativeType:size_t
Heightback to summary
public CUDA_ARRAY_DESCRIPTOR.Buffer Height(long value)

Sets the specified value to the Height field.

NumChannelsback to summary
public int NumChannels()
Returns:int

the value of the NumChannels field.

Annotations
@NativeType:unsigned int
NumChannelsback to summary
public CUDA_ARRAY_DESCRIPTOR.Buffer NumChannels(int value)

Sets the specified value to the NumChannels field.

selfback to summary
protected CUDA_ARRAY_DESCRIPTOR.Buffer self()

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

Annotations
@Override
Widthback to summary
public long Width()
Returns:long

the value of the Width field.

Annotations
@NativeType:size_t
Widthback to summary
public CUDA_ARRAY_DESCRIPTOR.Buffer Width(long value)

Sets the specified value to the Width field.