org.lwjgl.vulkan.VkApplicationInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vulkan Show documentation
Show all versions of lwjgl-vulkan Show documentation
A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.vulkan;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure specifying application info.
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link VK10#VK_STRUCTURE_TYPE_APPLICATION_INFO STRUCTURE_TYPE_APPLICATION_INFO}
* - {@code pNext} must be {@code NULL}
* - If {@code pApplicationName} is not {@code NULL}, {@code pApplicationName} must be a null-terminated UTF-8 string
* - If {@code pEngineName} is not {@code NULL}, {@code pEngineName} must be a null-terminated UTF-8 string
*
*
* See Also
*
* {@link VkInstanceCreateInfo}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code pApplicationName} – {@code NULL} or is a pointer to a null-terminated UTF-8 string containing the name of the application.
* - {@code applicationVersion} – an unsigned integer variable containing the developer-supplied version number of the application.
* - {@code pEngineName} – {@code NULL} or is a pointer to a null-terminated UTF-8 string containing the name of the engine (if any) used to create the application.
* - {@code engineVersion} – an unsigned integer variable containing the developer-supplied version number of the engine used to create the application.
* - {@code apiVersion} – the version of the Vulkan API against which the application expects to run, encoded as described in the API Version Numbers and Semantics section. If {@code apiVersion} is 0 the implementation must ignore it, otherwise if the implementation does not support the requested {@code apiVersion}, or an effective substitute for {@code apiVersion}, it must return {@link VK10#VK_ERROR_INCOMPATIBLE_DRIVER ERROR_INCOMPATIBLE_DRIVER}. The patch version number specified in {@code apiVersion} is ignored when creating an instance object. Only the major and minor versions of the instance must match those requested in {@code apiVersion}.
*
*
* Layout
*
*
* struct VkApplicationInfo {
* VkStructureType sType;
* const void * pNext;
* const char * pApplicationName;
* uint32_t applicationVersion;
* const char * pEngineName;
* uint32_t engineVersion;
* uint32_t apiVersion;
* }The created instance holds a strong reference to the container object.
*/
public VkApplicationInfo(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return npNext(address()); }
/** Returns a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code pApplicationName} field. */
@Nullable
@NativeType("const char *")
public ByteBuffer pApplicationName() { return npApplicationName(address()); }
/** Decodes the null-terminated string pointed to by the {@code pApplicationName} field. */
@Nullable
@NativeType("const char *")
public String pApplicationNameString() { return npApplicationNameString(address()); }
/** Returns the value of the {@code applicationVersion} field. */
@NativeType("uint32_t")
public int applicationVersion() { return napplicationVersion(address()); }
/** Returns a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code pEngineName} field. */
@Nullable
@NativeType("const char *")
public ByteBuffer pEngineName() { return npEngineName(address()); }
/** Decodes the null-terminated string pointed to by the {@code pEngineName} field. */
@Nullable
@NativeType("const char *")
public String pEngineNameString() { return npEngineNameString(address()); }
/** Returns the value of the {@code engineVersion} field. */
@NativeType("uint32_t")
public int engineVersion() { return nengineVersion(address()); }
/** Returns the value of the {@code apiVersion} field. */
@NativeType("uint32_t")
public int apiVersion() { return napiVersion(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkApplicationInfo sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkApplicationInfo pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the address of the specified encoded string to the {@code pApplicationName} field. */
public VkApplicationInfo pApplicationName(@Nullable @NativeType("const char *") ByteBuffer value) { npApplicationName(address(), value); return this; }
/** Sets the specified value to the {@code applicationVersion} field. */
public VkApplicationInfo applicationVersion(@NativeType("uint32_t") int value) { napplicationVersion(address(), value); return this; }
/** Sets the address of the specified encoded string to the {@code pEngineName} field. */
public VkApplicationInfo pEngineName(@Nullable @NativeType("const char *") ByteBuffer value) { npEngineName(address(), value); return this; }
/** Sets the specified value to the {@code engineVersion} field. */
public VkApplicationInfo engineVersion(@NativeType("uint32_t") int value) { nengineVersion(address(), value); return this; }
/** Sets the specified value to the {@code apiVersion} field. */
public VkApplicationInfo apiVersion(@NativeType("uint32_t") int value) { napiVersion(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkApplicationInfo set(
int sType,
long pNext,
ByteBuffer pApplicationName,
int applicationVersion,
ByteBuffer pEngineName,
int engineVersion,
int apiVersion
) {
sType(sType);
pNext(pNext);
pApplicationName(pApplicationName);
applicationVersion(applicationVersion);
pEngineName(pEngineName);
engineVersion(engineVersion);
apiVersion(apiVersion);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkApplicationInfo set(VkApplicationInfo src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkApplicationInfo} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkApplicationInfo malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkApplicationInfo} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkApplicationInfo calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkApplicationInfo} instance allocated with {@link BufferUtils}. */
public static VkApplicationInfo create() {
return new VkApplicationInfo(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkApplicationInfo} instance for the specified memory address. */
public static VkApplicationInfo create(long address) {
return new VkApplicationInfo(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkApplicationInfo createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkApplicationInfo.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkApplicationInfo.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkApplicationInfo.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkApplicationInfo.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkApplicationInfo.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkApplicationInfo.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkApplicationInfo.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkApplicationInfo.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkApplicationInfo.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkApplicationInfo} instance allocated on the thread-local {@link MemoryStack}. */
public static VkApplicationInfo mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkApplicationInfo} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkApplicationInfo callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkApplicationInfo} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkApplicationInfo mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkApplicationInfo} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkApplicationInfo callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkApplicationInfo.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkApplicationInfo.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkApplicationInfo.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkApplicationInfo.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkApplicationInfo.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkApplicationInfo.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkApplicationInfo.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkApplicationInfo.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #sType}. */
public static int nsType(long struct) { return memGetInt(struct + VkApplicationInfo.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkApplicationInfo.PNEXT); }
/** Unsafe version of {@link #pApplicationName}. */
@Nullable public static ByteBuffer npApplicationName(long struct) { return memByteBufferNT1Safe(memGetAddress(struct + VkApplicationInfo.PAPPLICATIONNAME)); }
/** Unsafe version of {@link #pApplicationNameString}. */
@Nullable public static String npApplicationNameString(long struct) { return memUTF8Safe(memGetAddress(struct + VkApplicationInfo.PAPPLICATIONNAME)); }
/** Unsafe version of {@link #applicationVersion}. */
public static int napplicationVersion(long struct) { return memGetInt(struct + VkApplicationInfo.APPLICATIONVERSION); }
/** Unsafe version of {@link #pEngineName}. */
@Nullable public static ByteBuffer npEngineName(long struct) { return memByteBufferNT1Safe(memGetAddress(struct + VkApplicationInfo.PENGINENAME)); }
/** Unsafe version of {@link #pEngineNameString}. */
@Nullable public static String npEngineNameString(long struct) { return memUTF8Safe(memGetAddress(struct + VkApplicationInfo.PENGINENAME)); }
/** Unsafe version of {@link #engineVersion}. */
public static int nengineVersion(long struct) { return memGetInt(struct + VkApplicationInfo.ENGINEVERSION); }
/** Unsafe version of {@link #apiVersion}. */
public static int napiVersion(long struct) { return memGetInt(struct + VkApplicationInfo.APIVERSION); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkApplicationInfo.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkApplicationInfo.PNEXT, value); }
/** Unsafe version of {@link #pApplicationName(ByteBuffer) pApplicationName}. */
public static void npApplicationName(long struct, @Nullable ByteBuffer value) {
if (CHECKS) { checkNT1Safe(value); }
memPutAddress(struct + VkApplicationInfo.PAPPLICATIONNAME, memAddressSafe(value));
}
/** Unsafe version of {@link #applicationVersion(int) applicationVersion}. */
public static void napplicationVersion(long struct, int value) { memPutInt(struct + VkApplicationInfo.APPLICATIONVERSION, value); }
/** Unsafe version of {@link #pEngineName(ByteBuffer) pEngineName}. */
public static void npEngineName(long struct, @Nullable ByteBuffer value) {
if (CHECKS) { checkNT1Safe(value); }
memPutAddress(struct + VkApplicationInfo.PENGINENAME, memAddressSafe(value));
}
/** Unsafe version of {@link #engineVersion(int) engineVersion}. */
public static void nengineVersion(long struct, int value) { memPutInt(struct + VkApplicationInfo.ENGINEVERSION, value); }
/** Unsafe version of {@link #apiVersion(int) apiVersion}. */
public static void napiVersion(long struct, int value) { memPutInt(struct + VkApplicationInfo.APIVERSION, value); }
// -----------------------------------
/** An array of {@link VkApplicationInfo} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkApplicationInfo.Buffer} instance backed by the specified container.
*
* Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values
* will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided
* by {@link VkApplicationInfo#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected Buffer newBufferInstance(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkApplicationInfo newInstance(long address) {
return new VkApplicationInfo(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkApplicationInfo.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkApplicationInfo.npNext(address()); }
/** Returns a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code pApplicationName} field. */
@Nullable
@NativeType("const char *")
public ByteBuffer pApplicationName() { return VkApplicationInfo.npApplicationName(address()); }
/** Decodes the null-terminated string pointed to by the {@code pApplicationName} field. */
@Nullable
@NativeType("const char *")
public String pApplicationNameString() { return VkApplicationInfo.npApplicationNameString(address()); }
/** Returns the value of the {@code applicationVersion} field. */
@NativeType("uint32_t")
public int applicationVersion() { return VkApplicationInfo.napplicationVersion(address()); }
/** Returns a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code pEngineName} field. */
@Nullable
@NativeType("const char *")
public ByteBuffer pEngineName() { return VkApplicationInfo.npEngineName(address()); }
/** Decodes the null-terminated string pointed to by the {@code pEngineName} field. */
@Nullable
@NativeType("const char *")
public String pEngineNameString() { return VkApplicationInfo.npEngineNameString(address()); }
/** Returns the value of the {@code engineVersion} field. */
@NativeType("uint32_t")
public int engineVersion() { return VkApplicationInfo.nengineVersion(address()); }
/** Returns the value of the {@code apiVersion} field. */
@NativeType("uint32_t")
public int apiVersion() { return VkApplicationInfo.napiVersion(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkApplicationInfo.Buffer sType(@NativeType("VkStructureType") int value) { VkApplicationInfo.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkApplicationInfo.Buffer pNext(@NativeType("const void *") long value) { VkApplicationInfo.npNext(address(), value); return this; }
/** Sets the address of the specified encoded string to the {@code pApplicationName} field. */
public VkApplicationInfo.Buffer pApplicationName(@Nullable @NativeType("const char *") ByteBuffer value) { VkApplicationInfo.npApplicationName(address(), value); return this; }
/** Sets the specified value to the {@code applicationVersion} field. */
public VkApplicationInfo.Buffer applicationVersion(@NativeType("uint32_t") int value) { VkApplicationInfo.napplicationVersion(address(), value); return this; }
/** Sets the address of the specified encoded string to the {@code pEngineName} field. */
public VkApplicationInfo.Buffer pEngineName(@Nullable @NativeType("const char *") ByteBuffer value) { VkApplicationInfo.npEngineName(address(), value); return this; }
/** Sets the specified value to the {@code engineVersion} field. */
public VkApplicationInfo.Buffer engineVersion(@NativeType("uint32_t") int value) { VkApplicationInfo.nengineVersion(address(), value); return this; }
/** Sets the specified value to the {@code apiVersion} field. */
public VkApplicationInfo.Buffer apiVersion(@NativeType("uint32_t") int value) { VkApplicationInfo.napiVersion(address(), value); return this; }
}
}