Class CXPlatformAvailability

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

    public class CXPlatformAvailability
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Describes the availability of a given entity on a particular platform, e.g., a particular class might only be available on Mac OS 10.7 or newer.

    Member documentation

    • Platform – a string that describes the platform for which this structure provides availability information.

      Possible values are "ios" or "macos".

    • Introduced – the version number in which this entity was introduced
    • Deprecated – the version number in which this entity was deprecated (but is still available)
    • Obsoleted – the version number in which this entity was obsoleted, and therefore is no longer available
    • Unavailable – whether the entity is unconditionally unavailable on this platform
    • Message – an optional message to provide to a user of this API, e.g., to suggest replacement APIs

    Layout

    
     struct CXPlatformAvailability {
         CXString Platform;
         CXVersion Introduced;
         CXVersion Deprecated;
         CXVersion Obsoleted;
         int Unavailable;
         CXString Message;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • PLATFORM, INTRODUCED, DEPRECATED, OBSOLETED, UNAVAILABLE, MESSAGE

        The struct member offsets.
    • Constructor Detail

      • CXPlatformAvailability

        public CXPlatformAvailability​(java.nio.ByteBuffer container)
        Creates a CXPlatformAvailability 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
      • Platform

        public CXString Platform()
        Returns a CXString view of the Platform field.
      • Introduced

        public CXVersion Introduced()
        Returns a CXVersion view of the Introduced field.
      • Deprecated

        public CXVersion Deprecated()
        Returns a CXVersion view of the Deprecated field.
      • Obsoleted

        public CXVersion Obsoleted()
        Returns a CXVersion view of the Obsoleted field.
      • Unavailable

        public int Unavailable()
        Returns the value of the Unavailable field.
      • Message

        public CXString Message()
        Returns a CXString view of the Message field.
      • malloc

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

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

        public static CXPlatformAvailability create()
        Returns a new CXPlatformAvailability instance allocated with BufferUtils.
      • create

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

        @Nullable
        public static CXPlatformAvailability createSafe​(long address)
        Like create, but returns null if address is NULL.
      • mallocStack

        public static CXPlatformAvailability mallocStack()
        Returns a new CXPlatformAvailability instance allocated on the thread-local MemoryStack.
      • callocStack

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

        public static CXPlatformAvailability mallocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new CXPlatformAvailability instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static CXPlatformAvailability callocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new CXPlatformAvailability instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • mallocStack

        public static CXPlatformAvailability.Buffer mallocStack​(int capacity,
                                                                org.lwjgl.system.MemoryStack stack)
        Returns a new CXPlatformAvailability.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • callocStack

        public static CXPlatformAvailability.Buffer callocStack​(int capacity,
                                                                org.lwjgl.system.MemoryStack stack)
        Returns a new CXPlatformAvailability.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
      • nPlatform

        public static CXString nPlatform​(long struct)
        Unsafe version of Platform().
      • nUnavailable

        public static int nUnavailable​(long struct)
        Unsafe version of Unavailable().
      • nMessage

        public static CXString nMessage​(long struct)
        Unsafe version of Message().