Top Description Inners Fields Constructors Methods
org.lwjgl.cuda

public Class CUmemPoolProps

extends Struct<CUmemPoolProps>
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 CUmemPoolProps {
    CUmemAllocationType allocType;
    CUmemAllocationHandleType handleTypes;
    CUmemLocation location;
    void * win32SecurityAttributes;
    unsigned char reserved[64];
}

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
ALLOCTYPE

The struct member offsets.

public static final int
HANDLETYPES

The struct member offsets.

public static final int
LOCATION

The struct member offsets.

public static final int
RESERVED

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
WIN32SECURITYATTRIBUTES

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
CUmemPoolProps(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the allocType field.
allocType
()

public CUmemPoolProps
allocType(int value)

Sets the specified value to the allocType field.

public static CUmemPoolProps
calloc()

Returns a new CUmemPoolProps instance allocated with memCalloc.

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

Returns a new CUmemPoolProps.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new CUmemPoolProps instance allocated with BufferUtils.

public static CUmemPoolProps
create(long address)

Returns a new CUmemPoolProps instance for the specified memory address.

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

Returns a new CUmemPoolProps.Buffer instance allocated with BufferUtils.

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

Create a CUmemPoolProps.Buffer instance at the specified memory.

public static CUmemPoolProps
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the handleTypes field.
handleTypes
()

public CUmemPoolProps
handleTypes(int value)

Sets the specified value to the handleTypes field.

public CUmemLocation

Returns:

a CUmemLocation view of the location field.
location
()

public CUmemPoolProps
location(CUmemLocation value)

Copies the specified CUmemLocation to the location field.

public CUmemPoolProps
location(Consumer<CUmemLocation> consumer)

Passes the location field to the specified Consumer.

public static CUmemPoolProps
malloc()

Returns a new CUmemPoolProps instance allocated with memAlloc.

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

Returns a new CUmemPoolProps.Buffer instance allocated with memAlloc.

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

Returns a new CUmemPoolProps instance allocated on the specified MemoryStack.

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

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

public static int
nallocType(long struct)

Unsafe version of allocType.

public static void
nallocType(long struct, int value)

Unsafe version of allocType.

public static int
nhandleTypes(long struct)

Unsafe version of handleTypes.

public static void
nhandleTypes(long struct, int value)

Unsafe version of handleTypes.

public static CUmemLocation
nlocation(long struct)

Unsafe version of location.

public static void
nlocation(long struct, CUmemLocation value)

Unsafe version of location.

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 static long
nwin32SecurityAttributes(long struct)

Unsafe version of win32SecurityAttributes.

public static void
nwin32SecurityAttributes(long struct, long value)

Unsafe version of win32SecurityAttributes.

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 CUmemPoolProps
reserved(ByteBuffer value)

Copies the specified ByteBuffer to the reserved field.

public CUmemPoolProps
reserved(int index, byte value)

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

public CUmemPoolProps
set(int allocType, int handleTypes, CUmemLocation location, long win32SecurityAttributes, ByteBuffer reserved)

Initializes this struct with the specified values.

public CUmemPoolProps

Returns:

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

Returns:

the value of the win32SecurityAttributes field.
win32SecurityAttributes
()

public CUmemPoolProps
win32SecurityAttributes(long value)

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

ALLOCTYPEback to summary
public static final int ALLOCTYPE

The struct member offsets.

HANDLETYPESback to summary
public static final int HANDLETYPES

The struct member offsets.

LOCATIONback to summary
public static final int LOCATION

The struct member offsets.

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.

WIN32SECURITYATTRIBUTESback to summary
public static final int WIN32SECURITYATTRIBUTES

The struct member offsets.

Constructor Detail

CUmemPoolPropsback to summary
protected CUmemPoolProps(long address, ByteBuffer container)
CUmemPoolPropsback to summary
public CUmemPoolProps(ByteBuffer container)

Creates a CUmemPoolProps 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

allocTypeback to summary
public int allocType()
Returns:int

the value of the allocType field.

Annotations
@NativeType:CUmemAllocationType
allocTypeback to summary
public CUmemPoolProps allocType(int value)

Sets the specified value to the allocType field.

callocback to summary
public static CUmemPoolProps calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CUmemPoolProps calloc(MemoryStack stack)

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

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

Returns a new CUmemPoolProps instance allocated with BufferUtils.

createback to summary
public static CUmemPoolProps create(long address)

Returns a new CUmemPoolProps instance for the specified memory address.

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

Returns a new CUmemPoolProps.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a CUmemPoolProps.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CUmemPoolProps createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
handleTypesback to summary
public int handleTypes()
Returns:int

the value of the handleTypes field.

Annotations
@NativeType:CUmemAllocationHandleType
handleTypesback to summary
public CUmemPoolProps handleTypes(int value)

Sets the specified value to the handleTypes field.

locationback to summary
public CUmemLocation location()
Returns:CUmemLocation

a CUmemLocation view of the location field.

locationback to summary
public CUmemPoolProps location(CUmemLocation value)

Copies the specified CUmemLocation to the location field.

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

Passes the location field to the specified Consumer.

mallocback to summary
public static CUmemPoolProps malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CUmemPoolProps malloc(MemoryStack stack)

Returns a new CUmemPoolProps instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nallocTypeback to summary
public static int nallocType(long struct)

Unsafe version of allocType.

nallocTypeback to summary
public static void nallocType(long struct, int value)

Unsafe version of allocType.

nhandleTypesback to summary
public static int nhandleTypes(long struct)

Unsafe version of handleTypes.

nhandleTypesback to summary
public static void nhandleTypes(long struct, int value)

Unsafe version of handleTypes.

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.

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.

nwin32SecurityAttributesback to summary
public static long nwin32SecurityAttributes(long struct)

Unsafe version of win32SecurityAttributes.

nwin32SecurityAttributesback to summary
public static void nwin32SecurityAttributes(long struct, long value)

Unsafe version of win32SecurityAttributes.

reservedback to summary
public ByteBuffer reserved()
Returns:ByteBuffer

a ByteBuffer view of the reserved field.

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

the value at the specified index of the reserved field.

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

Copies the specified ByteBuffer to the reserved field.

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

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

setback to summary
public CUmemPoolProps set(int allocType, int handleTypes, CUmemLocation location, long win32SecurityAttributes, ByteBuffer reserved)

Initializes this struct with the specified values.

setback to summary
public CUmemPoolProps set(CUmemPoolProps src)

Copies the specified struct data to this struct.

Parameters
src:CUmemPoolProps

the source struct

Returns:CUmemPoolProps

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
win32SecurityAttributesback to summary
public long win32SecurityAttributes()
Returns:long

the value of the win32SecurityAttributes field.

Annotations
@NativeType:void *
win32SecurityAttributesback to summary
public CUmemPoolProps win32SecurityAttributes(long value)

Sets the specified value to the win32SecurityAttributes field.

org.lwjgl.cuda back to summary

public Class CUmemPoolProps.Buffer

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

An array of CUmemPoolProps structs.

Field Summary

Modifier and TypeField and Description
private static final CUmemPoolProps

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CUmemPoolProps.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 allocType field.
allocType
()

public CUmemPoolProps.Buffer
allocType(int value)

Sets the specified value to the allocType field.

protected CUmemPoolProps
public int

Returns:

the value of the handleTypes field.
handleTypes
()

public CUmemPoolProps.Buffer
handleTypes(int value)

Sets the specified value to the handleTypes field.

public CUmemLocation

Returns:

a CUmemLocation view of the location field.
location
()

public CUmemPoolProps.Buffer
location(CUmemLocation value)

Copies the specified CUmemLocation to the location field.

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

Passes the location field to the specified Consumer.

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 CUmemPoolProps.Buffer
reserved(ByteBuffer value)

Copies the specified ByteBuffer to the reserved field.

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

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

protected CUmemPoolProps.Buffer
public long

Returns:

the value of the win32SecurityAttributes field.
win32SecurityAttributes
()

public CUmemPoolProps.Buffer
win32SecurityAttributes(long value)

Sets the specified value to the win32SecurityAttributes field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CUmemPoolProps ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

allocTypeback to summary
public int allocType()
Returns:int

the value of the allocType field.

Annotations
@NativeType:CUmemAllocationType
allocTypeback to summary
public CUmemPoolProps.Buffer allocType(int value)

Sets the specified value to the allocType field.

getElementFactoryback to summary
protected CUmemPoolProps getElementFactory()

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

Annotations
@Override
handleTypesback to summary
public int handleTypes()
Returns:int

the value of the handleTypes field.

Annotations
@NativeType:CUmemAllocationHandleType
handleTypesback to summary
public CUmemPoolProps.Buffer handleTypes(int value)

Sets the specified value to the handleTypes field.

locationback to summary
public CUmemLocation location()
Returns:CUmemLocation

a CUmemLocation view of the location field.

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

Copies the specified CUmemLocation to the location field.

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

Passes the location field to the specified Consumer.

reservedback to summary
public ByteBuffer reserved()
Returns:ByteBuffer

a ByteBuffer view of the reserved field.

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

the value at the specified index of the reserved field.

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

Copies the specified ByteBuffer to the reserved field.

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

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

selfback to summary
protected CUmemPoolProps.Buffer self()

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

Annotations
@Override
win32SecurityAttributesback to summary
public long win32SecurityAttributes()
Returns:long

the value of the win32SecurityAttributes field.

Annotations
@NativeType:void *
win32SecurityAttributesback to summary
public CUmemPoolProps.Buffer win32SecurityAttributes(long value)

Sets the specified value to the win32SecurityAttributes field.