Class VkApplicationInfo

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


    public class VkApplicationInfo
    extends Struct
    Khronos Reference Page
    Vulkan Specification

    Contains information about the application.

    Valid Usage
    • sType must be STRUCTURE_TYPE_APPLICATION_INFO
    • pNext must be NULL
    • If pApplicationName is not NULL, pApplicationName must be a null-terminated string
    • If pEngineName is not NULL, pEngineName must be a null-terminated string
    • apiVersion must be zero, or otherwise it must be a version that the implementation supports, or supports an effective substitute for

    Member documentation

    • sType – the type of this structure. Must be: STRUCTURE_TYPE_APPLICATION_INFO
    • pNext – reserved for use by extensions
    • pApplicationName – a pointer to a NULL-terminated UTF-8 string containing the name of the application
    • applicationVersion – contains an application-specific version number. It is recommended that new versions of an existing application specify monotonically increasing values for applicationVersion.
    • pEngineName – if the application is built on a reusable engine, the name of the engine may be specified in the NULL-terminated UTF-8 string pointed to by pEngineName
    • engineVersion – the version of the engine used to create the application
    • apiVersion – the version of the Vulkan API that the application expects to use

    Layout

    struct VkApplicationInfo {
        VkStructureType sType;
        const void * pNext;
        const char * pApplicationName;
        uint32_t applicationVersion;
        const char * pEngineName;
        uint32_t engineVersion;
        uint32_t apiVersion;
    }
    • Field Detail

      • SIZEOF

        public static final int SIZEOF
        The struct size in bytes.
    • Constructor Detail

      • VkApplicationInfo

        public VkApplicationInfo(java.nio.ByteBuffer container)
        Creates a VkApplicationInfo 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 the sizeof(struct).
        Specified by:
        sizeof in class Struct
      • sType

        public int sType()
        Returns the value of the sType field.
      • pNext

        public long pNext()
        Returns the value of the pNext field.
      • pApplicationName

        public java.nio.ByteBuffer pApplicationName()
        Returns a ByteBuffer view of the null-terminated string pointed to by the pApplicationName field.
      • pApplicationNameString

        public java.lang.String pApplicationNameString()
        Decodes the null-terminated string pointed to by the pApplicationName field.
      • applicationVersion

        public int applicationVersion()
        Returns the value of the applicationVersion field.
      • pEngineName

        public java.nio.ByteBuffer pEngineName()
        Returns a ByteBuffer view of the null-terminated string pointed to by the pEngineName field.
      • pEngineNameString

        public java.lang.String pEngineNameString()
        Decodes the null-terminated string pointed to by the pEngineName field.
      • engineVersion

        public int engineVersion()
        Returns the value of the engineVersion field.
      • apiVersion

        public int apiVersion()
        Returns the value of the apiVersion field.
      • sType

        public VkApplicationInfo sType(int value)
        Sets the specified value to the sType field.
      • pNext

        public VkApplicationInfo pNext(long value)
        Sets the specified value to the pNext field.
      • pApplicationName

        public VkApplicationInfo pApplicationName(java.nio.ByteBuffer value)
        Sets the address of the specified encoded string to the pApplicationName field.
      • applicationVersion

        public VkApplicationInfo applicationVersion(int value)
        Sets the specified value to the applicationVersion field.
      • pEngineName

        public VkApplicationInfo pEngineName(java.nio.ByteBuffer value)
        Sets the address of the specified encoded string to the pEngineName field.
      • engineVersion

        public VkApplicationInfo engineVersion(int value)
        Sets the specified value to the engineVersion field.
      • apiVersion

        public VkApplicationInfo apiVersion(int value)
        Sets the specified value to the apiVersion field.
      • set

        public VkApplicationInfo set(int sType,
                                     long pNext,
                                     java.nio.ByteBuffer pApplicationName,
                                     int applicationVersion,
                                     java.nio.ByteBuffer pEngineName,
                                     int engineVersion,
                                     int apiVersion)
        Initializes this struct with the specified values.
      • create

        public static VkApplicationInfo create(long address)
        Returns a new VkApplicationInfo instance for the specified memory address or null if the address is NULL.