org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrViewConfigurationView>

org.lwjgl.openxr.XrViewConfigurationView

All Implemented Interfaces:: AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrViewConfigurationView extends org.lwjgl.system.Struct<XrViewConfigurationView> implements org.lwjgl.system.NativeResource

Individual view configuration.

Description

See XrSwapchainSubImage for more information about XrSwapchainSubImage::imageRect values, and XrSwapchainCreateInfo for more information about creating swapchains appropriately sized to support those XrSwapchainSubImage::imageRect values.

The array of XrViewConfigurationView returned by the runtime must adhere to the rules defined in XrViewConfigurationType, such as the count and association to the left and right eyes.

Valid Usage (Implicit)

type must be TYPE_VIEW_CONFIGURATION_VIEW
next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrFoveatedViewConfigurationViewVARJO, XrViewConfigurationDepthRangeEXT, XrViewConfigurationViewFovEPIC

Layout


 struct XrViewConfigurationView {
     XrStructureType type();
     void * next();
     uint32_t recommendedImageRectWidth();
     uint32_t maxImageRectWidth();
     uint32_t recommendedImageRectHeight();
     uint32_t maxImageRectHeight();
     uint32_t recommendedSwapchainSampleCount();
     uint32_t maxSwapchainSampleCount();
 }

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

XrViewConfigurationView.Buffer

An array of XrViewConfigurationView structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default
Field Summary

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

MAXIMAGERECTHEIGHT

The struct member offsets.

static final int

MAXIMAGERECTWIDTH

The struct member offsets.

static final int

MAXSWAPCHAINSAMPLECOUNT

The struct member offsets.

static final int

NEXT

The struct member offsets.

static final int

RECOMMENDEDIMAGERECTHEIGHT

The struct member offsets.

static final int

RECOMMENDEDIMAGERECTWIDTH

The struct member offsets.

static final int

RECOMMENDEDSWAPCHAINSAMPLECOUNT

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

static final int

TYPE

The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
Constructor Summary

Constructors

Constructor

Description

XrViewConfigurationView(ByteBuffer container)

Creates a XrViewConfigurationView instance at the current position of the specified ByteBuffer container.
Method Summary

Modifier and Type

Method

Description

static XrViewConfigurationView

calloc()

Returns a new XrViewConfigurationView instance allocated with memCalloc.

static XrViewConfigurationView.Buffer

calloc(int capacity)

Returns a new XrViewConfigurationView.Buffer instance allocated with memCalloc.

static XrViewConfigurationView.Buffer

calloc(int capacity, org.lwjgl.system.MemoryStack stack)

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

static XrViewConfigurationView

calloc(org.lwjgl.system.MemoryStack stack)

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

static XrViewConfigurationView

create()

Returns a new XrViewConfigurationView instance allocated with BufferUtils.

static XrViewConfigurationView.Buffer

create(int capacity)

Returns a new XrViewConfigurationView.Buffer instance allocated with BufferUtils.

static XrViewConfigurationView

create(long address)

Returns a new XrViewConfigurationView instance for the specified memory address.

static XrViewConfigurationView.Buffer

create(long address, int capacity)

Create a XrViewConfigurationView.Buffer instance at the specified memory.

static @Nullable XrViewConfigurationView

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable XrViewConfigurationView.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

static XrViewConfigurationView

malloc()

Returns a new XrViewConfigurationView instance allocated with memAlloc.

static XrViewConfigurationView.Buffer

malloc(int capacity)

Returns a new XrViewConfigurationView.Buffer instance allocated with memAlloc.

static XrViewConfigurationView.Buffer

malloc(int capacity, org.lwjgl.system.MemoryStack stack)

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

static XrViewConfigurationView

malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrViewConfigurationView instance allocated on the specified MemoryStack.

int

maxImageRectHeight()

the maximum height of XrSwapchainSubImage::imageRect supported when rendering this view into a swapchain.

XrViewConfigurationView

maxImageRectHeight(int value)

Sets the specified value to the maxImageRectHeight() field.

int

maxImageRectWidth()

the maximum width of XrSwapchainSubImage::imageRect supported when rendering this view into a swapchain.

XrViewConfigurationView

maxImageRectWidth(int value)

Sets the specified value to the maxImageRectWidth() field.

int

maxSwapchainSampleCount()

the maximum number of sub-data element samples supported for swapchain images that will be rendered into for this view.

XrViewConfigurationView

maxSwapchainSampleCount(int value)

Sets the specified value to the maxSwapchainSampleCount() field.

long

next()

NULL or a pointer to the next structure in a structure chain.

