Top Description Inners Fields Constructors Methods
org.lwjgl.cuda

public Class CUmemAccessDesc

extends Struct<CUmemAccessDesc>
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 CUmemAccessDesc {
    CUmemLocation location;
    CUmemAccess_flags flags;
}

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
FLAGS

The struct member offsets.

public static final int
LOCATION

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

public
CUmemAccessDesc(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static CUmemAccessDesc
calloc()

Returns a new CUmemAccessDesc instance allocated with memCalloc.

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

Returns a new CUmemAccessDesc.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new CUmemAccessDesc instance allocated with BufferUtils.

public static CUmemAccessDesc
create(long address)

Returns a new CUmemAccessDesc instance for the specified memory address.

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

Returns a new CUmemAccessDesc.Buffer instance allocated with BufferUtils.

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

Create a CUmemAccessDesc.Buffer instance at the specified memory.

public static CUmemAccessDesc
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the flags field.
flags
()

public CUmemAccessDesc
flags(int value)

Sets the specified value to the flags field.

public CUmemLocation

Returns:

a CUmemLocation view of the location field.
location
()

public CUmemAccessDesc
location(CUmemLocation value)

Copies the specified CUmemLocation to the location field.

public CUmemAccessDesc
location(Consumer<CUmemLocation> consumer)

Passes the location field to the specified Consumer.

public static CUmemAccessDesc
malloc()

Returns a new CUmemAccessDesc instance allocated with memAlloc.

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

Returns a new CUmemAccessDesc.Buffer instance allocated with memAlloc.

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

Returns a new CUmemAccessDesc instance allocated on the specified MemoryStack.

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

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

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static CUmemLocation
nlocation(long struct)

Unsafe version of location.

public static void
nlocation(long struct, CUmemLocation value)

Unsafe version of location.

public CUmemAccessDesc
set(CUmemLocation location, int flags)

Initializes this struct with the specified values.

public CUmemAccessDesc

Returns:

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

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

LOCATIONback to summary
public static final int LOCATION

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

CUmemAccessDescback to summary
protected CUmemAccessDesc(long address, ByteBuffer container)
CUmemAccessDescback to summary
public CUmemAccessDesc(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CUmemAccessDesc calloc(MemoryStack stack)

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

Returns a new CUmemAccessDesc.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 CUmemAccessDesc 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 CUmemAccessDesc create()

Returns a new CUmemAccessDesc instance allocated with BufferUtils.

createback to summary
public static CUmemAccessDesc create(long address)

Returns a new CUmemAccessDesc instance for the specified memory address.

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

Returns a new CUmemAccessDesc.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a CUmemAccessDesc.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CUmemAccessDesc createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()
Returns:int

the value of the flags field.

Annotations
@NativeType:CUmemAccess_flags
flagsback to summary
public CUmemAccessDesc flags(int value)

Sets the specified value to the flags field.

locationback to summary
public CUmemLocation location()
Returns:CUmemLocation

a CUmemLocation view of the location field.

locationback to summary
public CUmemAccessDesc location(CUmemLocation value)

Copies the specified CUmemLocation to the location field.

locationback to summary
public CUmemAccessDesc location(Consumer<CUmemLocation> consumer)

Passes the location field to the specified Consumer.

mallocback to summary
public static CUmemAccessDesc malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CUmemAccessDesc malloc(MemoryStack stack)

Returns a new CUmemAccessDesc instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

nlocationback to summary
public static CUmemLocation nlocation(long struct)

Unsafe version of location.

nlocationback to summary
public static void nlocation(long struct, CUmemLocation value)

Unsafe version of location.

setback to summary
public CUmemAccessDesc set(CUmemLocation location, int flags)

Initializes this struct with the specified values.

setback to summary
public CUmemAccessDesc set(CUmemAccessDesc src)

Copies the specified struct data to this struct.

Parameters
src:CUmemAccessDesc

the source struct

Returns:CUmemAccessDesc

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 CUmemAccessDesc.Buffer

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

An array of CUmemAccessDesc structs.

Field Summary

Modifier and TypeField and Description
private static final CUmemAccessDesc

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CUmemAccessDesc.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 flags field.
flags
()

public CUmemAccessDesc.Buffer
flags(int value)

Sets the specified value to the flags field.

protected CUmemAccessDesc
public CUmemLocation

Returns:

a CUmemLocation view of the location field.
location
()

public CUmemAccessDesc.Buffer
location(CUmemLocation value)

Copies the specified CUmemLocation to the location field.

public CUmemAccessDesc.Buffer
location(Consumer<CUmemLocation> consumer)

Passes the location field to the specified Consumer.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final CUmemAccessDesc ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

flagsback to summary
public int flags()
Returns:int

the value of the flags field.

Annotations
@NativeType:CUmemAccess_flags
flagsback to summary
public CUmemAccessDesc.Buffer flags(int value)

Sets the specified value to the flags field.

getElementFactoryback to summary
protected CUmemAccessDesc getElementFactory()

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

Annotations
@Override
locationback to summary
public CUmemLocation location()
Returns:CUmemLocation

a CUmemLocation view of the location field.

locationback to summary
public CUmemAccessDesc.Buffer location(CUmemLocation value)

Copies the specified CUmemLocation to the location field.

locationback to summary
public CUmemAccessDesc.Buffer location(Consumer<CUmemLocation> consumer)

Passes the location field to the specified Consumer.

selfback to summary
protected CUmemAccessDesc.Buffer self()

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

Annotations
@Override