CUDA_ARRAY_DESCRIPTOR (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.cuda.CUDA_ARRAY_DESCRIPTOR

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class CUDA_ARRAY_DESCRIPTOR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Array descriptor.
Member documentation
- Width – Width of array
- Height – Height of array
- Format – Array format
- NumChannels – Channels per array element
Layout
```
 struct CUDA_ARRAY_DESCRIPTOR {
     size_t Width;
     size_t Height;
     CUarray_format Format;
     unsigned int NumChannels;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CUDA_ARRAY_DESCRIPTOR.Buffer
An array of CUDA_ARRAY_DESCRIPTOR structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CUDA_ARRAY_DESCRIPTOR.Buffer` An array of `CUDA_ARRAY_DESCRIPTOR` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FORMAT` The struct member offsets.
`static int`	`HEIGHT` The struct member offsets.
`static int`	`NUMCHANNELS` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static 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 and Description
`CUDA_ARRAY_DESCRIPTOR(java.nio.ByteBuffer container)` Creates a `CUDA_ARRAY_DESCRIPTOR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CUDA_ARRAY_DESCRIPTOR`	`calloc()` Returns a new `CUDA_ARRAY_DESCRIPTOR` instance allocated with `memCalloc`.
`static CUDA_ARRAY_DESCRIPTOR.Buffer`	`calloc(int capacity)` Returns a new `CUDA_ARRAY_DESCRIPTOR.Buffer` instance allocated with `memCalloc`.
`static CUDA_ARRAY_DESCRIPTOR`	`callocStack()` Returns a new `CUDA_ARRAY_DESCRIPTOR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CUDA_ARRAY_DESCRIPTOR.Buffer`	`callocStack(int capacity)` Returns a new `CUDA_ARRAY_DESCRIPTOR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CUDA_ARRAY_DESCRIPTOR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CUDA_ARRAY_DESCRIPTOR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CUDA_ARRAY_DESCRIPTOR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CUDA_ARRAY_DESCRIPTOR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CUDA_ARRAY_DESCRIPTOR`	`create()` Returns a new `CUDA_ARRAY_DESCRIPTOR` instance allocated with `BufferUtils`.
`static CUDA_ARRAY_DESCRIPTOR.Buffer`	`create(int capacity)` Returns a new `CUDA_ARRAY_DESCRIPTOR.Buffer` instance allocated with `BufferUtils`.
`static CUDA_ARRAY_DESCRIPTOR`	`create(long address)` Returns a new `CUDA_ARRAY_DESCRIPTOR` instance for the specified memory address.
`static CUDA_ARRAY_DESCRIPTOR.Buffer`	`create(long address, int capacity)` Create a `CUDA_ARRAY_DESCRIPTOR.Buffer` instance at the specified memory.
`static CUDA_ARRAY_DESCRIPTOR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static CUDA_ARRAY_DESCRIPTOR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`Format()` Returns the value of the `Format` field.
`CUDA_ARRAY_DESCRIPTOR`	`Format(int value)` Sets the specified value to the `Format` field.
`long`	`Height()` Returns the value of the `Height` field.
`CUDA_ARRAY_DESCRIPTOR`	`Height(long value)` Sets the specified value to the `Height` field.
`static CUDA_ARRAY_DESCRIPTOR`	`malloc()` Returns a new `CUDA_ARRAY_DESCRIPTOR` instance allocated with `memAlloc`.
`static CUDA_ARRAY_DESCRIPTOR.Buffer`	`malloc(int capacity)` Returns a new `CUDA_ARRAY_DESCRIPTOR.Buffer` instance allocated with `memAlloc`.
`static CUDA_ARRAY_DESCRIPTOR`	`mallocStack()` Returns a new `CUDA_ARRAY_DESCRIPTOR` instance allocated on the thread-local `MemoryStack`.
`static CUDA_ARRAY_DESCRIPTOR.Buffer`	`mallocStack(int capacity)` Returns a new `CUDA_ARRAY_DESCRIPTOR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static CUDA_ARRAY_DESCRIPTOR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CUDA_ARRAY_DESCRIPTOR.Buffer` instance allocated on the specified `MemoryStack`.
`static CUDA_ARRAY_DESCRIPTOR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CUDA_ARRAY_DESCRIPTOR` instance allocated on the specified `MemoryStack`.
`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()` Returns the value of the `NumChannels` field.
`CUDA_ARRAY_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_ARRAY_DESCRIPTOR`	`set(CUDA_ARRAY_DESCRIPTOR src)` Copies the specified struct data to this struct.
`CUDA_ARRAY_DESCRIPTOR`	`set(long Width, long Height, int Format, int NumChannels)` Initializes this struct with the specified values.
`int`	`sizeof()`
`long`	`Width()` Returns the value of the `Width` field.
`CUDA_ARRAY_DESCRIPTOR`	`Width(long value)` Sets the specified value to the `Width` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - 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.
  - FORMAT
```
public static final int FORMAT
```
    The struct member offsets.
  - NUMCHANNELS
```
public static final int NUMCHANNELS
```
    The struct member offsets.
- Constructor Detail
  - CUDA_ARRAY_DESCRIPTOR
```
public CUDA_ARRAY_DESCRIPTOR(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - Width
```
public long Width()
```
    Returns the value of the Width field.
  - Height
```
public long Height()
```
    Returns the value of the Height field.
  - Format
```
public int Format()
```
    Returns the value of the Format field.
  - NumChannels
```
public int NumChannels()
```
    Returns the value of the NumChannels field.
  - Width
```
public CUDA_ARRAY_DESCRIPTOR Width(long value)
```
    Sets the specified value to the Width field.
  - Height
```
public CUDA_ARRAY_DESCRIPTOR Height(long value)
```
    Sets the specified value to the Height field.
  - Format
```
public CUDA_ARRAY_DESCRIPTOR Format(int value)
```
    Sets the specified value to the Format field.
  - NumChannels
```
public CUDA_ARRAY_DESCRIPTOR NumChannels(int value)
```
    Sets the specified value to the NumChannels field.
  - set
```
public CUDA_ARRAY_DESCRIPTOR set(long Width,
                                 long Height,
                                 int Format,
                                 int NumChannels)
```
    Initializes this struct with the specified values.
  - set
```
public CUDA_ARRAY_DESCRIPTOR set(CUDA_ARRAY_DESCRIPTOR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static CUDA_ARRAY_DESCRIPTOR malloc()
```
    Returns a new CUDA_ARRAY_DESCRIPTOR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static CUDA_ARRAY_DESCRIPTOR calloc()
```
    Returns a new CUDA_ARRAY_DESCRIPTOR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static CUDA_ARRAY_DESCRIPTOR create()
```
    Returns a new CUDA_ARRAY_DESCRIPTOR instance allocated with BufferUtils.
  - create
```
public static CUDA_ARRAY_DESCRIPTOR create(long address)
```
    Returns a new CUDA_ARRAY_DESCRIPTOR instance for the specified memory address.
  - createSafe
```
@Nullable
public static CUDA_ARRAY_DESCRIPTOR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
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 - the buffer capacity
  - calloc
```
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 - the buffer capacity
  - create
```
public static CUDA_ARRAY_DESCRIPTOR.Buffer create(int capacity)
```
    Returns a new CUDA_ARRAY_DESCRIPTOR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static CUDA_ARRAY_DESCRIPTOR.Buffer create(long address,
                                                  int capacity)
```
    Create a CUDA_ARRAY_DESCRIPTOR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static CUDA_ARRAY_DESCRIPTOR.Buffer createSafe(long address,
                                                                int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static CUDA_ARRAY_DESCRIPTOR mallocStack()
```
    Returns a new CUDA_ARRAY_DESCRIPTOR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static CUDA_ARRAY_DESCRIPTOR callocStack()
```
    Returns a new CUDA_ARRAY_DESCRIPTOR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static CUDA_ARRAY_DESCRIPTOR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CUDA_ARRAY_DESCRIPTOR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static CUDA_ARRAY_DESCRIPTOR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CUDA_ARRAY_DESCRIPTOR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static CUDA_ARRAY_DESCRIPTOR.Buffer mallocStack(int capacity)
```
    Returns a new CUDA_ARRAY_DESCRIPTOR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static CUDA_ARRAY_DESCRIPTOR.Buffer callocStack(int capacity)
```
    Returns a new CUDA_ARRAY_DESCRIPTOR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static CUDA_ARRAY_DESCRIPTOR.Buffer mallocStack(int capacity,
                                                       org.lwjgl.system.MemoryStack stack)
```
    Returns a new CUDA_ARRAY_DESCRIPTOR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static CUDA_ARRAY_DESCRIPTOR.Buffer callocStack(int capacity,
                                                       org.lwjgl.system.MemoryStack stack)
```
    Returns a new CUDA_ARRAY_DESCRIPTOR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nWidth
```
public static long nWidth(long struct)
```
    Unsafe version of Width().
  - nHeight
```
public static long nHeight(long struct)
```
    Unsafe version of Height().
  - nFormat
```
public static int nFormat(long struct)
```
    Unsafe version of Format().
  - nNumChannels
```
public static int nNumChannels(long struct)
```
    Unsafe version of NumChannels().
  - 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.
  - 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.

Class CUDA_ARRAY_DESCRIPTOR

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

WIDTH

HEIGHT

FORMAT

NUMCHANNELS

Constructor Detail

CUDA_ARRAY_DESCRIPTOR

Method Detail

sizeof

Width

Height

Format

NumChannels

Width

Height

Format

NumChannels

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nWidth

nHeight

nFormat

nNumChannels

nWidth

nHeight

nFormat

nNumChannels