Package com.openinventor.inventor.devices

Enum SoGLBufferObject.Usages

  • All Implemented Interfaces:
    IntegerValuedEnum, java.io.Serializable, java.lang.Comparable<SoGLBufferObject.Usages>
    Enclosing class:
    SoGLBufferObject
    public static enum SoGLBufferObject.Usages
extends java.lang.Enum<SoGLBufferObject.Usages>
implements IntegerValuedEnum
    This enum declares the possible usages of the memory allocated for the buffer. This is a hint to the OpenGL driver implementation as to how a buffer object's data store will be accessed. This enables the OpenGL implementation to make more intelligent decisions that may significantly impact buffer object performance. It does not, however, constrain the actual usage of the data store. usage can be broken down into two parts: first, the frequency of access (modification and usage - STATIC, STREAM, DYNAMIC), and second, the nature of that access - DRAW, COPY, READ.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DYNAMIC_COPY
      The data store contents will be modified repeatedly and used many times.
      DYNAMIC_DRAW
      The data store contents will be modified repeatedly and used many times.
      DYNAMIC_READ
      The data store contents will be modified repeatedly and used many times.
      STATIC_COPY
      The data store contents will be modified once and used many times.
      STATIC_DRAW
      The data store contents will be modified once and used many times.
      STATIC_READ
      The data store contents will be modified once and used many times.
      STREAM_COPY
      The data store contents will be modified once and used at most a few times.
      STREAM_DRAW
      The data store contents will be modified once and used at most a few times.
      STREAM_READ
      The data store contents will be modified once and used at most a few times.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getValue()
      Returns the integer value of the enum constant.
      static SoGLBufferObject.Usages valueOf​(int val)
      Returns the enum constant of this type with the specified integer value
      static SoGLBufferObject.Usages valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SoGLBufferObject.Usages[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • STREAM_DRAW

        public static final SoGLBufferObject.Usages STREAM_DRAW
        The data store contents will be modified once and used at most a few times. The data store contents are modified by the application, and used as the source for GL drawing and image specification commands.

      • STREAM_READ

        public static final SoGLBufferObject.Usages STREAM_READ
        The data store contents will be modified once and used at most a few times. The data store contents are modified by reading data from the GL, and used to return that data when queried by the application.

      • STREAM_COPY

        public static final SoGLBufferObject.Usages STREAM_COPY
        The data store contents will be modified once and used at most a few times. The data store contents are modified by reading data from the GL, and used as the source for GL drawing and image specification commands.

      • STATIC_DRAW

        public static final SoGLBufferObject.Usages STATIC_DRAW
        The data store contents will be modified once and used many times. The data store contents are modified by the application, and used as the source for GL drawing and image specification commands.

      • STATIC_READ

        public static final SoGLBufferObject.Usages STATIC_READ
        The data store contents will be modified once and used many times. The data store contents are modified by reading data from the GL, and used to return that data when queried by the application.

      • STATIC_COPY

        public static final SoGLBufferObject.Usages STATIC_COPY
        The data store contents will be modified once and used many times. The data store contents are modified by reading data from the GL, and used as the source for GL drawing and image specification commands.

      • DYNAMIC_DRAW

        public static final SoGLBufferObject.Usages DYNAMIC_DRAW
        The data store contents will be modified repeatedly and used many times. The data store contents are modified by the application, and used as the source for GL drawing and image specification commands.

      • DYNAMIC_READ

        public static final SoGLBufferObject.Usages DYNAMIC_READ
        The data store contents will be modified repeatedly and used many times. The data store contents are modified by reading data from the GL, and used to return that data when queried by the application.

      • DYNAMIC_COPY

        public static final SoGLBufferObject.Usages DYNAMIC_COPY
        The data store contents will be modified repeatedly and used many times. The data store contents are modified by reading data from the GL, and used as the source for GL drawing and image specification commands.

    • Method Detail

      • values

        public static SoGLBufferObject.Usages[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (SoGLBufferObject.Usages c : SoGLBufferObject.Usages.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SoGLBufferObject.Usages valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • valueOf

        public static SoGLBufferObject.Usages valueOf​(int val)
        Returns the enum constant of this type with the specified integer value
        Returns:
        the enum constant of this type with the specified integer value.

      • getValue

        public int getValue()
        Description copied from interface: IntegerValuedEnum
        Returns the integer value of the enum constant.
        Specified by:
        getValue in interface IntegerValuedEnum
        Returns:
        the integer value of the enum constant.