Package org.lwjgl.openxr
Class XrCompositionLayerEquirect2KHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrCompositionLayerEquirect2KHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrCompositionLayerEquirect2KHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceEquirectangular layer composition info.Description
XrCompositionLayerEquirect2KHRcontains the information needed to render an equirectangular image onto a sphere when callingEndFrame.XrCompositionLayerEquirect2KHRis an alias type for the base structXrCompositionLayerBaseHeaderused inXrFrameEndInfo.Valid Usage (Implicit)
- The
XR_KHR_composition_layer_equirect2extension must be enabled prior to usingXrCompositionLayerEquirect2KHR typemust beTYPE_COMPOSITION_LAYER_EQUIRECT2_KHRnextmust beNULLor a valid pointer to the next structure in a structure chainlayerFlagsmust be 0 or a valid combination ofXrCompositionLayerFlagBitsvaluesspacemust be a validXrSpacehandleeyeVisibilitymust be a validXrEyeVisibilityvaluesubImagemust be a validXrSwapchainSubImagestructure
See Also
XrCompositionLayerBaseHeader,XrFrameEndInfo,XrPosef,XrSwapchainSubImage,EndFrameLayout
struct XrCompositionLayerEquirect2KHR { XrStructureTypetype(); void const *next(); XrCompositionLayerFlagslayerFlags(); XrSpacespace(); XrEyeVisibility eyeVisibility;XrSwapchainSubImagesubImage();XrPosefpose(); floatradius(); floatcentralHorizontalAngle(); floatupperVerticalAngle(); floatlowerVerticalAngle(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrCompositionLayerEquirect2KHR.BufferAn array ofXrCompositionLayerEquirect2KHRstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intCENTRALHORIZONTALANGLE
EYEVISIBILITY
LAYERFLAGS
LOWERVERTICALANGLE
NEXT
POSE
RADIUSThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSPACE
SUBIMAGE
TYPE
UPPERVERTICALANGLEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrCompositionLayerEquirect2KHR(java.nio.ByteBuffer container)Creates aXrCompositionLayerEquirect2KHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static XrCompositionLayerEquirect2KHRcalloc()Returns a newXrCompositionLayerEquirect2KHRinstance allocated withmemCalloc.static XrCompositionLayerEquirect2KHR.Buffercalloc(int capacity)Returns a newXrCompositionLayerEquirect2KHR.Bufferinstance allocated withmemCalloc.static XrCompositionLayerEquirect2KHR.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrCompositionLayerEquirect2KHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrCompositionLayerEquirect2KHRcalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrCompositionLayerEquirect2KHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.floatcentralHorizontalAngle()defines the visible horizontal angle of the sphere, based at 0 radians, in the range of[0, 2π].XrCompositionLayerEquirect2KHRcentralHorizontalAngle(float value)Sets the specified value to thecentralHorizontalAngle()field.static XrCompositionLayerEquirect2KHRcreate()Returns a newXrCompositionLayerEquirect2KHRinstance allocated withBufferUtils.static XrCompositionLayerEquirect2KHR.Buffercreate(int capacity)Returns a newXrCompositionLayerEquirect2KHR.Bufferinstance allocated withBufferUtils.static XrCompositionLayerEquirect2KHRcreate(long address)Returns a newXrCompositionLayerEquirect2KHRinstance for the specified memory address.static XrCompositionLayerEquirect2KHR.Buffercreate(long address, int capacity)Create aXrCompositionLayerEquirect2KHR.Bufferinstance at the specified memory.static XrCompositionLayerEquirect2KHRcreate(XrCompositionLayerBaseHeader value)Downcasts the specifiedXrCompositionLayerBaseHeaderinstance toXrCompositionLayerEquirect2KHR.static XrCompositionLayerEquirect2KHR.Buffercreate(XrCompositionLayerBaseHeader.Buffer value)Downcasts the specifiedXrCompositionLayerBaseHeader.Bufferinstance toXrCompositionLayerEquirect2KHR.Buffer.static XrCompositionLayerEquirect2KHRcreateSafe(long address)static XrCompositionLayerEquirect2KHR.BuffercreateSafe(long address, int capacity)inteyeVisibility()XrCompositionLayerEquirect2KHReyeVisibility(int value)Sets the specified value to theeyeVisibilityfield.longlayerFlags()specifies options for the layer.XrCompositionLayerEquirect2KHRlayerFlags(long value)Sets the specified value to thelayerFlags()field.floatlowerVerticalAngle()defines the lower vertical angle of the visible portion of the sphere, in the range of[-π/2, π/2].XrCompositionLayerEquirect2KHRlowerVerticalAngle(float value)Sets the specified value to thelowerVerticalAngle()field.static XrCompositionLayerEquirect2KHRmalloc()Returns a newXrCompositionLayerEquirect2KHRinstance allocated withmemAlloc.static XrCompositionLayerEquirect2KHR.Buffermalloc(int capacity)Returns a newXrCompositionLayerEquirect2KHR.Bufferinstance allocated withmemAlloc.static XrCompositionLayerEquirect2KHR.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrCompositionLayerEquirect2KHR.Bufferinstance allocated on the specifiedMemoryStack.static XrCompositionLayerEquirect2KHRmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrCompositionLayerEquirect2KHRinstance allocated on the specifiedMemoryStack.static floatncentralHorizontalAngle(long struct)Unsafe version ofcentralHorizontalAngle().static voidncentralHorizontalAngle(long struct, float value)Unsafe version ofcentralHorizontalAngle.longnext()NULLor a pointer to the next structure in a structure chain.XrCompositionLayerEquirect2KHRnext(long value)Sets the specified value to thenext()field.static intneyeVisibility(long struct)Unsafe version ofeyeVisibility().static voidneyeVisibility(long struct, int value)Unsafe version ofeyeVisibility.static longnlayerFlags(long struct)Unsafe version oflayerFlags().static voidnlayerFlags(long struct, long value)Unsafe version oflayerFlags.static floatnlowerVerticalAngle(long struct)Unsafe version oflowerVerticalAngle().static voidnlowerVerticalAngle(long struct, float value)Unsafe version oflowerVerticalAngle.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static XrPosefnpose(long struct)Unsafe version ofpose().static voidnpose(long struct, XrPosef value)Unsafe version ofpose.static floatnradius(long struct)Unsafe version ofradius().static voidnradius(long struct, float value)Unsafe version ofradius.static longnspace(long struct)Unsafe version ofspace().static voidnspace(long struct, XrSpace value)Unsafe version ofspace.static XrSwapchainSubImagensubImage(long struct)Unsafe version ofsubImage().static voidnsubImage(long struct, XrSwapchainSubImage value)Unsafe version ofsubImage.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.static floatnupperVerticalAngle(long struct)Unsafe version ofupperVerticalAngle().static voidnupperVerticalAngle(long struct, float value)Unsafe version ofupperVerticalAngle.XrPosefpose()anXrPosefdefining the position and orientation of the center point of the sphere onto which the equirect image data is mapped, relative to the reference frame of thespace.XrCompositionLayerEquirect2KHRpose(java.util.function.Consumer<XrPosef> consumer)Passes thepose()field to the specifiedConsumer.XrCompositionLayerEquirect2KHRpose(XrPosef value)floatradius()the non-negative radius of the sphere onto which the equirect image data is mapped.XrCompositionLayerEquirect2KHRradius(float value)Sets the specified value to theradius()field.XrCompositionLayerEquirect2KHRset(int type, long next, long layerFlags, XrSpace space, int eyeVisibility, XrSwapchainSubImage subImage, XrPosef pose, float radius, float centralHorizontalAngle, float upperVerticalAngle, float lowerVerticalAngle)Initializes this struct with the specified values.XrCompositionLayerEquirect2KHRset(XrCompositionLayerEquirect2KHR src)Copies the specified struct data to this struct.intsizeof()longspace()theXrSpacein which theposeof the equirect layer is evaluated over time.XrCompositionLayerEquirect2KHRspace(XrSpace value)Sets the specified value to thespace()field.XrSwapchainSubImagesubImage()identifies the imageXrSwapchainSubImageto use.XrCompositionLayerEquirect2KHRsubImage(java.util.function.Consumer<XrSwapchainSubImage> consumer)Passes thesubImage()field to the specifiedConsumer.XrCompositionLayerEquirect2KHRsubImage(XrSwapchainSubImage value)Copies the specifiedXrSwapchainSubImageto thesubImage()field.inttype()theXrStructureTypeof this structure.XrCompositionLayerEquirect2KHRtype(int value)Sets the specified value to thetype()field.XrCompositionLayerEquirect2KHRtype$Default()Sets theTYPE_COMPOSITION_LAYER_EQUIRECT2_KHRvalue to thetype()field.floatupperVerticalAngle()defines the upper vertical angle of the visible portion of the sphere, in the range of[-π/2, π/2].XrCompositionLayerEquirect2KHRupperVerticalAngle(float value)Sets the specified value to theupperVerticalAngle()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
XrCompositionLayerEquirect2KHR
public XrCompositionLayerEquirect2KHR(java.nio.ByteBuffer container)
Creates aXrCompositionLayerEquirect2KHRinstance 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.
-
layerFlags
public long layerFlags()
specifies options for the layer.
-
space
public long space()
theXrSpacein which theposeof the equirect layer is evaluated over time.
-
eyeVisibility
public int eyeVisibility()
- Returns:
- the value of the
eyeVisibilityfield.
-
subImage
public XrSwapchainSubImage subImage()
identifies the imageXrSwapchainSubImageto use.
-
pose
public XrPosef pose()
anXrPosefdefining the position and orientation of the center point of the sphere onto which the equirect image data is mapped, relative to the reference frame of thespace.
-
radius
public float radius()
the non-negative radius of the sphere onto which the equirect image data is mapped. Values of zero or floating point positive infinity are treated as an infinite sphere.
-
centralHorizontalAngle
public float centralHorizontalAngle()
defines the visible horizontal angle of the sphere, based at 0 radians, in the range of[0, 2π]. It grows symmetrically around the 0 radian angle.
-
upperVerticalAngle
public float upperVerticalAngle()
defines the upper vertical angle of the visible portion of the sphere, in the range of[-π/2, π/2].
-
lowerVerticalAngle
public float lowerVerticalAngle()
defines the lower vertical angle of the visible portion of the sphere, in the range of[-π/2, π/2].
-
type
public XrCompositionLayerEquirect2KHR type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrCompositionLayerEquirect2KHR type$Default()
Sets theTYPE_COMPOSITION_LAYER_EQUIRECT2_KHRvalue to thetype()field.
-
next
public XrCompositionLayerEquirect2KHR next(long value)
Sets the specified value to thenext()field.
-
layerFlags
public XrCompositionLayerEquirect2KHR layerFlags(long value)
Sets the specified value to thelayerFlags()field.
-
space
public XrCompositionLayerEquirect2KHR space(XrSpace value)
Sets the specified value to thespace()field.
-
eyeVisibility
public XrCompositionLayerEquirect2KHR eyeVisibility(int value)
Sets the specified value to theeyeVisibilityfield.
-
subImage
public XrCompositionLayerEquirect2KHR subImage(XrSwapchainSubImage value)
Copies the specifiedXrSwapchainSubImageto thesubImage()field.
-
subImage
public XrCompositionLayerEquirect2KHR subImage(java.util.function.Consumer<XrSwapchainSubImage> consumer)
Passes thesubImage()field to the specifiedConsumer.
-
pose
public XrCompositionLayerEquirect2KHR pose(XrPosef value)
-
pose
public XrCompositionLayerEquirect2KHR pose(java.util.function.Consumer<XrPosef> consumer)
Passes thepose()field to the specifiedConsumer.
-
radius
public XrCompositionLayerEquirect2KHR radius(float value)
Sets the specified value to theradius()field.
-
centralHorizontalAngle
public XrCompositionLayerEquirect2KHR centralHorizontalAngle(float value)
Sets the specified value to thecentralHorizontalAngle()field.
-
upperVerticalAngle
public XrCompositionLayerEquirect2KHR upperVerticalAngle(float value)
Sets the specified value to theupperVerticalAngle()field.
-
lowerVerticalAngle
public XrCompositionLayerEquirect2KHR lowerVerticalAngle(float value)
Sets the specified value to thelowerVerticalAngle()field.
-
set
public XrCompositionLayerEquirect2KHR set(int type, long next, long layerFlags, XrSpace space, int eyeVisibility, XrSwapchainSubImage subImage, XrPosef pose, float radius, float centralHorizontalAngle, float upperVerticalAngle, float lowerVerticalAngle)
Initializes this struct with the specified values.
-
set
public XrCompositionLayerEquirect2KHR set(XrCompositionLayerEquirect2KHR src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrCompositionLayerEquirect2KHR malloc()
Returns a newXrCompositionLayerEquirect2KHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrCompositionLayerEquirect2KHR calloc()
Returns a newXrCompositionLayerEquirect2KHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrCompositionLayerEquirect2KHR create()
Returns a newXrCompositionLayerEquirect2KHRinstance allocated withBufferUtils.
-
create
public static XrCompositionLayerEquirect2KHR create(long address)
Returns a newXrCompositionLayerEquirect2KHRinstance for the specified memory address.
-
createSafe
@Nullable public static XrCompositionLayerEquirect2KHR createSafe(long address)
-
create
public static XrCompositionLayerEquirect2KHR create(XrCompositionLayerBaseHeader value)
Downcasts the specifiedXrCompositionLayerBaseHeaderinstance toXrCompositionLayerEquirect2KHR.
-
malloc
public static XrCompositionLayerEquirect2KHR.Buffer malloc(int capacity)
Returns a newXrCompositionLayerEquirect2KHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrCompositionLayerEquirect2KHR.Buffer calloc(int capacity)
Returns a newXrCompositionLayerEquirect2KHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrCompositionLayerEquirect2KHR.Buffer create(int capacity)
Returns a newXrCompositionLayerEquirect2KHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrCompositionLayerEquirect2KHR.Buffer create(long address, int capacity)
Create aXrCompositionLayerEquirect2KHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrCompositionLayerEquirect2KHR.Buffer createSafe(long address, int capacity)
-
create
public static XrCompositionLayerEquirect2KHR.Buffer create(XrCompositionLayerBaseHeader.Buffer value)
Downcasts the specifiedXrCompositionLayerBaseHeader.Bufferinstance toXrCompositionLayerEquirect2KHR.Buffer.
-
malloc
public static XrCompositionLayerEquirect2KHR malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrCompositionLayerEquirect2KHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrCompositionLayerEquirect2KHR calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrCompositionLayerEquirect2KHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrCompositionLayerEquirect2KHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrCompositionLayerEquirect2KHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrCompositionLayerEquirect2KHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrCompositionLayerEquirect2KHR.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().
-
neyeVisibility
public static int neyeVisibility(long struct)
Unsafe version ofeyeVisibility().
-
nsubImage
public static XrSwapchainSubImage nsubImage(long struct)
Unsafe version ofsubImage().
-
nradius
public static float nradius(long struct)
Unsafe version ofradius().
-
ncentralHorizontalAngle
public static float ncentralHorizontalAngle(long struct)
Unsafe version ofcentralHorizontalAngle().
-
nupperVerticalAngle
public static float nupperVerticalAngle(long struct)
Unsafe version ofupperVerticalAngle().
-
nlowerVerticalAngle
public static float nlowerVerticalAngle(long struct)
Unsafe version oflowerVerticalAngle().
-
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.
-
neyeVisibility
public static void neyeVisibility(long struct, int value)Unsafe version ofeyeVisibility.
-
nsubImage
public static void nsubImage(long struct, XrSwapchainSubImage value)Unsafe version ofsubImage.
-
nradius
public static void nradius(long struct, float value)Unsafe version ofradius.
-
ncentralHorizontalAngle
public static void ncentralHorizontalAngle(long struct, float value)Unsafe version ofcentralHorizontalAngle.
-
nupperVerticalAngle
public static void nupperVerticalAngle(long struct, float value)Unsafe version ofupperVerticalAngle.
-
nlowerVerticalAngle
public static void nlowerVerticalAngle(long struct, float value)Unsafe version oflowerVerticalAngle.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-