Top Description Inners Fields Constructors Methods
org.lwjgl.llvm

public Class CXPlatformAvailability

extends Struct<CXPlatformAvailability>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Describes the availability of a given entity on a particular platform, e.g., a particular class might only be available on Mac OS 10.7 or newer.

Layout


struct CXPlatformAvailability {
    CXString Platform;
    CXVersion Introduced;
    CXVersion Deprecated;
    CXVersion Obsoleted;
    int Unavailable;
    CXString Message;
}

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
DEPRECATED

The struct member offsets.

public static final int
INTRODUCED

The struct member offsets.

public static final int
MESSAGE

The struct member offsets.

public static final int
OBSOLETED

The struct member offsets.

public static final int
PLATFORM

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
UNAVAILABLE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
CXPlatformAvailability(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static CXPlatformAvailability
calloc()

Returns a new CXPlatformAvailability instance allocated with memCalloc.

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

Returns a new CXPlatformAvailability.Buffer instance allocated with memCalloc.

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

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

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

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

public static CXPlatformAvailability
callocStack()

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

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

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

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

Returns a new CXPlatformAvailability instance allocated with BufferUtils.

public static CXPlatformAvailability
create(long address)

Returns a new CXPlatformAvailability instance for the specified memory address.

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

Returns a new CXPlatformAvailability.Buffer instance allocated with BufferUtils.

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

Create a CXPlatformAvailability.Buffer instance at the specified memory.

public static CXPlatformAvailability
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public CXVersion
Deprecated()

the version number in which this entity was deprecated (but is still available)

public CXVersion
Introduced()

the version number in which this entity was introduced

public static CXPlatformAvailability
malloc()

Returns a new CXPlatformAvailability instance allocated with memAlloc.

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

Returns a new CXPlatformAvailability.Buffer instance allocated with memAlloc.

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

Returns a new CXPlatformAvailability instance allocated on the specified MemoryStack.

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

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

public static CXPlatformAvailability
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public CXString
Message()

an optional message to provide to a user of this API, e.g., to suggest replacement APIs

public static CXVersion
nDeprecated(long struct)

Unsafe version of Deprecated.

public static CXVersion
nIntroduced(long struct)

Unsafe version of Introduced.

public static CXString
nMessage(long struct)

Unsafe version of Message.

public static CXVersion
nObsoleted(long struct)

Unsafe version of Obsoleted.

public static CXString
nPlatform(long struct)

Unsafe version of Platform.

public static int
nUnavailable(long struct)

Unsafe version of Unavailable.

public CXVersion
Obsoleted()

the version number in which this entity was obsoleted, and therefore is no longer available

public CXString
Platform()

a string that describes the platform for which this structure provides availability information.

public int
sizeof()

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

Returns sizeof(struct).
public int
Unavailable()

whether the entity is unconditionally unavailable on this platform

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.

DEPRECATEDback to summary
public static final int DEPRECATED

The struct member offsets.

INTRODUCEDback to summary
public static final int INTRODUCED

The struct member offsets.

MESSAGEback to summary
public static final int MESSAGE

The struct member offsets.

OBSOLETEDback to summary
public static final int OBSOLETED

The struct member offsets.

PLATFORMback to summary
public static final int PLATFORM

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

UNAVAILABLEback to summary
public static final int UNAVAILABLE

The struct member offsets.

Constructor Detail

CXPlatformAvailabilityback to summary
protected CXPlatformAvailability(long address, ByteBuffer container)
CXPlatformAvailabilityback to summary
public CXPlatformAvailability(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CXPlatformAvailability calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new CXPlatformAvailability instance allocated with BufferUtils.

createback to summary
public static CXPlatformAvailability create(long address)

Returns a new CXPlatformAvailability instance for the specified memory address.

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

Returns a new CXPlatformAvailability.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a CXPlatformAvailability.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CXPlatformAvailability createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
Deprecatedback to summary
public CXVersion Deprecated()

the version number in which this entity was deprecated (but is still available)

Introducedback to summary
public CXVersion Introduced()

the version number in which this entity was introduced

mallocback to summary
public static CXPlatformAvailability malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CXPlatformAvailability malloc(MemoryStack stack)

Returns a new CXPlatformAvailability instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
Messageback to summary
public CXString Message()

an optional message to provide to a user of this API, e.g., to suggest replacement APIs

nDeprecatedback to summary
public static CXVersion nDeprecated(long struct)

Unsafe version of Deprecated.

nIntroducedback to summary
public static CXVersion nIntroduced(long struct)

Unsafe version of Introduced.

nMessageback to summary
public static CXString nMessage(long struct)

Unsafe version of Message.

nObsoletedback to summary
public static CXVersion nObsoleted(long struct)

Unsafe version of Obsoleted.

nPlatformback to summary
public static CXString nPlatform(long struct)

Unsafe version of Platform.

nUnavailableback to summary
public static int nUnavailable(long struct)

Unsafe version of Unavailable.

Obsoletedback to summary
public CXVersion Obsoleted()

the version number in which this entity was obsoleted, and therefore is no longer available

Platformback to summary
public CXString Platform()

a string that describes the platform for which this structure provides availability information.

Possible values are "ios" or "macos".

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
Unavailableback to summary
public int Unavailable()

whether the entity is unconditionally unavailable on this platform

org.lwjgl.llvm back to summary

public Class CXPlatformAvailability.Buffer

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

An array of CXPlatformAvailability structs.

Field Summary

Modifier and TypeField and Description
private static final CXPlatformAvailability

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CXPlatformAvailability.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 CXVersion
protected CXPlatformAvailability
public CXVersion
public CXString

Returns:

a CXString view of the CXPlatformAvailability#Message field.
Message
()

public CXVersion

Returns:

a CXVersion view of the CXPlatformAvailability#Obsoleted field.
Obsoleted
()

public CXString

Returns:

a CXString view of the CXPlatformAvailability#Platform field.
Platform
()

protected CXPlatformAvailability.Buffer
public int

Returns:

the value of the CXPlatformAvailability#Unavailable field.
Unavailable
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CXPlatformAvailability ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

Deprecatedback to summary
public CXVersion Deprecated()
Returns:CXVersion

a CXVersion view of the CXPlatformAvailability#Deprecated field.

getElementFactoryback to summary
protected CXPlatformAvailability getElementFactory()

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

Annotations
@Override
Introducedback to summary
public CXVersion Introduced()
Returns:CXVersion

a CXVersion view of the CXPlatformAvailability#Introduced field.

Messageback to summary
public CXString Message()
Returns:CXString

a CXString view of the CXPlatformAvailability#Message field.

Obsoletedback to summary
public CXVersion Obsoleted()
Returns:CXVersion

a CXVersion view of the CXPlatformAvailability#Obsoleted field.

Platformback to summary
public CXString Platform()
Returns:CXString

a CXString view of the CXPlatformAvailability#Platform field.

selfback to summary
protected CXPlatformAvailability.Buffer self()

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

Annotations
@Override
Unavailableback to summary
public int Unavailable()
Returns:int

the value of the CXPlatformAvailability#Unavailable field.