Top Description Inners Fields Constructors Methods
org.lwjgl.cuda

public Class CUIPCMemHandle

extends Struct<CUIPCMemHandle>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct CUipcMemHandle
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


struct CUipcMemHandle {
    char reserved[CU_IPC_HANDLE_SIZE];
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
RESERVED

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
CUIPCMemHandle(long address, ByteBuffer container)

public
CUIPCMemHandle(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static CUIPCMemHandle
calloc()

Returns a new CUIPCMemHandle instance allocated with memCalloc.

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

Returns a new CUIPCMemHandle.Buffer instance allocated with memCalloc.

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

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

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

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

public static CUIPCMemHandle
callocStack()

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

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

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

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

Returns a new CUIPCMemHandle instance allocated with BufferUtils.

public static CUIPCMemHandle
create(long address)

Returns a new CUIPCMemHandle instance for the specified memory address.

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

Returns a new CUIPCMemHandle.Buffer instance allocated with BufferUtils.

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

Create a CUIPCMemHandle.Buffer instance at the specified memory.

public static CUIPCMemHandle
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static CUIPCMemHandle
malloc()

Returns a new CUIPCMemHandle instance allocated with memAlloc.

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

Returns a new CUIPCMemHandle.Buffer instance allocated with memAlloc.

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

Returns a new CUIPCMemHandle instance allocated on the specified MemoryStack.

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

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

public static CUIPCMemHandle
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static ByteBuffer
nreserved(long struct)

Unsafe version of reserved.

public static byte
nreserved(long struct, int index)

Unsafe version of reserved.

public static void
nreserved(long struct, ByteBuffer value)

Unsafe version of reserved.

public static void
nreserved(long struct, int index, byte value)

Unsafe version of reserved.

public ByteBuffer

Returns:

a ByteBuffer view of the reserved field.
reserved
()

public byte

Returns:

the value at the specified index of the reserved field.
reserved
(int index)

public CUIPCMemHandle
reserved(ByteBuffer value)

Copies the specified ByteBuffer to the reserved field.

public CUIPCMemHandle
reserved(int index, byte value)

Sets the specified value at the specified index of the reserved field.

public CUIPCMemHandle

Returns:

this struct
set
(CUIPCMemHandle
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

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

RESERVEDback to summary
public static final int RESERVED

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

CUIPCMemHandleback to summary
protected CUIPCMemHandle(long address, ByteBuffer container)
CUIPCMemHandleback to summary
public CUIPCMemHandle(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

callocback to summary
public static CUIPCMemHandle calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CUIPCMemHandle calloc(MemoryStack stack)

Returns a new CUIPCMemHandle 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 CUIPCMemHandle.Buffer calloc(int capacity, MemoryStack stack)

Returns a new CUIPCMemHandle.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 CUIPCMemHandle callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static CUIPCMemHandle.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 CUIPCMemHandle 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 CUIPCMemHandle create()

Returns a new CUIPCMemHandle instance allocated with BufferUtils.

createback to summary
public static CUIPCMemHandle create(long address)

Returns a new CUIPCMemHandle instance for the specified memory address.

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

Returns a new CUIPCMemHandle.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a CUIPCMemHandle.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CUIPCMemHandle createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static CUIPCMemHandle malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CUIPCMemHandle malloc(MemoryStack stack)

Returns a new CUIPCMemHandle instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new CUIPCMemHandle.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 CUIPCMemHandle mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nreservedback to summary
public static ByteBuffer nreserved(long struct)

Unsafe version of reserved.

nreservedback to summary
public static byte nreserved(long struct, int index)

Unsafe version of reserved.

nreservedback to summary
public static void nreserved(long struct, ByteBuffer value)

Unsafe version of reserved.

nreservedback to summary
public static void nreserved(long struct, int index, byte value)

Unsafe version of reserved.

reservedback to summary
public ByteBuffer reserved()
Returns:ByteBuffer

a ByteBuffer view of the reserved field.

Annotations
@NativeType:char[CU_IPC_HANDLE_SIZE]
reservedback to summary
public byte reserved(int index)
Returns:byte

the value at the specified index of the reserved field.

Annotations
@NativeType:char
reservedback to summary
public CUIPCMemHandle reserved(ByteBuffer value)

Copies the specified ByteBuffer to the reserved field.

reservedback to summary
public CUIPCMemHandle reserved(int index, byte value)

Sets the specified value at the specified index of the reserved field.

setback to summary
public CUIPCMemHandle set(CUIPCMemHandle src)

Copies the specified struct data to this struct.

Parameters
src:CUIPCMemHandle

the source struct

Returns:CUIPCMemHandle

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
org.lwjgl.cuda back to summary

public Class CUIPCMemHandle.Buffer

extends StructBuffer<CUIPCMemHandle, CUIPCMemHandle.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of CUIPCMemHandle structs.

Field Summary

Modifier and TypeField and Description
private static final CUIPCMemHandle

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CUIPCMemHandle.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
protected CUIPCMemHandle
public ByteBuffer

Returns:

a ByteBuffer view of the reserved field.
reserved
()

public byte

Returns:

the value at the specified index of the reserved field.
reserved
(int index)

public CUIPCMemHandle.Buffer
reserved(ByteBuffer value)

Copies the specified ByteBuffer to the reserved field.

public CUIPCMemHandle.Buffer
reserved(int index, byte value)

Sets the specified value at the specified index of the reserved field.

protected CUIPCMemHandle.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CUIPCMemHandle ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new CUIPCMemHandle.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 CUIPCMemHandle#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

getElementFactoryback to summary
protected CUIPCMemHandle getElementFactory()

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

Annotations
@Override
reservedback to summary
public ByteBuffer reserved()
Returns:ByteBuffer

a ByteBuffer view of the reserved field.

Annotations
@NativeType:char[CU_IPC_HANDLE_SIZE]
reservedback to summary
public byte reserved(int index)
Returns:byte

the value at the specified index of the reserved field.

Annotations
@NativeType:char
reservedback to summary
public CUIPCMemHandle.Buffer reserved(ByteBuffer value)

Copies the specified ByteBuffer to the reserved field.

reservedback to summary
public CUIPCMemHandle.Buffer reserved(int index, byte value)

Sets the specified value at the specified index of the reserved field.

selfback to summary
protected CUIPCMemHandle.Buffer self()

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

Annotations
@Override