Top Description Inners Fields Constructors Methods
org.lwjgl.cuda

public Class CUmemLocation

extends Struct<CUmemLocation>
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 CUmemLocation {
    CUmemLocationType type;
    int id;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
CUmemLocation.Buffer

An array of CUmemLocation structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ID

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
CUmemLocation(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static CUmemLocation
calloc()

Returns a new CUmemLocation instance allocated with memCalloc.

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

Returns a new CUmemLocation.Buffer instance allocated with memCalloc.

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

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

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

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

protected CUmemLocation
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 CUmemLocation
create()

Returns a new CUmemLocation instance allocated with BufferUtils.

public static CUmemLocation
create(long address)

Returns a new CUmemLocation instance for the specified memory address.

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

Returns a new CUmemLocation.Buffer instance allocated with BufferUtils.

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

Create a CUmemLocation.Buffer instance at the specified memory.

public static CUmemLocation
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the id field.
id
()

public CUmemLocation
id(int value)

Sets the specified value to the id field.

public static CUmemLocation
malloc()

Returns a new CUmemLocation instance allocated with memAlloc.

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

Returns a new CUmemLocation.Buffer instance allocated with memAlloc.

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

Returns a new CUmemLocation instance allocated on the specified MemoryStack.

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

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

public static int
nid(long struct)

Unsafe version of id.

public static void
nid(long struct, int value)

Unsafe version of id.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public CUmemLocation
set(int type, int id)

Initializes this struct with the specified values.

public CUmemLocation

Returns:

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

Returns:

the value of the type field.
type
()

public CUmemLocation
type(int value)

Sets the specified value to the type 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.

IDback to summary
public static final int ID

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

CUmemLocationback to summary
protected CUmemLocation(long address, ByteBuffer container)
CUmemLocationback to summary
public CUmemLocation(ByteBuffer container)

Creates a CUmemLocation 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 CUmemLocation calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CUmemLocation calloc(MemoryStack stack)

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

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

createback to summary
protected CUmemLocation 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 CUmemLocation create()

Returns a new CUmemLocation instance allocated with BufferUtils.

createback to summary
public static CUmemLocation create(long address)

Returns a new CUmemLocation instance for the specified memory address.

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

Returns a new CUmemLocation.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a CUmemLocation.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CUmemLocation createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
idback to summary
public int id()
Returns:int

the value of the id field.

idback to summary
public CUmemLocation id(int value)

Sets the specified value to the id field.

mallocback to summary
public static CUmemLocation malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CUmemLocation malloc(MemoryStack stack)

Returns a new CUmemLocation instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nidback to summary
public static int nid(long struct)

Unsafe version of id.

nidback to summary
public static void nid(long struct, int value)

Unsafe version of id.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

setback to summary
public CUmemLocation set(int type, int id)

Initializes this struct with the specified values.

setback to summary
public CUmemLocation set(CUmemLocation src)

Copies the specified struct data to this struct.

Parameters
src:CUmemLocation

the source struct

Returns:CUmemLocation

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
typeback to summary
public int type()
Returns:int

the value of the type field.

Annotations
@NativeType:CUmemLocationType
typeback to summary
public CUmemLocation type(int value)

Sets the specified value to the type field.

org.lwjgl.cuda back to summary

public Class CUmemLocation.Buffer

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

An array of CUmemLocation structs.

Field Summary

Modifier and TypeField and Description
private static final CUmemLocation

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CUmemLocation.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 CUmemLocation
public int

Returns:

the value of the id field.
id
()

public CUmemLocation.Buffer
id(int value)

Sets the specified value to the id field.

protected CUmemLocation.Buffer
public int

Returns:

the value of the type field.
type
()

public CUmemLocation.Buffer
type(int value)

Sets the specified value to the type field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CUmemLocation ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new CUmemLocation.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 CUmemLocation#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 CUmemLocation getElementFactory()

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

Annotations
@Override
idback to summary
public int id()
Returns:int

the value of the id field.

idback to summary
public CUmemLocation.Buffer id(int value)

Sets the specified value to the id field.

selfback to summary
protected CUmemLocation.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the type field.

Annotations
@NativeType:CUmemLocationType
typeback to summary
public CUmemLocation.Buffer type(int value)

Sets the specified value to the type field.