XrViewConfigurationView

next(long value)

Sets the specified value to the next() field.

XrViewConfigurationView

next(XrFoveatedViewConfigurationViewVARJO value)

Prepends the specified XrFoveatedViewConfigurationViewVARJO value to the next chain.

XrViewConfigurationView

next(XrViewConfigurationDepthRangeEXT value)

Prepends the specified XrViewConfigurationDepthRangeEXT value to the next chain.

XrViewConfigurationView

next(XrViewConfigurationViewFovEPIC value)

Prepends the specified XrViewConfigurationViewFovEPIC value to the next chain.

static int

nmaxImageRectHeight(long struct)

Unsafe version of maxImageRectHeight().

static void

nmaxImageRectHeight(long struct, int value)

Unsafe version of maxImageRectHeight.

static int

nmaxImageRectWidth(long struct)

Unsafe version of maxImageRectWidth().

static void

nmaxImageRectWidth(long struct, int value)

Unsafe version of maxImageRectWidth.

static int

nmaxSwapchainSampleCount(long struct)

Unsafe version of maxSwapchainSampleCount().

static void

nmaxSwapchainSampleCount(long struct, int value)

Unsafe version of maxSwapchainSampleCount.

static long

nnext(long struct)

Unsafe version of next().

static void

nnext(long struct, long value)

Unsafe version of next.

static int

nrecommendedImageRectHeight(long struct)

Unsafe version of recommendedImageRectHeight().

static void

nrecommendedImageRectHeight(long struct, int value)

Unsafe version of recommendedImageRectHeight.

static int

nrecommendedImageRectWidth(long struct)

Unsafe version of recommendedImageRectWidth().

static void

nrecommendedImageRectWidth(long struct, int value)

Unsafe version of recommendedImageRectWidth.

static int

nrecommendedSwapchainSampleCount(long struct)

Unsafe version of recommendedSwapchainSampleCount().

static void

nrecommendedSwapchainSampleCount(long struct, int value)

Unsafe version of recommendedSwapchainSampleCount.

static int

ntype(long struct)

Unsafe version of type().

static void

ntype(long struct, int value)

Unsafe version of type.

int

recommendedImageRectHeight()

the optimal height of XrSwapchainSubImage::imageRect to use when rendering this view into a swapchain.

XrViewConfigurationView

recommendedImageRectHeight(int value)

Sets the specified value to the recommendedImageRectHeight() field.

int

recommendedImageRectWidth()

the optimal width of XrSwapchainSubImage::imageRect to use when rendering this view into a swapchain.

XrViewConfigurationView

recommendedImageRectWidth(int value)

Sets the specified value to the recommendedImageRectWidth() field.

int

recommendedSwapchainSampleCount()

the recommended number of sub-data element samples to create for each swapchain image that will be rendered into for this view.

XrViewConfigurationView

recommendedSwapchainSampleCount(int value)

Sets the specified value to the recommendedSwapchainSampleCount() field.

XrViewConfigurationView

set(int type, long next, int recommendedImageRectWidth, int maxImageRectWidth, int recommendedImageRectHeight, int maxImageRectHeight, int recommendedSwapchainSampleCount, int maxSwapchainSampleCount)

Initializes this struct with the specified values.

XrViewConfigurationView

set(XrViewConfigurationView src)

Copies the specified struct data to this struct.

int

sizeof()

int

type()

the XrStructureType of this structure.

XrViewConfigurationView

type(int value)

Sets the specified value to the type() field.

XrViewConfigurationView

type$Default()

Sets the TYPE_VIEW_CONFIGURATION_VIEW value to the type() field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Field Details
- SIZEOF
  
  public static final int SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  public static final int ALIGNOF
  
  The struct alignment in bytes.
- TYPE
  
  public static final int TYPE
  
  The struct member offsets.
- NEXT
  
  public static final int NEXT
  
  The struct member offsets.
- RECOMMENDEDIMAGERECTWIDTH
  
  public static final int RECOMMENDEDIMAGERECTWIDTH
  
  The struct member offsets.
- MAXIMAGERECTWIDTH
  
  public static final int MAXIMAGERECTWIDTH
  
  The struct member offsets.
- RECOMMENDEDIMAGERECTHEIGHT
  
  public static final int RECOMMENDEDIMAGERECTHEIGHT
  
  The struct member offsets.
- MAXIMAGERECTHEIGHT
  
  public static final int MAXIMAGERECTHEIGHT
  
  The struct member offsets.
- RECOMMENDEDSWAPCHAINSAMPLECOUNT
  
  public static final int RECOMMENDEDSWAPCHAINSAMPLECOUNT
  
  The struct member offsets.
