Package org.lwjgl.openxr
Class XrCompositionLayerBaseHeader
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrCompositionLayerBaseHeader
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrCompositionLayerBaseHeader extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceComposition layer base header.Description
All composition layer structures begin with the elements described in the
XrCompositionLayerBaseHeader. TheXrCompositionLayerBaseHeaderstructure is not intended to be directly used, but forms a basis for defining current and future structures containing composition layer information. TheXrFrameEndInfostructure contains an array of pointers to these polymorphic header structures. All composition layer type pointers must be type-castable as anXrCompositionLayerBaseHeaderpointer.Valid Usage (Implicit)
typemust be one of the following XrStructureType values:TYPE_COMPOSITION_LAYER_CUBE_KHR,TYPE_COMPOSITION_LAYER_CYLINDER_KHR,TYPE_COMPOSITION_LAYER_EQUIRECT2_KHR,TYPE_COMPOSITION_LAYER_EQUIRECT_KHR,TYPE_COMPOSITION_LAYER_PROJECTION,TYPE_COMPOSITION_LAYER_QUADnextmust beNULLor a valid pointer to the next structure in a structure chain. See also:XrCompositionLayerAlphaBlendFB,XrCompositionLayerColorScaleBiasKHR,XrCompositionLayerImageLayoutFB,XrCompositionLayerPassthroughFB,XrCompositionLayerSecureContentFBlayerFlagsmust be 0 or a valid combination ofXrCompositionLayerFlagBitsvaluesspacemust be a validXrSpacehandle
See Also
XrFrameEndInfo,XrSecondaryViewConfigurationLayerInfoMSFT,XrSwapchainSubImageLayout
struct XrCompositionLayerBaseHeader { XrStructureTypetype(); void const *next(); XrCompositionLayerFlagslayerFlags(); XrSpacespace(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrCompositionLayerBaseHeader.BufferAn array ofXrCompositionLayerBaseHeaderstructs.
-
Constructor Summary
Constructors Constructor Description XrCompositionLayerBaseHeader(java.nio.ByteBuffer container)Creates aXrCompositionLayerBaseHeaderinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static XrCompositionLayerBaseHeadercalloc()Returns a newXrCompositionLayerBaseHeaderinstance allocated withmemCalloc.static XrCompositionLayerBaseHeader.Buffercalloc(int capacity)Returns a newXrCompositionLayerBaseHeader.Bufferinstance allocated withmemCalloc.static XrCompositionLayerBaseHeader.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrCompositionLayerBaseHeader.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrCompositionLayerBaseHeadercalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrCompositionLayerBaseHeaderinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrCompositionLayerBaseHeadercreate()Returns a newXrCompositionLayerBaseHeaderinstance allocated withBufferUtils.static XrCompositionLayerBaseHeader.Buffercreate(int capacity)Returns a newXrCompositionLayerBaseHeader.Bufferinstance allocated withBufferUtils.static XrCompositionLayerBaseHeadercreate(long address)Returns a newXrCompositionLayerBaseHeaderinstance for the specified memory address.static XrCompositionLayerBaseHeader.Buffercreate(long address, int capacity)Create aXrCompositionLayerBaseHeader.Bufferinstance at the specified memory.static XrCompositionLayerBaseHeadercreate(XrCompositionLayerCubeKHR value)Upcasts the specifiedXrCompositionLayerCubeKHRinstance toXrCompositionLayerBaseHeader.static XrCompositionLayerBaseHeader.Buffercreate(XrCompositionLayerCubeKHR.Buffer value)Upcasts the specifiedXrCompositionLayerCubeKHR.Bufferinstance toXrCompositionLayerBaseHeader.Buffer.static XrCompositionLayerBaseHeadercreate(XrCompositionLayerCylinderKHR value)Upcasts the specifiedXrCompositionLayerCylinderKHRinstance toXrCompositionLayerBaseHeader.static XrCompositionLayerBaseHeader.Buffercreate(XrCompositionLayerCylinderKHR.Buffer value)Upcasts the specifiedXrCompositionLayerCylinderKHR.Bufferinstance toXrCompositionLayerBaseHeader.Buffer.static XrCompositionLayerBaseHeadercreate(XrCompositionLayerEquirect2KHR value)Upcasts the specifiedXrCompositionLayerEquirect2KHRinstance toXrCompositionLayerBaseHeader.static XrCompositionLayerBaseHeader.Buffercreate(XrCompositionLayerEquirect2KHR.Buffer value)Upcasts the specifiedXrCompositionLayerEquirect2KHR.Bufferinstance toXrCompositionLayerBaseHeader.Buffer.static XrCompositionLayerBaseHeadercreate(XrCompositionLayerEquirectKHR value)Upcasts the specifiedXrCompositionLayerEquirectKHRinstance toXrCompositionLayerBaseHeader.static XrCompositionLayerBaseHeader.Buffercreate(XrCompositionLayerEquirectKHR.Buffer value)Upcasts the specifiedXrCompositionLayerEquirectKHR.Bufferinstance toXrCompositionLayerBaseHeader.Buffer.static XrCompositionLayerBaseHeadercreate(XrCompositionLayerProjection value)Upcasts the specifiedXrCompositionLayerProjectioninstance toXrCompositionLayerBaseHeader.static XrCompositionLayerBaseHeader.Buffercreate(XrCompositionLayerProjection.Buffer value)Upcasts the specifiedXrCompositionLayerProjection.Bufferinstance toXrCompositionLayerBaseHeader.Buffer.static XrCompositionLayerBaseHeadercreate(XrCompositionLayerQuad value)Upcasts the specifiedXrCompositionLayerQuadinstance toXrCompositionLayerBaseHeader.static XrCompositionLayerBaseHeader.Buffercreate(XrCompositionLayerQuad.Buffer value)Upcasts the specifiedXrCompositionLayerQuad.Bufferinstance toXrCompositionLayerBaseHeader.Buffer.static XrCompositionLayerBaseHeadercreateSafe(long address)static XrCompositionLayerBaseHeader.BuffercreateSafe(long address, int capacity)longlayerFlags()a bitmask ofXrCompositionLayerFlagBitsdescribing flags to apply to the layer.XrCompositionLayerBaseHeaderlayerFlags(long value)Sets the specified value to thelayerFlags()field.static XrCompositionLayerBaseHeadermalloc()Returns a newXrCompositionLayerBaseHeaderinstance allocated withmemAlloc.static XrCompositionLayerBaseHeader.Buffermalloc(int capacity)Returns a newXrCompositionLayerBaseHeader.Bufferinstance allocated withmemAlloc.static XrCompositionLayerBaseHeader.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrCompositionLayerBaseHeader.Bufferinstance allocated on the specifiedMemoryStack.static XrCompositionLayerBaseHeadermalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrCompositionLayerBaseHeaderinstance allocated on the specifiedMemoryStack.longnext()NULLor a pointer to the next structure in a structure chain.XrCompositionLayerBaseHeadernext(long value)Sets the specified value to thenext()field.XrCompositionLayerBaseHeadernext(XrCompositionLayerAlphaBlendFB value)Prepends the specifiedXrCompositionLayerAlphaBlendFBvalue to thenextchain.XrCompositionLayerBaseHeadernext(XrCompositionLayerColorScaleBiasKHR value)Prepends the specifiedXrCompositionLayerColorScaleBiasKHRvalue to thenextchain.XrCompositionLayerBaseHeadernext(XrCompositionLayerImageLayoutFB value)Prepends the specifiedXrCompositionLayerImageLayoutFBvalue to thenextchain.XrCompositionLayerBaseHeadernext(XrCompositionLayerPassthroughFB value)Prepends the specifiedXrCompositionLayerPassthroughFBvalue to thenextchain.XrCompositionLayerBaseHeadernext(XrCompositionLayerSecureContentFB value)Prepends the specifiedXrCompositionLayerSecureContentFBvalue to thenextchain.static longnlayerFlags(long struct)Unsafe version oflayerFlags().static voidnlayerFlags(long struct, long value)Unsafe version oflayerFlags.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static longnspace(long struct)Unsafe version ofspace().static voidnspace(long struct, XrSpace value)Unsafe version ofspace.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.XrCompositionLayerBaseHeaderset(int type, long next, long layerFlags, XrSpace space)Initializes this struct with the specified values.XrCompositionLayerBaseHeaderset(XrCompositionLayerBaseHeader src)Copies the specified struct data to this struct.intsizeof()longspace()theXrSpacein which the layer will be kept stable over time.XrCompositionLayerBaseHeaderspace(XrSpace value)Sets the specified value to thespace()field.inttype()theXrStructureTypeof this structure.XrCompositionLayerBaseHeadertype(int value)Sets the specified value to thetype()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
XrCompositionLayerBaseHeader
public XrCompositionLayerBaseHeader(java.nio.ByteBuffer container)
Creates aXrCompositionLayerBaseHeaderinstance 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. This base structure itself has no associatedXrStructureTypevalue.
-
next
public long next()
NULLor a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.
-
layerFlags
public long layerFlags()
a bitmask ofXrCompositionLayerFlagBitsdescribing flags to apply to the layer.
-
space
public long space()
theXrSpacein which the layer will be kept stable over time.
-
type
public XrCompositionLayerBaseHeader type(int value)
Sets the specified value to thetype()field.
-
next
public XrCompositionLayerBaseHeader next(long value)
Sets the specified value to thenext()field.
-
next
public XrCompositionLayerBaseHeader next(XrCompositionLayerAlphaBlendFB value)
Prepends the specifiedXrCompositionLayerAlphaBlendFBvalue to thenextchain.
-
next
public XrCompositionLayerBaseHeader next(XrCompositionLayerColorScaleBiasKHR value)
Prepends the specifiedXrCompositionLayerColorScaleBiasKHRvalue to thenextchain.
-
next
public XrCompositionLayerBaseHeader next(XrCompositionLayerImageLayoutFB value)
Prepends the specifiedXrCompositionLayerImageLayoutFBvalue to thenextchain.
-
next
public XrCompositionLayerBaseHeader next(XrCompositionLayerPassthroughFB value)
Prepends the specifiedXrCompositionLayerPassthroughFBvalue to thenextchain.
-
next
public XrCompositionLayerBaseHeader next(XrCompositionLayerSecureContentFB value)
Prepends the specifiedXrCompositionLayerSecureContentFBvalue to thenextchain.
-
layerFlags
public XrCompositionLayerBaseHeader layerFlags(long value)
Sets the specified value to thelayerFlags()field.
-
space
public XrCompositionLayerBaseHeader space(XrSpace value)
Sets the specified value to thespace()field.
-
set
public XrCompositionLayerBaseHeader set(int type, long next, long layerFlags, XrSpace space)
Initializes this struct with the specified values.
-
set
public XrCompositionLayerBaseHeader set(XrCompositionLayerBaseHeader src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrCompositionLayerBaseHeader malloc()
Returns a newXrCompositionLayerBaseHeaderinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrCompositionLayerBaseHeader calloc()
Returns a newXrCompositionLayerBaseHeaderinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrCompositionLayerBaseHeader create()
Returns a newXrCompositionLayerBaseHeaderinstance allocated withBufferUtils.
-
create
public static XrCompositionLayerBaseHeader create(long address)
Returns a newXrCompositionLayerBaseHeaderinstance for the specified memory address.
-
createSafe
@Nullable public static XrCompositionLayerBaseHeader createSafe(long address)
-
create
public static XrCompositionLayerBaseHeader create(XrCompositionLayerProjection value)
Upcasts the specifiedXrCompositionLayerProjectioninstance toXrCompositionLayerBaseHeader.
-
create
public static XrCompositionLayerBaseHeader create(XrCompositionLayerQuad value)
Upcasts the specifiedXrCompositionLayerQuadinstance toXrCompositionLayerBaseHeader.
-
create
public static XrCompositionLayerBaseHeader create(XrCompositionLayerCubeKHR value)
Upcasts the specifiedXrCompositionLayerCubeKHRinstance toXrCompositionLayerBaseHeader.
-
create
public static XrCompositionLayerBaseHeader create(XrCompositionLayerCylinderKHR value)
Upcasts the specifiedXrCompositionLayerCylinderKHRinstance toXrCompositionLayerBaseHeader.
-
create
public static XrCompositionLayerBaseHeader create(XrCompositionLayerEquirectKHR value)
Upcasts the specifiedXrCompositionLayerEquirectKHRinstance toXrCompositionLayerBaseHeader.
-
create
public static XrCompositionLayerBaseHeader create(XrCompositionLayerEquirect2KHR value)
Upcasts the specifiedXrCompositionLayerEquirect2KHRinstance toXrCompositionLayerBaseHeader.
-
malloc
public static XrCompositionLayerBaseHeader.Buffer malloc(int capacity)
Returns a newXrCompositionLayerBaseHeader.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrCompositionLayerBaseHeader.Buffer calloc(int capacity)
Returns a newXrCompositionLayerBaseHeader.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrCompositionLayerBaseHeader.Buffer create(int capacity)
Returns a newXrCompositionLayerBaseHeader.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrCompositionLayerBaseHeader.Buffer create(long address, int capacity)
Create aXrCompositionLayerBaseHeader.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrCompositionLayerBaseHeader.Buffer createSafe(long address, int capacity)
-
create
public static XrCompositionLayerBaseHeader.Buffer create(XrCompositionLayerProjection.Buffer value)
Upcasts the specifiedXrCompositionLayerProjection.Bufferinstance toXrCompositionLayerBaseHeader.Buffer.
-
create
public static XrCompositionLayerBaseHeader.Buffer create(XrCompositionLayerQuad.Buffer value)
Upcasts the specifiedXrCompositionLayerQuad.Bufferinstance toXrCompositionLayerBaseHeader.Buffer.
-
create
public static XrCompositionLayerBaseHeader.Buffer create(XrCompositionLayerCubeKHR.Buffer value)
Upcasts the specifiedXrCompositionLayerCubeKHR.Bufferinstance toXrCompositionLayerBaseHeader.Buffer.
-
create
public static XrCompositionLayerBaseHeader.Buffer create(XrCompositionLayerCylinderKHR.Buffer value)
Upcasts the specifiedXrCompositionLayerCylinderKHR.Bufferinstance toXrCompositionLayerBaseHeader.Buffer.
-
create
public static XrCompositionLayerBaseHeader.Buffer create(XrCompositionLayerEquirectKHR.Buffer value)
Upcasts the specifiedXrCompositionLayerEquirectKHR.Bufferinstance toXrCompositionLayerBaseHeader.Buffer.
-
create
public static XrCompositionLayerBaseHeader.Buffer create(XrCompositionLayerEquirect2KHR.Buffer value)
Upcasts the specifiedXrCompositionLayerEquirect2KHR.Bufferinstance toXrCompositionLayerBaseHeader.Buffer.
-
malloc
public static XrCompositionLayerBaseHeader malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrCompositionLayerBaseHeaderinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrCompositionLayerBaseHeader calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrCompositionLayerBaseHeaderinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrCompositionLayerBaseHeader.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrCompositionLayerBaseHeader.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrCompositionLayerBaseHeader.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrCompositionLayerBaseHeader.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().
-
nlayerFlags
public static long nlayerFlags(long struct)
Unsafe version oflayerFlags().
-
nspace
public static long nspace(long struct)
Unsafe version ofspace().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
nlayerFlags
public static void nlayerFlags(long struct, long value)Unsafe version oflayerFlags.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-