java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.ovr.OVRLayerCylinder

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class OVRLayerCylinder
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Describes a layer of type LayerType_Cylinder which is a single cylinder relative to the recentered origin. This type of layer represents a single object placed in the world and not a stereo view of the world itself.
```
                -Z                                       +Y
         U=0  +--+--+  U=1
          +---+  |  +---+            +-----------------+  - V=0
       +--+ \    |    / +--+         |                 |  |
     +-+     \       /     +-+       |                 |  |
    ++        \  A  /        ++      |                 |  |
   ++          \---/          ++     |                 |  |
   |            \ /            |     |              +X |  |
   +-------------C------R------+ +X  +--------C--------+  | <--- Height
       (+Y is out of screen)         |                 |  |
                                     |                 |  |
   R = Radius                        |                 |  |
   A = Angle (0,2*Pi)                |                 |  |
   C = CylinderPoseCenter            |                 |  |
   U/V = UV Coordinates              +-----------------+  - V=1
```
An identity CylinderPoseCenter places the center of the cylinder at the recentered origin unless the headlocked flag is set.

Does not utilize HmdSpaceToWorldScaleInMeters. If necessary, adjust translation and radius.

Note

Only the interior surface of the cylinder is visible. Use cylinder layers when the user cannot leave the extents of the cylinder. Artifacts may appear when viewing the cylinder's exterior surface. Additionally, while the interface supports an Angle that ranges from [0,2*Pi] the angle should remain less than 1.9*PI to avoid artifacts where the cylinder edges converge.