- MAXSWAPCHAINSAMPLECOUNT
  
  public static final int MAXSWAPCHAINSAMPLECOUNT
  
  The struct member offsets.
Constructor Details
- XrViewConfigurationView
  
  public XrViewConfigurationView(ByteBuffer container)
  
  Creates a XrViewConfigurationView 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 Details
- sizeof
  
  public int sizeof()
  
  Specified by:
  
  sizeof in class org.lwjgl.system.Struct<XrViewConfigurationView>
- type
  
  public int type()
  
  the XrStructureType of this structure.
- next
  
  public long next()
  
  NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.
- recommendedImageRectWidth
  
  public int recommendedImageRectWidth()
  
  the optimal width of XrSwapchainSubImage::imageRect to use when rendering this view into a swapchain.
- maxImageRectWidth
  
  public int maxImageRectWidth()
  
  the maximum width of XrSwapchainSubImage::imageRect supported when rendering this view into a swapchain.
- recommendedImageRectHeight
  
  public int recommendedImageRectHeight()
  
  the optimal height of XrSwapchainSubImage::imageRect to use when rendering this view into a swapchain.
- maxImageRectHeight
  
  public int maxImageRectHeight()
  
  the maximum height of XrSwapchainSubImage::imageRect supported when rendering this view into a swapchain.
- recommendedSwapchainSampleCount
  
  public int recommendedSwapchainSampleCount()
  
  the recommended number of sub-data element samples to create for each swapchain image that will be rendered into for this view.
- maxSwapchainSampleCount
  
  public int maxSwapchainSampleCount()
  
  the maximum number of sub-data element samples supported for swapchain images that will be rendered into for this view.
- type
  
  public XrViewConfigurationView type(int value)
  
  Sets the specified value to the type() field.
- type$Default
  
  public XrViewConfigurationView type$Default()
  
  Sets the TYPE_VIEW_CONFIGURATION_VIEW value to the type() field.
- next
  
  public XrViewConfigurationView next(long value)
  
  Sets the specified value to the next() field.
- next
  
  public XrViewConfigurationView next(XrFoveatedViewConfigurationViewVARJO value)
  
  Prepends the specified XrFoveatedViewConfigurationViewVARJO value to the next chain.
- next
  
  public XrViewConfigurationView next(XrViewConfigurationDepthRangeEXT value)
  
  Prepends the specified XrViewConfigurationDepthRangeEXT value to the next chain.
- next
  
  public XrViewConfigurationView next(XrViewConfigurationViewFovEPIC value)
  
  Prepends the specified XrViewConfigurationViewFovEPIC value to the next chain.
- recommendedImageRectWidth
  
  public XrViewConfigurationView recommendedImageRectWidth(int value)
  
  Sets the specified value to the recommendedImageRectWidth() field.
- maxImageRectWidth
  
  public XrViewConfigurationView maxImageRectWidth(int value)
  
  Sets the specified value to the maxImageRectWidth() field.
- recommendedImageRectHeight
  
  public XrViewConfigurationView recommendedImageRectHeight(int value)
  
  Sets the specified value to the recommendedImageRectHeight() field.
- maxImageRectHeight
  
  public XrViewConfigurationView maxImageRectHeight(int value)
  
  Sets the specified value to the maxImageRectHeight() field.
- recommendedSwapchainSampleCount
  
  public XrViewConfigurationView recommendedSwapchainSampleCount(int value)
  
  Sets the specified value to the recommendedSwapchainSampleCount() field.
- maxSwapchainSampleCount
  
  public XrViewConfigurationView maxSwapchainSampleCount(int value)
  
  Sets the specified value to the maxSwapchainSampleCount() field.
- set
  
  public XrViewConfigurationView set(int type, long next, int recommendedImageRectWidth, int maxImageRectWidth, int recommendedImageRectHeight, int maxImageRectHeight, int recommendedSwapchainSampleCount, int maxSwapchainSampleCount)
  
  Initializes this struct with the specified values.
