Class CompositorOverlaySettings

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class CompositorOverlaySettings
    extends Struct
    implements NativeResource
    Allows the application to customize how the overlay appears in the compositor.

    Member documentation

    • sizesizeof(Compositor_OverlaySettings)


     struct Compositor_OverlaySettings {
         uint32_t size;
         bool curved;
         bool antialias;
         float scale;
         float distance;
         float alpha;
         float uOffset;
         float vOffset;
         float uScale;
         float vScale;
         float gridDivs;
         float gridWidth;
         float gridScale;
         HmdMatrix44_t transform;
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.

        The struct member offsets.
    • Constructor Detail

      • CompositorOverlaySettings

        public CompositorOverlaySettings​(java.nio.ByteBuffer container)
        Creates a CompositorOverlaySettings 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • size

        public int size()
        Returns the value of the size field.
      • curved

        public boolean curved()
        Returns the value of the curved field.
      • antialias

        public boolean antialias()
        Returns the value of the antialias field.
      • scale

        public float scale()
        Returns the value of the scale field.
      • distance

        public float distance()
        Returns the value of the distance field.
      • alpha

        public float alpha()
        Returns the value of the alpha field.
      • uOffset

        public float uOffset()
        Returns the value of the uOffset field.
      • vOffset

        public float vOffset()
        Returns the value of the vOffset field.
      • uScale

        public float uScale()
        Returns the value of the uScale field.
      • vScale

        public float vScale()
        Returns the value of the vScale field.
      • gridDivs

        public float gridDivs()
        Returns the value of the gridDivs field.
      • gridWidth

        public float gridWidth()
        Returns the value of the gridWidth field.
      • gridScale

        public float gridScale()
        Returns the value of the gridScale field.
      • set

        public CompositorOverlaySettings set​(int size,
                                             boolean curved,
                                             boolean antialias,
                                             float scale,
                                             float distance,
                                             float alpha,
                                             float uOffset,
                                             float vOffset,
                                             float uScale,
                                             float vScale,
                                             float gridDivs,
                                             float gridWidth,
                                             float gridScale,
                                             HmdMatrix44 transform)
        Initializes this struct with the specified values.
      • malloc

        public static CompositorOverlaySettings malloc()
        Returns a new CompositorOverlaySettings instance allocated with memAlloc. The instance must be explicitly freed.
      • calloc

        public static CompositorOverlaySettings calloc()
        Returns a new CompositorOverlaySettings instance allocated with memCalloc. The instance must be explicitly freed.
      • create

        public static CompositorOverlaySettings create​(long address)
        Returns a new CompositorOverlaySettings instance for the specified memory address.
      • callocStack

        public static CompositorOverlaySettings callocStack()
        Returns a new CompositorOverlaySettings instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • callocStack

        public static CompositorOverlaySettings callocStack​(MemoryStack stack)
        Returns a new CompositorOverlaySettings instance allocated on the specified MemoryStack and initializes all its bits to zero.
        stack - the stack from which to allocate
      • nsize

        public static int nsize​(long struct)
        Unsafe version of size().
      • ncurved

        public static boolean ncurved​(long struct)
        Unsafe version of curved().
      • nantialias

        public static boolean nantialias​(long struct)
        Unsafe version of antialias().
      • nscale

        public static float nscale​(long struct)
        Unsafe version of scale().
      • ndistance

        public static float ndistance​(long struct)
        Unsafe version of distance().
      • nalpha

        public static float nalpha​(long struct)
        Unsafe version of alpha().
      • nuOffset

        public static float nuOffset​(long struct)
        Unsafe version of uOffset().
      • nvOffset

        public static float nvOffset​(long struct)
        Unsafe version of vOffset().
      • nuScale

        public static float nuScale​(long struct)
        Unsafe version of uScale().
      • nvScale

        public static float nvScale​(long struct)
        Unsafe version of vScale().
      • ngridDivs

        public static float ngridDivs​(long struct)
        Unsafe version of gridDivs().
      • ngridWidth

        public static float ngridWidth​(long struct)
        Unsafe version of gridWidth().
      • ngridScale

        public static float ngridScale​(long struct)
        Unsafe version of gridScale().
      • nsize

        public static void nsize​(long struct,
                                 int value)
        Unsafe version of size.
      • ncurved

        public static void ncurved​(long struct,
                                   boolean value)
        Unsafe version of curved.
      • nantialias

        public static void nantialias​(long struct,
                                      boolean value)
        Unsafe version of antialias.
      • nscale

        public static void nscale​(long struct,
                                  float value)
        Unsafe version of scale.
      • ndistance

        public static void ndistance​(long struct,
                                     float value)
        Unsafe version of distance.
      • nalpha

        public static void nalpha​(long struct,
                                  float value)
        Unsafe version of alpha.
      • nuOffset

        public static void nuOffset​(long struct,
                                    float value)
        Unsafe version of uOffset.
      • nvOffset

        public static void nvOffset​(long struct,
                                    float value)
        Unsafe version of vOffset.
      • nuScale

        public static void nuScale​(long struct,
                                   float value)
        Unsafe version of uScale.
      • nvScale

        public static void nvScale​(long struct,
                                   float value)
        Unsafe version of vScale.
      • ngridDivs

        public static void ngridDivs​(long struct,
                                     float value)
        Unsafe version of gridDivs.
      • ngridWidth

        public static void ngridWidth​(long struct,
                                      float value)
        Unsafe version of gridWidth.
      • ngridScale

        public static void ngridScale​(long struct,
                                      float value)
        Unsafe version of gridScale.
      • ntransform

        public static void ntransform​(long struct,
                                      HmdMatrix44 value)
        Unsafe version of transform.