Member documentation
- Header – Header.Type must be LayerType_Cylinder
- ColorTexture – contains a single image, never with any stereo view
- Viewport – specifies the ColorTexture sub-rect UV coordinates
- CylinderPoseCenter – specifies the orientation and position of the center point of a cylinder layer type. The position is in real-world meters not the application's virtual world, but the physical world the user is in. It is relative to the "zero" position set by RecenterTrackingOrigin unless the LayerFlag_HeadLocked flag is used.
- CylinderRadius – radius of the cylinder in meters
- CylinderAngle – angle in radians. Range is from 0 to 2*Pi exclusive covering the entire cylinder (see diagram and note above).
- CylinderAspectRatio – custom aspect ratio presumably set based on Viewport. Used to calculate the height of the cylinder based on the arc-length (CylinderAngle) and radius (CylinderRadius) given above. The height of the cylinder is given by: height = (CylinderRadius * CylinderAngle) / CylinderAspectRatio. Aspect ratio is width / height.
Layout
```
 struct ovrLayerCylinder {
     ovrLayerHeader Header;
     ovrTextureSwapChain ColorTexture;
     ovrRecti Viewport;
     ovrPosef CylinderPoseCenter;
     float CylinderRadius;
     float CylinderAngle;
     float CylinderAspectRatio;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OVRLayerCylinder.Buffer
An array of OVRLayerCylinder structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`COLORTEXTURE CYLINDERANGLE CYLINDERASPECTRATIO CYLINDERPOSECENTER CYLINDERRADIUS HEADER`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`VIEWPORT`	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

OVRLayerCylinder(java.nio.ByteBuffer container)
Creates a OVRLayerCylinder instance at the current position of the specified ByteBuffer container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static OVRLayerCylinder`	`calloc()`	Returns a new `OVRLayerCylinder` instance allocated with `memCalloc`.
`static OVRLayerCylinder.Buffer`	`calloc(int capacity)`	Returns a new `OVRLayerCylinder.Buffer` instance allocated with `memCalloc`.
`static OVRLayerCylinder`	`callocStack()`	Returns a new `OVRLayerCylinder` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static OVRLayerCylinder.Buffer`	`callocStack(int capacity)`	Returns a new `OVRLayerCylinder.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static OVRLayerCylinder.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `OVRLayerCylinder.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static OVRLayerCylinder`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `OVRLayerCylinder` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`long`	`ColorTexture()`	Returns the value of the `ColorTexture` field.
`OVRLayerCylinder`	`ColorTexture(long value)`	Sets the specified value to the `ColorTexture` field.
`static OVRLayerCylinder`	`create()`	Returns a new `OVRLayerCylinder` instance allocated with `BufferUtils`.
`static OVRLayerCylinder.Buffer`	`create(int capacity)`	Returns a new `OVRLayerCylinder.Buffer` instance allocated with `BufferUtils`.
`static OVRLayerCylinder`	`create(long address)`	Returns a new `OVRLayerCylinder` instance for the specified memory address.
`static OVRLayerCylinder.Buffer`	`create(long address, int capacity)`	Create a `OVRLayerCylinder.Buffer` instance at the specified memory.
`static OVRLayerCylinder`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static OVRLayerCylinder.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`float`	`CylinderAngle()`	Returns the value of the `CylinderAngle` field.
`OVRLayerCylinder`	`CylinderAngle(float value)`	Sets the specified value to the `CylinderAngle` field.
`float`	`CylinderAspectRatio()`	Returns the value of the `CylinderAspectRatio` field.
`OVRLayerCylinder`	`CylinderAspectRatio(float value)`	Sets the specified value to the `CylinderAspectRatio` field.
`OVRPosef`	`CylinderPoseCenter()`	Returns a `OVRPosef` view of the `CylinderPoseCenter` field.
`OVRLayerCylinder`	`CylinderPoseCenter(java.util.function.Consumer<OVRPosef> consumer)`	Passes the `CylinderPoseCenter` field to the specified `Consumer`.
`OVRLayerCylinder`	`CylinderPoseCenter(OVRPosef value)`	Copies the specified `OVRPosef` to the `CylinderPoseCenter` field.
`float`	`CylinderRadius()`	Returns the value of the `CylinderRadius` field.
`OVRLayerCylinder`	`CylinderRadius(float value)`	Sets the specified value to the `CylinderRadius` field.
`OVRLayerHeader`	`Header()`	Returns a `OVRLayerHeader` view of the `Header` field.
`OVRLayerCylinder`	`Header(java.util.function.Consumer<OVRLayerHeader> consumer)`	Passes the `Header` field to the specified `Consumer`.
`OVRLayerCylinder`	`Header(OVRLayerHeader value)`	Copies the specified `OVRLayerHeader` to the `Header` field.
`static OVRLayerCylinder`	`malloc()`	Returns a new `OVRLayerCylinder` instance allocated with `memAlloc`.
`static OVRLayerCylinder.Buffer`	`malloc(int capacity)`	Returns a new `OVRLayerCylinder.Buffer` instance allocated with `memAlloc`.
`static OVRLayerCylinder`	`mallocStack()`	Returns a new `OVRLayerCylinder` instance allocated on the thread-local `MemoryStack`.
`static OVRLayerCylinder.Buffer`	`mallocStack(int capacity)`	Returns a new `OVRLayerCylinder.Buffer` instance allocated on the thread-local `MemoryStack`.
`static OVRLayerCylinder.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `OVRLayerCylinder.Buffer` instance allocated on the specified `MemoryStack`.
`static OVRLayerCylinder`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `OVRLayerCylinder` instance allocated on the specified `MemoryStack`.
`static long`	`nColorTexture(long struct)`	Unsafe version of `ColorTexture()`.
`static void`	`nColorTexture(long struct, long value)`	Unsafe version of `ColorTexture`.
`static float`	`nCylinderAngle(long struct)`	Unsafe version of `CylinderAngle()`.
`static void`	`nCylinderAngle(long struct, float value)`	Unsafe version of `CylinderAngle`.
`static float`	`nCylinderAspectRatio(long struct)`	Unsafe version of `CylinderAspectRatio()`.
`static void`	`nCylinderAspectRatio(long struct, float value)`	Unsafe version of `CylinderAspectRatio`.
`static OVRPosef`	`nCylinderPoseCenter(long struct)`	Unsafe version of `CylinderPoseCenter()`.
`static void`	`nCylinderPoseCenter(long struct, OVRPosef value)`	Unsafe version of `CylinderPoseCenter`.
`static float`	`nCylinderRadius(long struct)`	Unsafe version of `CylinderRadius()`.
`static void`	`nCylinderRadius(long struct, float value)`	Unsafe version of `CylinderRadius`.
`static OVRLayerHeader`	`nHeader(long struct)`	Unsafe version of `Header()`.
`static void`	`nHeader(long struct, OVRLayerHeader value)`	Unsafe version of `Header`.
`static OVRRecti`	`nViewport(long struct)`	Unsafe version of `Viewport()`.
`static void`	`nViewport(long struct, OVRRecti value)`	Unsafe version of `Viewport`.
`OVRLayerCylinder`	`set(OVRLayerCylinder src)`	Copies the specified struct data to this struct.
`OVRLayerCylinder`	`set(OVRLayerHeader Header, long ColorTexture, OVRRecti Viewport, OVRPosef CylinderPoseCenter, float CylinderRadius, float CylinderAngle, float CylinderAspectRatio)`	Initializes this struct with the specified values.
`int`	`sizeof()`
`static void`	`validate(long struct)`	Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)`	Calls `validate(long)` for each struct contained in the specified struct array.
`OVRRecti`	`Viewport()`	Returns a `OVRRecti` view of the `Viewport` field.
`OVRLayerCylinder`	`Viewport(java.util.function.Consumer<OVRRecti> consumer)`	Passes the `Viewport` field to the specified `Consumer`.
`OVRLayerCylinder`	`Viewport(OVRRecti value)`	Copies the specified `OVRRecti` to the `Viewport` field.

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

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

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

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

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - HEADER, COLORTEXTURE, VIEWPORT, CYLINDERPOSECENTER, CYLINDERRADIUS, CYLINDERANGLE, CYLINDERASPECTRATIO
    
    The struct member offsets.
