Package org.lwjgl.vulkan
Class VkApplicationInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkApplicationInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkApplicationInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about the application.
Valid Usage
sType
must beSTRUCTURE_TYPE_APPLICATION_INFO
pNext
must beNULL
- If
pApplicationName
is notNULL
,pApplicationName
must be a null-terminated string - If
pEngineName
is notNULL
,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 extensionspApplicationName
– a pointer to aNULL
-terminated UTF-8 string containing the name of the applicationapplicationVersion
– contains an application-specific version number. It is recommended that new versions of an existing application specify monotonically increasing values forapplicationVersion
.pEngineName
– if the application is built on a reusable engine, the name of the engine may be specified in theNULL
-terminated UTF-8 string pointed to bypEngineName
engineVersion
– the version of the engine used to create the applicationapiVersion
– 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; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkApplicationInfo.Buffer
An array ofVkApplicationInfo
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkApplicationInfo(java.nio.ByteBuffer container)
Creates aVkApplicationInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description int
apiVersion()
Returns the value of theapiVersion
field.VkApplicationInfo
apiVersion(int value)
Sets the specified value to theapiVersion
field.int
applicationVersion()
Returns the value of theapplicationVersion
field.VkApplicationInfo
applicationVersion(int value)
Sets the specified value to theapplicationVersion
field.static VkApplicationInfo
calloc()
Returns a newVkApplicationInfo
instance allocated withmemCalloc
.static VkApplicationInfo.Buffer
calloc(int capacity)
Returns a newVkApplicationInfo.Buffer
instance allocated withmemCalloc
.static VkApplicationInfo
callocStack()
Returns a newVkApplicationInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkApplicationInfo.Buffer
callocStack(int capacity)
Returns a newVkApplicationInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkApplicationInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkApplicationInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkApplicationInfo
callocStack(MemoryStack stack)
Returns a newVkApplicationInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkApplicationInfo
create()
Returns a newVkApplicationInfo
instance allocated withBufferUtils
.static VkApplicationInfo.Buffer
create(int capacity)
Returns a newVkApplicationInfo.Buffer
instance allocated withBufferUtils
.static VkApplicationInfo
create(long address)
Returns a newVkApplicationInfo
instance for the specified memory address ornull
if the address isNULL
.static VkApplicationInfo.Buffer
create(long address, int capacity)
Create aVkApplicationInfo.Buffer
instance at the specified memory.int
engineVersion()
Returns the value of theengineVersion
field.VkApplicationInfo
engineVersion(int value)
Sets the specified value to theengineVersion
field.static VkApplicationInfo
malloc()
Returns a newVkApplicationInfo
instance allocated withmemAlloc
.static VkApplicationInfo.Buffer
malloc(int capacity)
Returns a newVkApplicationInfo.Buffer
instance allocated withmemAlloc
.static VkApplicationInfo
mallocStack()
Returns a newVkApplicationInfo
instance allocated on the thread-localMemoryStack
.static VkApplicationInfo.Buffer
mallocStack(int capacity)
Returns a newVkApplicationInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkApplicationInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkApplicationInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkApplicationInfo
mallocStack(MemoryStack stack)
Returns a newVkApplicationInfo
instance allocated on the specifiedMemoryStack
.VkApplicationInfo
nset(long struct)
Unsafe version ofset
.java.nio.ByteBuffer
pApplicationName()
Returns aByteBuffer
view of the null-terminated string pointed to by thepApplicationName
field.VkApplicationInfo
pApplicationName(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thepApplicationName
field.java.lang.String
pApplicationNameString()
Decodes the null-terminated string pointed to by thepApplicationName
field.java.nio.ByteBuffer
pEngineName()
Returns aByteBuffer
view of the null-terminated string pointed to by thepEngineName
field.VkApplicationInfo
pEngineName(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thepEngineName
field.java.lang.String
pEngineNameString()
Decodes the null-terminated string pointed to by thepEngineName
field.long
pNext()
Returns the value of thepNext
field.VkApplicationInfo
pNext(long value)
Sets the specified value to thepNext
field.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.VkApplicationInfo
set(VkApplicationInfo src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkApplicationInfo
sType(int value)
Sets the specified value to thesType
field.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkApplicationInfo
public VkApplicationInfo(java.nio.ByteBuffer container)
Creates aVkApplicationInfo
instance at the current position of the specifiedByteBuffer
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 thesizeof(struct)
.
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
pApplicationName
public java.nio.ByteBuffer pApplicationName()
Returns aByteBuffer
view of the null-terminated string pointed to by thepApplicationName
field.
-
pApplicationNameString
public java.lang.String pApplicationNameString()
Decodes the null-terminated string pointed to by thepApplicationName
field.
-
applicationVersion
public int applicationVersion()
Returns the value of theapplicationVersion
field.
-
pEngineName
public java.nio.ByteBuffer pEngineName()
Returns aByteBuffer
view of the null-terminated string pointed to by thepEngineName
field.
-
pEngineNameString
public java.lang.String pEngineNameString()
Decodes the null-terminated string pointed to by thepEngineName
field.
-
engineVersion
public int engineVersion()
Returns the value of theengineVersion
field.
-
apiVersion
public int apiVersion()
Returns the value of theapiVersion
field.
-
sType
public VkApplicationInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkApplicationInfo pNext(long value)
Sets the specified value to thepNext
field.
-
pApplicationName
public VkApplicationInfo pApplicationName(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thepApplicationName
field.
-
applicationVersion
public VkApplicationInfo applicationVersion(int value)
Sets the specified value to theapplicationVersion
field.
-
pEngineName
public VkApplicationInfo pEngineName(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thepEngineName
field.
-
engineVersion
public VkApplicationInfo engineVersion(int value)
Sets the specified value to theengineVersion
field.
-
apiVersion
public VkApplicationInfo apiVersion(int value)
Sets the specified value to theapiVersion
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.
-
nset
public VkApplicationInfo nset(long struct)
Unsafe version ofset
.
-
set
public VkApplicationInfo set(VkApplicationInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkApplicationInfo malloc()
Returns a newVkApplicationInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkApplicationInfo calloc()
Returns a newVkApplicationInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkApplicationInfo create()
Returns a newVkApplicationInfo
instance allocated withBufferUtils
.
-
create
public static VkApplicationInfo create(long address)
Returns a newVkApplicationInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkApplicationInfo.Buffer malloc(int capacity)
Returns a newVkApplicationInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkApplicationInfo.Buffer calloc(int capacity)
Returns a newVkApplicationInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkApplicationInfo.Buffer create(int capacity)
Returns a newVkApplicationInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkApplicationInfo.Buffer create(long address, int capacity)
Create aVkApplicationInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkApplicationInfo mallocStack()
Returns a newVkApplicationInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkApplicationInfo callocStack()
Returns a newVkApplicationInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkApplicationInfo mallocStack(MemoryStack stack)
Returns a newVkApplicationInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkApplicationInfo callocStack(MemoryStack stack)
Returns a newVkApplicationInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkApplicationInfo.Buffer mallocStack(int capacity)
Returns a newVkApplicationInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkApplicationInfo.Buffer callocStack(int capacity)
Returns a newVkApplicationInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkApplicationInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkApplicationInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkApplicationInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkApplicationInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-