Top Description Inners Fields Constructors Methods
org.lwjgl.util.hwloc

public Class hwloc_location

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

Layout


struct hwloc_location {
    enum hwloc_location_type_e type;
    hwloc_location_u location;
}

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
LOCATION

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

public
hwloc_location(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static hwloc_location
calloc()

Returns a new hwloc_location instance allocated with memCalloc.

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

Returns a new hwloc_location.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new hwloc_location instance allocated with BufferUtils.

public static hwloc_location
create(long address)

Returns a new hwloc_location instance for the specified memory address.

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

Returns a new hwloc_location.Buffer instance allocated with BufferUtils.

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

Create a hwloc_location.Buffer instance at the specified memory.

public static hwloc_location
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public hwloc_location_u

Returns:

a hwloc_location_u view of the location field.
location
()

public static hwloc_location
malloc()

Returns a new hwloc_location instance allocated with memAlloc.

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

Returns a new hwloc_location.Buffer instance allocated with memAlloc.

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

Returns a new hwloc_location instance allocated on the specified MemoryStack.

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

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

public static hwloc_location_u
nlocation(long struct)

Unsafe version of location.

public static int
ntype(long struct)

Unsafe version of type.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int

Returns:

the value of the type field.
type
()

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.

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.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

hwloc_locationback to summary
protected hwloc_location(long address, ByteBuffer container)
hwloc_locationback to summary
public hwloc_location(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static hwloc_location calloc(MemoryStack stack)

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

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

Returns a new hwloc_location instance allocated with BufferUtils.

createback to summary
public static hwloc_location create(long address)

Returns a new hwloc_location instance for the specified memory address.

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

Returns a new hwloc_location.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a hwloc_location.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static hwloc_location createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
locationback to summary
public hwloc_location_u location()
Returns:hwloc_location_u

a hwloc_location_u view of the location field.

mallocback to summary
public static hwloc_location malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static hwloc_location malloc(MemoryStack stack)

Returns a new hwloc_location instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nlocationback to summary
public static hwloc_location_u nlocation(long struct)

Unsafe version of location.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

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:enum hwloc_location_type_e
org.lwjgl.util.hwloc back to summary

public Class hwloc_location.Buffer

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

An array of hwloc_location structs.

Field Summary

Modifier and TypeField and Description
private static final hwloc_location

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new hwloc_location.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 hwloc_location
public hwloc_location_u

Returns:

a hwloc_location_u view of the location field.
location
()

protected hwloc_location.Buffer
public int

Returns:

the value of the type field.
type
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final hwloc_location ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

a hwloc_location_u view of the location field.

selfback to summary
protected hwloc_location.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:enum hwloc_location_type_e