- set
  
  public XrViewConfigurationView set(XrViewConfigurationView src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static XrViewConfigurationView malloc()
  
  Returns a new XrViewConfigurationView instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static XrViewConfigurationView calloc()
  
  Returns a new XrViewConfigurationView instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static XrViewConfigurationView create()
  
  Returns a new XrViewConfigurationView instance allocated with BufferUtils.
- create
  
  public static XrViewConfigurationView create(long address)
  
  Returns a new XrViewConfigurationView instance for the specified memory address.
- createSafe
  
  public static @Nullable XrViewConfigurationView createSafe(long address)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static XrViewConfigurationView.Buffer malloc(int capacity)
  
  Returns a new XrViewConfigurationView.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static XrViewConfigurationView.Buffer calloc(int capacity)
  
  Returns a new XrViewConfigurationView.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static XrViewConfigurationView.Buffer create(int capacity)
  
  Returns a new XrViewConfigurationView.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static XrViewConfigurationView.Buffer create(long address, int capacity)
  
  Create a XrViewConfigurationView.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable XrViewConfigurationView.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static XrViewConfigurationView malloc(org.lwjgl.system.MemoryStack stack)
  
  Returns a new XrViewConfigurationView instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static XrViewConfigurationView calloc(org.lwjgl.system.MemoryStack stack)
  
  Returns a new XrViewConfigurationView instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  stack - the stack from which to allocate
- malloc
  
  public static XrViewConfigurationView.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Returns a new XrViewConfigurationView.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static XrViewConfigurationView.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Returns a new XrViewConfigurationView.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- ntype
  
  public static int ntype(long struct)
  
  Unsafe version of type().
- nnext
  
  public static long nnext(long struct)
  
  Unsafe version of next().
- nrecommendedImageRectWidth
  
  public static int nrecommendedImageRectWidth(long struct)
  
  Unsafe version of recommendedImageRectWidth().
- nmaxImageRectWidth
  
  public static int nmaxImageRectWidth(long struct)
  
  Unsafe version of maxImageRectWidth().
- nrecommendedImageRectHeight
  
  public static int nrecommendedImageRectHeight(long struct)
  
  Unsafe version of recommendedImageRectHeight().
- nmaxImageRectHeight
  
  public static int nmaxImageRectHeight(long struct)
  
  Unsafe version of maxImageRectHeight().
- nrecommendedSwapchainSampleCount
  
  public static int nrecommendedSwapchainSampleCount(long struct)
  
  Unsafe version of recommendedSwapchainSampleCount().
- nmaxSwapchainSampleCount
  
  public static int nmaxSwapchainSampleCount(long struct)
  
  Unsafe version of maxSwapchainSampleCount().
- ntype
  
  public static void ntype(long struct, int value)
  
  Unsafe version of type.
- nnext
  
  public static void nnext(long struct, long value)
  
  Unsafe version of next.
- nrecommendedImageRectWidth
  
  public static void nrecommendedImageRectWidth(long struct, int value)
  
  Unsafe version of recommendedImageRectWidth.
- nmaxImageRectWidth
  
  public static void nmaxImageRectWidth(long struct, int value)
  
  Unsafe version of maxImageRectWidth.
- nrecommendedImageRectHeight
  
  public static void nrecommendedImageRectHeight(long struct, int value)
  
  Unsafe version of recommendedImageRectHeight.
- nmaxImageRectHeight
  
  public static void nmaxImageRectHeight(long struct, int value)
  
  Unsafe version of maxImageRectHeight.
- nrecommendedSwapchainSampleCount
  
  public static void nrecommendedSwapchainSampleCount(long struct, int value)
  
  Unsafe version of recommendedSwapchainSampleCount.
- nmaxSwapchainSampleCount
  
  public static void nmaxSwapchainSampleCount(long struct, int value)
  
  Unsafe version of maxSwapchainSampleCount.

Class XrViewConfigurationView

Description

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Details

SIZEOF

ALIGNOF

TYPE

NEXT

RECOMMENDEDIMAGERECTWIDTH

MAXIMAGERECTWIDTH

RECOMMENDEDIMAGERECTHEIGHT

MAXIMAGERECTHEIGHT

RECOMMENDEDSWAPCHAINSAMPLECOUNT

MAXSWAPCHAINSAMPLECOUNT

Constructor Details

XrViewConfigurationView

Method Details

sizeof

type

next

recommendedImageRectWidth

maxImageRectWidth

recommendedImageRectHeight

maxImageRectHeight

recommendedSwapchainSampleCount

maxSwapchainSampleCount

type

type$Default

next

next

next

next

recommendedImageRectWidth

maxImageRectWidth

recommendedImageRectHeight

maxImageRectHeight

recommendedSwapchainSampleCount

maxSwapchainSampleCount

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

ntype

nnext

nrecommendedImageRectWidth

nmaxImageRectWidth

nrecommendedImageRectHeight

nmaxImageRectHeight

nrecommendedSwapchainSampleCount

nmaxSwapchainSampleCount

ntype

nnext

nrecommendedImageRectWidth

nmaxImageRectWidth

nrecommendedImageRectHeight