- Constructor Detail
  - OVRLayerCylinder
```
public OVRLayerCylinder(java.nio.ByteBuffer container)
```
    Creates a OVRLayerCylinder 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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - Header
```
public OVRLayerHeader Header()
```
    Returns a OVRLayerHeader view of the Header field.
  - ColorTexture
```
public long ColorTexture()
```
    Returns the value of the ColorTexture field.
  - Viewport
```
public OVRRecti Viewport()
```
    Returns a OVRRecti view of the Viewport field.
  - CylinderPoseCenter
```
public OVRPosef CylinderPoseCenter()
```
    Returns a OVRPosef view of the CylinderPoseCenter field.
  - CylinderRadius
```
public float CylinderRadius()
```
    Returns the value of the CylinderRadius field.
  - CylinderAngle
```
public float CylinderAngle()
```
    Returns the value of the CylinderAngle field.
  - CylinderAspectRatio
```
public float CylinderAspectRatio()
```
    Returns the value of the CylinderAspectRatio field.
  - Header
```
public OVRLayerCylinder Header(OVRLayerHeader value)
```
    Copies the specified OVRLayerHeader to the Header field.
  - Header
```
public OVRLayerCylinder Header(java.util.function.Consumer<OVRLayerHeader> consumer)
```
    Passes the Header field to the specified Consumer.
  - ColorTexture
```
public OVRLayerCylinder ColorTexture(long value)
```
    Sets the specified value to the ColorTexture field.
  - Viewport
```
public OVRLayerCylinder Viewport(OVRRecti value)
```
    Copies the specified OVRRecti to the Viewport field.
  - Viewport
```
public OVRLayerCylinder Viewport(java.util.function.Consumer<OVRRecti> consumer)
```
    Passes the Viewport field to the specified Consumer.
  - CylinderPoseCenter
```
public OVRLayerCylinder CylinderPoseCenter(OVRPosef value)
```
    Copies the specified OVRPosef to the CylinderPoseCenter field.
  - CylinderPoseCenter
```
public OVRLayerCylinder CylinderPoseCenter(java.util.function.Consumer<OVRPosef> consumer)
```
    Passes the CylinderPoseCenter field to the specified Consumer.
  - CylinderRadius
```
public OVRLayerCylinder CylinderRadius(float value)
```
    Sets the specified value to the CylinderRadius field.
  - CylinderAngle
```
public OVRLayerCylinder CylinderAngle(float value)
```
    Sets the specified value to the CylinderAngle field.
  - CylinderAspectRatio
```
public OVRLayerCylinder CylinderAspectRatio(float value)
```
    Sets the specified value to the CylinderAspectRatio field.
  - set
```
public OVRLayerCylinder set(OVRLayerHeader Header,
                            long ColorTexture,
                            OVRRecti Viewport,
                            OVRPosef CylinderPoseCenter,
                            float CylinderRadius,
                            float CylinderAngle,
                            float CylinderAspectRatio)
```
    Initializes this struct with the specified values.
  - set
```
public OVRLayerCylinder set(OVRLayerCylinder src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static OVRLayerCylinder malloc()
```
    Returns a new OVRLayerCylinder instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static OVRLayerCylinder calloc()
```
    Returns a new OVRLayerCylinder instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static OVRLayerCylinder create()
```
    Returns a new OVRLayerCylinder instance allocated with BufferUtils.
  - create
