CUIPCMemHandle (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class CUIPCMemHandle
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Layout


 struct CUipcMemHandle {
     char reserved[CU_IPC_HANDLE_SIZE];
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`RESERVED` The struct member offsets.
`static 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 and Description

CUIPCMemHandle(java.nio.ByteBuffer container)
Creates a CUIPCMemHandle instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`CUIPCMemHandle(java.nio.ByteBuffer container)` Creates a `CUIPCMemHandle` 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 CUIPCMemHandle`	`calloc()` Returns a new `CUIPCMemHandle` instance allocated with `memCalloc`.
`static CUIPCMemHandle.Buffer`	`calloc(int capacity)` Returns a new `CUIPCMemHandle.Buffer` instance allocated with `memCalloc`.
`static CUIPCMemHandle`	`callocStack()` Returns a new `CUIPCMemHandle` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CUIPCMemHandle.Buffer`	`callocStack(int capacity)` Returns a new `CUIPCMemHandle.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CUIPCMemHandle.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CUIPCMemHandle.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CUIPCMemHandle`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CUIPCMemHandle` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CUIPCMemHandle`	`create()` Returns a new `CUIPCMemHandle` instance allocated with `BufferUtils`.
`static CUIPCMemHandle.Buffer`	`create(int capacity)` Returns a new `CUIPCMemHandle.Buffer` instance allocated with `BufferUtils`.
`static CUIPCMemHandle`	`create(long address)` Returns a new `CUIPCMemHandle` instance for the specified memory address.
`static CUIPCMemHandle.Buffer`	`create(long address, int capacity)` Create a `CUIPCMemHandle.Buffer` instance at the specified memory.
`static CUIPCMemHandle`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static CUIPCMemHandle.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static CUIPCMemHandle`	`malloc()` Returns a new `CUIPCMemHandle` instance allocated with `memAlloc`.
`static CUIPCMemHandle.Buffer`	`malloc(int capacity)` Returns a new `CUIPCMemHandle.Buffer` instance allocated with `memAlloc`.
`static CUIPCMemHandle`	`mallocStack()` Returns a new `CUIPCMemHandle` instance allocated on the thread-local `MemoryStack`.
`static CUIPCMemHandle.Buffer`	`mallocStack(int capacity)` Returns a new `CUIPCMemHandle.Buffer` instance allocated on the thread-local `MemoryStack`.
`static CUIPCMemHandle.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CUIPCMemHandle.Buffer` instance allocated on the specified `MemoryStack`.
`static CUIPCMemHandle`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CUIPCMemHandle` instance allocated on the specified `MemoryStack`.
`static java.nio.ByteBuffer`	`nreserved(long struct)` Unsafe version of `reserved()`.
`static void`	`nreserved(long struct, java.nio.ByteBuffer value)` Unsafe version of `reserved`.
`static byte`	`nreserved(long struct, int index)` Unsafe version of `reserved`.
`static void`	`nreserved(long struct, int index, byte value)` Unsafe version of `reserved`.
`java.nio.ByteBuffer`	`reserved()` Returns a `ByteBuffer` view of the `reserved` field.
`CUIPCMemHandle`	`reserved(java.nio.ByteBuffer value)` Copies the specified `ByteBuffer` to the `reserved` field.
`byte`	`reserved(int index)` Returns the value at the specified index of the `reserved` field.
`CUIPCMemHandle`	`reserved(int index, byte value)` Sets the specified value at the specified index of the `reserved` field.
`CUIPCMemHandle`	`set(CUIPCMemHandle src)` Copies the specified struct data to this struct.
`int`	`sizeof()`

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.
  - RESERVED
```
public static final int RESERVED
```
    The struct member offsets.
- Constructor Detail
  - CUIPCMemHandle
```
public CUIPCMemHandle(java.nio.ByteBuffer container)
```
    Creates a CUIPCMemHandle 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
  - reserved
```
public java.nio.ByteBuffer reserved()
```
    Returns a ByteBuffer view of the reserved field.
  - reserved
```
public byte reserved(int index)
```
    Returns the value at the specified index of the reserved field.
  - reserved
```
public CUIPCMemHandle reserved(java.nio.ByteBuffer value)
```
    Copies the specified ByteBuffer to the reserved field.
  - reserved
```
public CUIPCMemHandle reserved(int index,
                               byte value)
```
    Sets the specified value at the specified index of the reserved field.
  - set
```
public CUIPCMemHandle set(CUIPCMemHandle src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static CUIPCMemHandle malloc()
```
    Returns a new CUIPCMemHandle instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static CUIPCMemHandle calloc()
```
    Returns a new CUIPCMemHandle instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static CUIPCMemHandle create()
```
    Returns a new CUIPCMemHandle instance allocated with BufferUtils.
  - create
```
public static CUIPCMemHandle create(long address)
```
    Returns a new CUIPCMemHandle instance for the specified memory address.
  - createSafe
```
@Nullable
public static CUIPCMemHandle createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static CUIPCMemHandle.Buffer malloc(int capacity)
```
    Returns a new CUIPCMemHandle.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static CUIPCMemHandle.Buffer calloc(int capacity)
```
    Returns a new CUIPCMemHandle.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static CUIPCMemHandle.Buffer create(int capacity)
```
    Returns a new CUIPCMemHandle.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static CUIPCMemHandle.Buffer create(long address,
                                           int capacity)
```
    Create a CUIPCMemHandle.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static CUIPCMemHandle.Buffer createSafe(long address,
                                                         int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static CUIPCMemHandle mallocStack()
```
    Returns a new CUIPCMemHandle instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static CUIPCMemHandle callocStack()
```
    Returns a new CUIPCMemHandle instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static CUIPCMemHandle mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CUIPCMemHandle instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static CUIPCMemHandle callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CUIPCMemHandle instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static CUIPCMemHandle.Buffer mallocStack(int capacity)
```
    Returns a new CUIPCMemHandle.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static CUIPCMemHandle.Buffer callocStack(int capacity)
```
    Returns a new CUIPCMemHandle.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static CUIPCMemHandle.Buffer mallocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new CUIPCMemHandle.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static CUIPCMemHandle.Buffer callocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new CUIPCMemHandle.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
  - nreserved
```
public static java.nio.ByteBuffer nreserved(long struct)
```
    Unsafe version of reserved().
  - nreserved
```
public static byte nreserved(long struct,
                             int index)
```
    Unsafe version of reserved.
  - nreserved
```
public static void nreserved(long struct,
                             java.nio.ByteBuffer value)
```
    Unsafe version of reserved.
  - nreserved
```
public static void nreserved(long struct,
                             int index,
                             byte value)
```
    Unsafe version of reserved.

Class CUIPCMemHandle

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

RESERVED

Constructor Detail

CUIPCMemHandle

Method Detail

sizeof

reserved

reserved

reserved

reserved

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nreserved

nreserved

nreserved

nreserved