Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSystemGraphicsProperties

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

Graphics-related properties of a particular system.
See Also

XrSystemProperties, XrSystemTrackingProperties, GetSystem, GetSystemProperties

Layout


struct XrSystemGraphicsProperties {
    uint32_t maxSwapchainImageHeight;
    uint32_t maxSwapchainImageWidth;
    uint32_t maxLayerCount;
}

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
MAXLAYERCOUNT

The struct member offsets.

public static final int
MAXSWAPCHAINIMAGEHEIGHT

The struct member offsets.

public static final int
MAXSWAPCHAINIMAGEWIDTH

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

public
XrSystemGraphicsProperties(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSystemGraphicsProperties
calloc()

Returns a new XrSystemGraphicsProperties instance allocated with memCalloc.

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

Returns a new XrSystemGraphicsProperties.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrSystemGraphicsProperties instance allocated with BufferUtils.

public static XrSystemGraphicsProperties
create(long address)

Returns a new XrSystemGraphicsProperties instance for the specified memory address.

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

Returns a new XrSystemGraphicsProperties.Buffer instance allocated with BufferUtils.

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

Create a XrSystemGraphicsProperties.Buffer instance at the specified memory.

public static XrSystemGraphicsProperties
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrSystemGraphicsProperties
malloc()

Returns a new XrSystemGraphicsProperties instance allocated with memAlloc.

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

Returns a new XrSystemGraphicsProperties.Buffer instance allocated with memAlloc.

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

Returns a new XrSystemGraphicsProperties instance allocated on the specified MemoryStack.

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

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

public int
maxLayerCount()

the maximum number of composition layers supported by this system.

public XrSystemGraphicsProperties
maxLayerCount(int value)

Sets the specified value to the maxLayerCount field.

public int
maxSwapchainImageHeight()

the maximum swapchain image pixel height supported by this system.

public XrSystemGraphicsProperties
maxSwapchainImageHeight(int value)

Sets the specified value to the maxSwapchainImageHeight field.

public int
maxSwapchainImageWidth()

the maximum swapchain image pixel width supported by this system.

public XrSystemGraphicsProperties
maxSwapchainImageWidth(int value)

Sets the specified value to the maxSwapchainImageWidth field.

public static int
nmaxLayerCount(long struct)

Unsafe version of maxLayerCount.

public static void
nmaxLayerCount(long struct, int value)

Unsafe version of maxLayerCount.

public static int
nmaxSwapchainImageHeight(long struct)

Unsafe version of maxSwapchainImageHeight.

public static void
nmaxSwapchainImageHeight(long struct, int value)

Unsafe version of maxSwapchainImageHeight.

public static int
nmaxSwapchainImageWidth(long struct)

Unsafe version of maxSwapchainImageWidth.

public static void
nmaxSwapchainImageWidth(long struct, int value)

Unsafe version of maxSwapchainImageWidth.

public XrSystemGraphicsProperties
set(int maxSwapchainImageHeight, int maxSwapchainImageWidth, int maxLayerCount)

Initializes this struct with the specified values.

public XrSystemGraphicsProperties

Returns:

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

MAXLAYERCOUNTback to summary
public static final int MAXLAYERCOUNT

The struct member offsets.

MAXSWAPCHAINIMAGEHEIGHTback to summary
public static final int MAXSWAPCHAINIMAGEHEIGHT

The struct member offsets.

MAXSWAPCHAINIMAGEWIDTHback to summary
public static final int MAXSWAPCHAINIMAGEWIDTH

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

XrSystemGraphicsPropertiesback to summary
protected XrSystemGraphicsProperties(long address, ByteBuffer container)
XrSystemGraphicsPropertiesback to summary
public XrSystemGraphicsProperties(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSystemGraphicsProperties calloc(MemoryStack stack)

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

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

Returns a new XrSystemGraphicsProperties instance allocated with BufferUtils.

createback to summary
public static XrSystemGraphicsProperties create(long address)

Returns a new XrSystemGraphicsProperties instance for the specified memory address.

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

Returns a new XrSystemGraphicsProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSystemGraphicsProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSystemGraphicsProperties createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSystemGraphicsProperties malloc(MemoryStack stack)

Returns a new XrSystemGraphicsProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

maxLayerCountback to summary
public int maxLayerCount()

the maximum number of composition layers supported by this system. The runtime must support at least MIN_COMPOSITION_LAYERS_SUPPORTED layers.

Annotations
@NativeType:uint32_t
maxLayerCountback to summary
public XrSystemGraphicsProperties maxLayerCount(int value)

Sets the specified value to the maxLayerCount field.

maxSwapchainImageHeightback to summary
public int maxSwapchainImageHeight()

the maximum swapchain image pixel height supported by this system.

Annotations
@NativeType:uint32_t
maxSwapchainImageHeightback to summary
public XrSystemGraphicsProperties maxSwapchainImageHeight(int value)

Sets the specified value to the maxSwapchainImageHeight field.

maxSwapchainImageWidthback to summary
public int maxSwapchainImageWidth()

the maximum swapchain image pixel width supported by this system.

Annotations
@NativeType:uint32_t
maxSwapchainImageWidthback to summary
public XrSystemGraphicsProperties maxSwapchainImageWidth(int value)

Sets the specified value to the maxSwapchainImageWidth field.

nmaxLayerCountback to summary
public static int nmaxLayerCount(long struct)

Unsafe version of maxLayerCount.

nmaxLayerCountback to summary
public static void nmaxLayerCount(long struct, int value)

Unsafe version of maxLayerCount.

nmaxSwapchainImageHeightback to summary
public static int nmaxSwapchainImageHeight(long struct)

Unsafe version of maxSwapchainImageHeight.

nmaxSwapchainImageHeightback to summary
public static void nmaxSwapchainImageHeight(long struct, int value)

Unsafe version of maxSwapchainImageHeight.

nmaxSwapchainImageWidthback to summary
public static int nmaxSwapchainImageWidth(long struct)

Unsafe version of maxSwapchainImageWidth.

nmaxSwapchainImageWidthback to summary
public static void nmaxSwapchainImageWidth(long struct, int value)

Unsafe version of maxSwapchainImageWidth.

setback to summary
public XrSystemGraphicsProperties set(int maxSwapchainImageHeight, int maxSwapchainImageWidth, int maxLayerCount)

Initializes this struct with the specified values.

setback to summary
public XrSystemGraphicsProperties set(XrSystemGraphicsProperties src)

Copies the specified struct data to this struct.

Parameters
src:XrSystemGraphicsProperties

the source struct

Returns:XrSystemGraphicsProperties

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.openxr back to summary

public Class XrSystemGraphicsProperties.Buffer

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

An array of XrSystemGraphicsProperties structs.

Field Summary

Modifier and TypeField and Description
private static final XrSystemGraphicsProperties

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSystemGraphicsProperties.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 XrSystemGraphicsProperties
public int

Returns:

the value of the XrSystemGraphicsProperties#maxLayerCount field.
maxLayerCount
()

public XrSystemGraphicsProperties.Buffer
maxLayerCount(int value)

Sets the specified value to the XrSystemGraphicsProperties#maxLayerCount field.

public int
public XrSystemGraphicsProperties.Buffer
maxSwapchainImageHeight(int value)

Sets the specified value to the XrSystemGraphicsProperties#maxSwapchainImageHeight field.

public int
public XrSystemGraphicsProperties.Buffer
maxSwapchainImageWidth(int value)

Sets the specified value to the XrSystemGraphicsProperties#maxSwapchainImageWidth field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSystemGraphicsProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
maxLayerCountback to summary
public int maxLayerCount()
Returns:int

the value of the XrSystemGraphicsProperties#maxLayerCount field.

Annotations
@NativeType:uint32_t
maxLayerCountback to summary
public XrSystemGraphicsProperties.Buffer maxLayerCount(int value)

Sets the specified value to the XrSystemGraphicsProperties#maxLayerCount field.

maxSwapchainImageHeightback to summary
public int maxSwapchainImageHeight()
Returns:int

the value of the XrSystemGraphicsProperties#maxSwapchainImageHeight field.

Annotations
@NativeType:uint32_t
maxSwapchainImageHeightback to summary
public XrSystemGraphicsProperties.Buffer maxSwapchainImageHeight(int value)

Sets the specified value to the XrSystemGraphicsProperties#maxSwapchainImageHeight field.

maxSwapchainImageWidthback to summary
public int maxSwapchainImageWidth()
Returns:int

the value of the XrSystemGraphicsProperties#maxSwapchainImageWidth field.

Annotations
@NativeType:uint32_t
maxSwapchainImageWidthback to summary
public XrSystemGraphicsProperties.Buffer maxSwapchainImageWidth(int value)

Sets the specified value to the XrSystemGraphicsProperties#maxSwapchainImageWidth field.

selfback to summary
protected XrSystemGraphicsProperties.Buffer self()

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

Annotations
@Override