```
public static OVRLayerCylinder create(long address)
```
    Returns a new OVRLayerCylinder instance for the specified memory address.
  - createSafe
```
@Nullable
public static OVRLayerCylinder createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static OVRLayerCylinder.Buffer malloc(int capacity)
```
    Returns a new OVRLayerCylinder.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static OVRLayerCylinder.Buffer calloc(int capacity)
```
    Returns a new OVRLayerCylinder.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static OVRLayerCylinder.Buffer create(int capacity)
```
    Returns a new OVRLayerCylinder.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static OVRLayerCylinder.Buffer create(long address,
                                             int capacity)
```
    Create a OVRLayerCylinder.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static OVRLayerCylinder.Buffer createSafe(long address,
                                                 int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static OVRLayerCylinder mallocStack()
```
    Returns a new OVRLayerCylinder instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static OVRLayerCylinder callocStack()
```
    Returns a new OVRLayerCylinder instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static OVRLayerCylinder mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new OVRLayerCylinder instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static OVRLayerCylinder callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new OVRLayerCylinder instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static OVRLayerCylinder.Buffer mallocStack(int capacity)
```
    Returns a new OVRLayerCylinder.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static OVRLayerCylinder.Buffer callocStack(int capacity)
```
    Returns a new OVRLayerCylinder.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static OVRLayerCylinder.Buffer mallocStack(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
```
    Returns a new OVRLayerCylinder.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static OVRLayerCylinder.Buffer callocStack(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
```
    Returns a new OVRLayerCylinder.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nHeader
```
public static OVRLayerHeader nHeader(long struct)
```
    Unsafe version of Header().
  - nColorTexture
```
public static long nColorTexture(long struct)
```
    Unsafe version of ColorTexture().
  - nViewport
```
public static OVRRecti nViewport(long struct)
```
    Unsafe version of Viewport().
  - nCylinderPoseCenter
```
public static OVRPosef nCylinderPoseCenter(long struct)
```
    Unsafe version of CylinderPoseCenter().
  - nCylinderRadius
```
public static float nCylinderRadius(long struct)
```
    Unsafe version of CylinderRadius().
  - nCylinderAngle
```
public static float nCylinderAngle(long struct)
```
    Unsafe version of CylinderAngle().
  - nCylinderAspectRatio
```
public static float nCylinderAspectRatio(long struct)
```
    Unsafe version of CylinderAspectRatio().
  - nHeader
```
public static void nHeader(long struct,
                           OVRLayerHeader value)
```
    Unsafe version of Header.
  - nColorTexture
```
public static void nColorTexture(long struct,
                                 long value)
```
    Unsafe version of ColorTexture.
  - nViewport
```
public static void nViewport(long struct,
                             OVRRecti value)
```
    Unsafe version of Viewport.
  - nCylinderPoseCenter
```
public static void nCylinderPoseCenter(long struct,
                                       OVRPosef value)
```
    Unsafe version of CylinderPoseCenter.
  - nCylinderRadius
```
public static void nCylinderRadius(long struct,
                                   float value)
```
    Unsafe version of CylinderRadius.
  - nCylinderAngle
```
public static void nCylinderAngle(long struct,
                                  float value)
```
    Unsafe version of CylinderAngle.
  - nCylinderAspectRatio
```
public static void nCylinderAspectRatio(long struct,
                                        float value)
```
    Unsafe version of CylinderAspectRatio.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class OVRLayerCylinder

Note

Member documentation

Layout

Nested Class Summary

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 interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

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

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

HEADER, COLORTEXTURE, VIEWPORT, CYLINDERPOSECENTER, CYLINDERRADIUS, CYLINDERANGLE, CYLINDERASPECTRATIO

Constructor Detail

OVRLayerCylinder

Method Detail

sizeof

Header

ColorTexture

Viewport

CylinderPoseCenter

CylinderRadius

CylinderAngle

CylinderAspectRatio

Header

Header

ColorTexture

Viewport

Viewport

CylinderPoseCenter

CylinderPoseCenter

CylinderRadius

CylinderAngle

CylinderAspectRatio

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nHeader

nColorTexture

nViewport

nCylinderPoseCenter

nCylinderRadius

nCylinderAngle

nCylinderAspectRatio

nHeader

nColorTexture

nViewport

nCylinderPoseCenter

nCylinderRadius

nCylinderAngle

nCylinderAspectRatio

validate

validate