Class XrSecondaryViewConfigurationLayerInfoMSFT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrSecondaryViewConfigurationLayerInfoMSFT
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrSecondaryViewConfigurationLayerInfoMSFT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceDescribe an array of composition layers to be submitted to givenXrViewConfigurationType.Description
This structure is similar to the
XrFrameEndInfostructure, with an extraXrViewConfigurationTypefield to specify the view configuration for which the submitted layers will be rendered.The application should render its content for both the primary and secondary view configurations using the same
predictedDisplayTimereported byWaitFrame. The runtime must treat both the primary views and secondary views as being submitted for the samedisplayTimespecified in the call toEndFrame.For layers such as quad layers whose content is identical across view configurations, the application can submit the same
XrCompositionLayerBaseHeaderstructures to multiple view configurations in the sameEndFramefunction call.For each frame, the application should only render and submit layers for the secondary view configurations that were active that frame, as indicated in the
XrSecondaryViewConfigurationFrameStateMSFTfilled in for that frame’sWaitFramecall. The runtime must ignore composition layers submitted for an inactive view configuration.Valid Usage (Implicit)
- The
XR_MSFT_secondary_view_configurationextension must be enabled prior to usingXrSecondaryViewConfigurationLayerInfoMSFT typemust beTYPE_SECONDARY_VIEW_CONFIGURATION_LAYER_INFO_MSFTnextmust beNULLor a valid pointer to the next structure in a structure chainviewConfigurationTypemust be a validXrViewConfigurationTypevalueenvironmentBlendModemust be a validXrEnvironmentBlendModevaluelayersmust be a pointer to an array oflayerCountvalidXrCompositionLayerBaseHeader-based structures. See also:XrCompositionLayerCubeKHR,XrCompositionLayerCylinderKHR,XrCompositionLayerEquirect2KHR,XrCompositionLayerEquirectKHR,XrCompositionLayerProjection,XrCompositionLayerQuad- The
layerCountparameter must be greater than 0
See Also
XrCompositionLayerBaseHeader,XrSecondaryViewConfigurationFrameEndInfoMSFT,EndFrameLayout
struct XrSecondaryViewConfigurationLayerInfoMSFT { XrStructureTypetype(); void const *next(); XrViewConfigurationTypeviewConfigurationType(); XrEnvironmentBlendModeenvironmentBlendMode(); uint32_tlayerCount();XrCompositionLayerBaseHeaderconst * const *layers(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrSecondaryViewConfigurationLayerInfoMSFT.BufferAn array ofXrSecondaryViewConfigurationLayerInfoMSFTstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intENVIRONMENTBLENDMODE
LAYERCOUNT
LAYERS
NEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intTYPE
VIEWCONFIGURATIONTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrSecondaryViewConfigurationLayerInfoMSFT(java.nio.ByteBuffer container)Creates aXrSecondaryViewConfigurationLayerInfoMSFTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static XrSecondaryViewConfigurationLayerInfoMSFTcalloc()Returns a newXrSecondaryViewConfigurationLayerInfoMSFTinstance allocated withmemCalloc.static XrSecondaryViewConfigurationLayerInfoMSFT.Buffercalloc(int capacity)Returns a newXrSecondaryViewConfigurationLayerInfoMSFT.Bufferinstance allocated withmemCalloc.static XrSecondaryViewConfigurationLayerInfoMSFT.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrSecondaryViewConfigurationLayerInfoMSFT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrSecondaryViewConfigurationLayerInfoMSFTcalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrSecondaryViewConfigurationLayerInfoMSFTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrSecondaryViewConfigurationLayerInfoMSFTcreate()Returns a newXrSecondaryViewConfigurationLayerInfoMSFTinstance allocated withBufferUtils.static XrSecondaryViewConfigurationLayerInfoMSFT.Buffercreate(int capacity)Returns a newXrSecondaryViewConfigurationLayerInfoMSFT.Bufferinstance allocated withBufferUtils.static XrSecondaryViewConfigurationLayerInfoMSFTcreate(long address)Returns a newXrSecondaryViewConfigurationLayerInfoMSFTinstance for the specified memory address.static XrSecondaryViewConfigurationLayerInfoMSFT.Buffercreate(long address, int capacity)Create aXrSecondaryViewConfigurationLayerInfoMSFT.Bufferinstance at the specified memory.static XrSecondaryViewConfigurationLayerInfoMSFTcreateSafe(long address)static XrSecondaryViewConfigurationLayerInfoMSFT.BuffercreateSafe(long address, int capacity)intenvironmentBlendMode()theXrEnvironmentBlendModevalue representing the desired environment blend mode for this view configuration.XrSecondaryViewConfigurationLayerInfoMSFTenvironmentBlendMode(int value)Sets the specified value to theenvironmentBlendMode()field.intlayerCount()the number of composition layers in this frame for the secondary view configuration type.org.lwjgl.PointerBufferlayers()a pointer to an array ofXrCompositionLayerBaseHeaderpointers.XrSecondaryViewConfigurationLayerInfoMSFTlayers(org.lwjgl.PointerBuffer value)Sets the address of the specifiedPointerBufferto thelayers()field.static XrSecondaryViewConfigurationLayerInfoMSFTmalloc()Returns a newXrSecondaryViewConfigurationLayerInfoMSFTinstance allocated withmemAlloc.static XrSecondaryViewConfigurationLayerInfoMSFT.Buffermalloc(int capacity)Returns a newXrSecondaryViewConfigurationLayerInfoMSFT.Bufferinstance allocated withmemAlloc.static XrSecondaryViewConfigurationLayerInfoMSFT.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrSecondaryViewConfigurationLayerInfoMSFT.Bufferinstance allocated on the specifiedMemoryStack.static XrSecondaryViewConfigurationLayerInfoMSFTmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrSecondaryViewConfigurationLayerInfoMSFTinstance allocated on the specifiedMemoryStack.static intnenvironmentBlendMode(long struct)Unsafe version ofenvironmentBlendMode().static voidnenvironmentBlendMode(long struct, int value)Unsafe version ofenvironmentBlendMode.longnext()NULLor a pointer to the next structure in a structure chain.XrSecondaryViewConfigurationLayerInfoMSFTnext(long value)Sets the specified value to thenext()field.static intnlayerCount(long struct)Unsafe version oflayerCount().static voidnlayerCount(long struct, int value)Sets the specified value to thelayerCountfield of the specifiedstruct.static org.lwjgl.PointerBuffernlayers(long struct)Unsafe version oflayers.static voidnlayers(long struct, org.lwjgl.PointerBuffer value)Unsafe version oflayers.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.static intnviewConfigurationType(long struct)Unsafe version ofviewConfigurationType().static voidnviewConfigurationType(long struct, int value)Unsafe version ofviewConfigurationType.XrSecondaryViewConfigurationLayerInfoMSFTset(int type, long next, int viewConfigurationType, int environmentBlendMode, org.lwjgl.PointerBuffer layers)Initializes this struct with the specified values.XrSecondaryViewConfigurationLayerInfoMSFTset(XrSecondaryViewConfigurationLayerInfoMSFT src)Copies the specified struct data to this struct.intsizeof()inttype()theXrStructureTypeof this structure.XrSecondaryViewConfigurationLayerInfoMSFTtype(int value)Sets the specified value to thetype()field.XrSecondaryViewConfigurationLayerInfoMSFTtype$Default()Sets theTYPE_SECONDARY_VIEW_CONFIGURATION_LAYER_INFO_MSFTvalue to thetype()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.intviewConfigurationType()XrViewConfigurationTypeto which the composition layers will be displayed.XrSecondaryViewConfigurationLayerInfoMSFTviewConfigurationType(int value)Sets the specified value to theviewConfigurationType()field.
-
-
-
Constructor Detail
-
XrSecondaryViewConfigurationLayerInfoMSFT
public XrSecondaryViewConfigurationLayerInfoMSFT(java.nio.ByteBuffer container)
Creates aXrSecondaryViewConfigurationLayerInfoMSFTinstance at the current position of the specifiedByteBuffercontainer. 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
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
type
public int type()
theXrStructureTypeof this structure.
-
next
public long next()
NULLor a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.
-
viewConfigurationType
public int viewConfigurationType()
XrViewConfigurationTypeto which the composition layers will be displayed.
-
environmentBlendMode
public int environmentBlendMode()
theXrEnvironmentBlendModevalue representing the desired environment blend mode for this view configuration.
-
layerCount
public int layerCount()
the number of composition layers in this frame for the secondary view configuration type. The maximum supported layer count is identified byXrSystemGraphicsProperties::maxLayerCount. If layerCount is greater than the maximum supported layer count thenERROR_LAYER_LIMIT_EXCEEDEDis returned. The runtime must support at leastMIN_COMPOSITION_LAYERS_SUPPORTEDlayers.
-
layers
public org.lwjgl.PointerBuffer layers()
a pointer to an array ofXrCompositionLayerBaseHeaderpointers.
-
type
public XrSecondaryViewConfigurationLayerInfoMSFT type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrSecondaryViewConfigurationLayerInfoMSFT type$Default()
Sets theTYPE_SECONDARY_VIEW_CONFIGURATION_LAYER_INFO_MSFTvalue to thetype()field.
-
next
public XrSecondaryViewConfigurationLayerInfoMSFT next(long value)
Sets the specified value to thenext()field.
-
viewConfigurationType
public XrSecondaryViewConfigurationLayerInfoMSFT viewConfigurationType(int value)
Sets the specified value to theviewConfigurationType()field.
-
environmentBlendMode
public XrSecondaryViewConfigurationLayerInfoMSFT environmentBlendMode(int value)
Sets the specified value to theenvironmentBlendMode()field.
-
layers
public XrSecondaryViewConfigurationLayerInfoMSFT layers(org.lwjgl.PointerBuffer value)
Sets the address of the specifiedPointerBufferto thelayers()field.
-
set
public XrSecondaryViewConfigurationLayerInfoMSFT set(int type, long next, int viewConfigurationType, int environmentBlendMode, org.lwjgl.PointerBuffer layers)
Initializes this struct with the specified values.
-
set
public XrSecondaryViewConfigurationLayerInfoMSFT set(XrSecondaryViewConfigurationLayerInfoMSFT src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrSecondaryViewConfigurationLayerInfoMSFT malloc()
Returns a newXrSecondaryViewConfigurationLayerInfoMSFTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrSecondaryViewConfigurationLayerInfoMSFT calloc()
Returns a newXrSecondaryViewConfigurationLayerInfoMSFTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrSecondaryViewConfigurationLayerInfoMSFT create()
Returns a newXrSecondaryViewConfigurationLayerInfoMSFTinstance allocated withBufferUtils.
-
create
public static XrSecondaryViewConfigurationLayerInfoMSFT create(long address)
Returns a newXrSecondaryViewConfigurationLayerInfoMSFTinstance for the specified memory address.
-
createSafe
@Nullable public static XrSecondaryViewConfigurationLayerInfoMSFT createSafe(long address)
-
malloc
public static XrSecondaryViewConfigurationLayerInfoMSFT.Buffer malloc(int capacity)
Returns a newXrSecondaryViewConfigurationLayerInfoMSFT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrSecondaryViewConfigurationLayerInfoMSFT.Buffer calloc(int capacity)
Returns a newXrSecondaryViewConfigurationLayerInfoMSFT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrSecondaryViewConfigurationLayerInfoMSFT.Buffer create(int capacity)
Returns a newXrSecondaryViewConfigurationLayerInfoMSFT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrSecondaryViewConfigurationLayerInfoMSFT.Buffer create(long address, int capacity)
Create aXrSecondaryViewConfigurationLayerInfoMSFT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrSecondaryViewConfigurationLayerInfoMSFT.Buffer createSafe(long address, int capacity)
-
malloc
public static XrSecondaryViewConfigurationLayerInfoMSFT malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrSecondaryViewConfigurationLayerInfoMSFTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrSecondaryViewConfigurationLayerInfoMSFT calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrSecondaryViewConfigurationLayerInfoMSFTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrSecondaryViewConfigurationLayerInfoMSFT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrSecondaryViewConfigurationLayerInfoMSFT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrSecondaryViewConfigurationLayerInfoMSFT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrSecondaryViewConfigurationLayerInfoMSFT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
nnext
public static long nnext(long struct)
Unsafe version ofnext().
-
nviewConfigurationType
public static int nviewConfigurationType(long struct)
Unsafe version ofviewConfigurationType().
-
nenvironmentBlendMode
public static int nenvironmentBlendMode(long struct)
Unsafe version ofenvironmentBlendMode().
-
nlayerCount
public static int nlayerCount(long struct)
Unsafe version oflayerCount().
-
nlayers
public static org.lwjgl.PointerBuffer nlayers(long struct)
Unsafe version oflayers.
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
nviewConfigurationType
public static void nviewConfigurationType(long struct, int value)Unsafe version ofviewConfigurationType.
-
nenvironmentBlendMode
public static void nenvironmentBlendMode(long struct, int value)Unsafe version ofenvironmentBlendMode.
-
nlayerCount
public static void nlayerCount(long struct, int value)Sets the specified value to thelayerCountfield of the specifiedstruct.
-
nlayers
public static void nlayers(long struct, org.lwjgl.PointerBuffer value)Unsafe version oflayers.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-