Top Description Inners Fields Constructors Methods
org.lwjgl.opencl

public Class CLDeviceTopologyAMD

extends Struct<CLDeviceTopologyAMD>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:union cl_device_topology_amd
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
The struct returned by GetDeviceInfo with param_name set to DEVICE_TOPOLOGY_AMD.

Layout


union cl_device_topology_amd {
    struct {
        cl_uint type;
        cl_uint data[5];
    } raw;
    struct {
        cl_uint type;
        char[17];
        cl_char bus;
        cl_char device;
        cl_char function;
    } pcie;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
CLDeviceTopologyAMD.Buffer

An array of CLDeviceTopologyAMD structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PCIE

The struct member offsets.

public static final int
PCIE_BUS

The struct member offsets.

public static final int
PCIE_DEVICE

The struct member offsets.

public static final int
PCIE_FUNCTION

The struct member offsets.

public static final int
PCIE_TYPE

The struct member offsets.

public static final int
RAW

The struct member offsets.

public static final int
RAW_DATA

The struct member offsets.

public static final int
RAW_TYPE

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

public
CLDeviceTopologyAMD(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static CLDeviceTopologyAMD
calloc()

Returns a new CLDeviceTopologyAMD instance allocated with memCalloc.

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

Returns a new CLDeviceTopologyAMD.Buffer instance allocated with memCalloc.

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

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

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

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

public static CLDeviceTopologyAMD
callocStack()

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

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

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

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

Returns a new CLDeviceTopologyAMD instance allocated with BufferUtils.

public static CLDeviceTopologyAMD
create(long address)

Returns a new CLDeviceTopologyAMD instance for the specified memory address.

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

Returns a new CLDeviceTopologyAMD.Buffer instance allocated with BufferUtils.

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

Create a CLDeviceTopologyAMD.Buffer instance at the specified memory.

public static CLDeviceTopologyAMD
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static CLDeviceTopologyAMD
malloc()

Returns a new CLDeviceTopologyAMD instance allocated with memAlloc.

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

Returns a new CLDeviceTopologyAMD.Buffer instance allocated with memAlloc.

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

Returns a new CLDeviceTopologyAMD instance allocated on the specified MemoryStack.

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

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

public static CLDeviceTopologyAMD
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static byte
npcie_bus(long struct)

Unsafe version of pcie_bus.

public static byte
npcie_device(long struct)

Unsafe version of pcie_device.

public static byte
npcie_function(long struct)

Unsafe version of pcie_function.

public static int
npcie_type(long struct)

Unsafe version of pcie_type.

public static IntBuffer
nraw_data(long struct)

Unsafe version of raw_data.

public static int
nraw_data(long struct, int index)

Unsafe version of raw_data.

public static int
nraw_type(long struct)

Unsafe version of raw_type.

public byte

Returns:

the value of the pcie.bus field.
pcie_bus()

public byte

Returns:

the value of the pcie.device field.
pcie_device()

public byte

Returns:

the value of the pcie.function field.
pcie_function()

public int

Returns:

the value of the pcie.type field.
pcie_type()

public IntBuffer

Returns:

a IntBuffer view of the raw.data field.
raw_data()

public int

Returns:

the value at the specified index of the raw.data field.
raw_data(int index)

public int

Returns:

the value of the raw.type field.
raw_type()

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.

PCIEback to summary
public static final int PCIE

The struct member offsets.

PCIE_BUSback to summary
public static final int PCIE_BUS

The struct member offsets.

PCIE_DEVICEback to summary
public static final int PCIE_DEVICE

The struct member offsets.

PCIE_FUNCTIONback to summary
public static final int PCIE_FUNCTION

The struct member offsets.

PCIE_TYPEback to summary
public static final int PCIE_TYPE

The struct member offsets.

RAWback to summary
public static final int RAW

The struct member offsets.

RAW_DATAback to summary
public static final int RAW_DATA

The struct member offsets.

RAW_TYPEback to summary
public static final int RAW_TYPE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

CLDeviceTopologyAMDback to summary
protected CLDeviceTopologyAMD(long address, ByteBuffer container)
CLDeviceTopologyAMDback to summary
public CLDeviceTopologyAMD(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CLDeviceTopologyAMD calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new CLDeviceTopologyAMD instance allocated with BufferUtils.

createback to summary
public static CLDeviceTopologyAMD create(long address)

Returns a new CLDeviceTopologyAMD instance for the specified memory address.

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

Returns a new CLDeviceTopologyAMD.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a CLDeviceTopologyAMD.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CLDeviceTopologyAMD createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CLDeviceTopologyAMD malloc(MemoryStack stack)

Returns a new CLDeviceTopologyAMD instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
npcie_busback to summary
public static byte npcie_bus(long struct)

Unsafe version of pcie_bus.

npcie_deviceback to summary
public static byte npcie_device(long struct)

Unsafe version of pcie_device.

npcie_functionback to summary
public static byte npcie_function(long struct)

Unsafe version of pcie_function.

npcie_typeback to summary
public static int npcie_type(long struct)

Unsafe version of pcie_type.

nraw_databack to summary
public static IntBuffer nraw_data(long struct)

Unsafe version of raw_data.

nraw_databack to summary
public static int nraw_data(long struct, int index)

Unsafe version of raw_data.

nraw_typeback to summary
public static int nraw_type(long struct)

Unsafe version of raw_type.

pcie_busback to summary
public byte pcie_bus()
Returns:byte

the value of the pcie.bus field.

Annotations
@NativeType:cl_char
pcie_deviceback to summary
public byte pcie_device()
Returns:byte

the value of the pcie.device field.

Annotations
@NativeType:cl_char
pcie_functionback to summary
public byte pcie_function()
Returns:byte

the value of the pcie.function field.

Annotations
@NativeType:cl_char
pcie_typeback to summary
public int pcie_type()
Returns:int

the value of the pcie.type field.

Annotations
@NativeType:cl_uint
raw_databack to summary
public IntBuffer raw_data()
Returns:IntBuffer

a IntBuffer view of the raw.data field.

Annotations
@NativeType:cl_uint[5]
raw_databack to summary
public int raw_data(int index)
Returns:int

the value at the specified index of the raw.data field.

Annotations
@NativeType:cl_uint
raw_typeback to summary
public int raw_type()
Returns:int

the value of the raw.type field.

Annotations
@NativeType:cl_uint
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.opencl back to summary

public Class CLDeviceTopologyAMD.Buffer

extends StructBuffer<CLDeviceTopologyAMD, CLDeviceTopologyAMD.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of CLDeviceTopologyAMD structs.

Field Summary

Modifier and TypeField and Description
private static final CLDeviceTopologyAMD
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

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

public byte

Returns:

the value of the pcie.bus field.
pcie_bus()

public byte

Returns:

the value of the pcie.device field.
pcie_device()

public byte

Returns:

the value of the pcie.function field.
pcie_function()

public int

Returns:

the value of the pcie.type field.
pcie_type()

public IntBuffer

Returns:

a IntBuffer view of the raw.data field.
raw_data()

public int

Returns:

the value at the specified index of the raw.data field.
raw_data(int index)

public int

Returns:

the value of the raw.type field.
raw_type()

protected CLDeviceTopologyAMD.Buffer
self()

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

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CLDeviceTopologyAMD ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
pcie_busback to summary
public byte pcie_bus()
Returns:byte

the value of the pcie.bus field.

Annotations
@NativeType:cl_char
pcie_deviceback to summary
public byte pcie_device()
Returns:byte

the value of the pcie.device field.

Annotations
@NativeType:cl_char
pcie_functionback to summary
public byte pcie_function()
Returns:byte

the value of the pcie.function field.

Annotations
@NativeType:cl_char
pcie_typeback to summary
public int pcie_type()
Returns:int

the value of the pcie.type field.

Annotations
@NativeType:cl_uint
raw_databack to summary
public IntBuffer raw_data()
Returns:IntBuffer

a IntBuffer view of the raw.data field.

Annotations
@NativeType:cl_uint[5]
raw_databack to summary
public int raw_data(int index)
Returns:int

the value at the specified index of the raw.data field.

Annotations
@NativeType:cl_uint
raw_typeback to summary
public int raw_type()
Returns:int

the value of the raw.type field.

Annotations
@NativeType:cl_uint
selfback to summary
protected CLDeviceTopologyAMD.Buffer self()

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

Annotations
@Override