Package org.lwjgl.vulkan
Class VkPipelineCacheHeaderVersionOne
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPipelineCacheHeaderVersionOne>
org.lwjgl.vulkan.VkPipelineCacheHeaderVersionOne
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkPipelineCacheHeaderVersionOne
extends org.lwjgl.system.Struct<VkPipelineCacheHeaderVersionOne>
implements org.lwjgl.system.NativeResource
Structure describing the layout of the pipeline cache header.
Description
Unlike most structures declared by the Vulkan API, all fields of this structure are written with the least significant byte first, regardless of host byte-order.
The C language specification does not define the packing of structure members. This layout assumes tight structure member packing, with members laid out in the order listed in the structure, and the intended size of the structure is 32 bytes. If a compiler produces code that diverges from that pattern, applications must employ another method to set values at the correct offsets.
Valid Usage
headerSizemust be 32headerVersionmust bePIPELINE_CACHE_HEADER_VERSION_ONEheaderSizemust not exceed the size of the pipeline cache
Valid Usage (Implicit)
headerVersionmust be a validVkPipelineCacheHeaderVersionvalue
Layout
struct VkPipelineCacheHeaderVersionOne {
uint32_t headerSize();
VkPipelineCacheHeaderVersion headerVersion();
uint32_t vendorID();
uint32_t deviceID();
uint8_t pipelineCacheUUID()[VK_UUID_SIZE];
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkPipelineCacheHeaderVersionOnestructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkPipelineCacheHeaderVersionOne(ByteBuffer container) Creates aVkPipelineCacheHeaderVersionOneinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkPipelineCacheHeaderVersionOneinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCacheHeaderVersionOneinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkPipelineCacheHeaderVersionOneinstance allocated withBufferUtils.create(int capacity) Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkPipelineCacheHeaderVersionOneinstance for the specified memory address.create(long address, int capacity) Create aVkPipelineCacheHeaderVersionOne.Bufferinstance at the specified memory.static @Nullable VkPipelineCacheHeaderVersionOnecreateSafe(long address) static @Nullable VkPipelineCacheHeaderVersionOne.BuffercreateSafe(long address, int capacity) intdeviceID()theVkPhysicalDeviceProperties::deviceIDof the implementation.deviceID(int value) Sets the specified value to thedeviceID()field.intthe length in bytes of the pipeline cache header.headerSize(int value) Sets the specified value to theheaderSize()field.intaVkPipelineCacheHeaderVersionvalue specifying the version of the header.headerVersion(int value) Sets the specified value to theheaderVersion()field.malloc()Returns a newVkPipelineCacheHeaderVersionOneinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCacheHeaderVersionOneinstance allocated on the specifiedMemoryStack.static intndeviceID(long struct) Unsafe version ofdeviceID().static voidndeviceID(long struct, int value) Unsafe version ofdeviceID.static intnheaderSize(long struct) Unsafe version ofheaderSize().static voidnheaderSize(long struct, int value) Unsafe version ofheaderSize.static intnheaderVersion(long struct) Unsafe version ofheaderVersion().static voidnheaderVersion(long struct, int value) Unsafe version ofheaderVersion.static ByteBuffernpipelineCacheUUID(long struct) Unsafe version ofpipelineCacheUUID().static bytenpipelineCacheUUID(long struct, int index) Unsafe version ofpipelineCacheUUID.static voidnpipelineCacheUUID(long struct, int index, byte value) Unsafe version ofpipelineCacheUUID.static voidnpipelineCacheUUID(long struct, ByteBuffer value) Unsafe version ofpipelineCacheUUID.static intnvendorID(long struct) Unsafe version ofvendorID().static voidnvendorID(long struct, int value) Unsafe version ofvendorID.theVkPhysicalDeviceProperties::pipelineCacheUUIDof the implementation.bytepipelineCacheUUID(int index) theVkPhysicalDeviceProperties::pipelineCacheUUIDof the implementation.pipelineCacheUUID(int index, byte value) Sets the specified value at the specified index of thepipelineCacheUUID()field.pipelineCacheUUID(ByteBuffer value) Copies the specifiedByteBufferto thepipelineCacheUUID()field.set(int headerSize, int headerVersion, int vendorID, int deviceID, ByteBuffer pipelineCacheUUID) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intvendorID()theVkPhysicalDeviceProperties::vendorIDof the implementation.vendorID(int value) Sets the specified value to thevendorID()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
HEADERSIZE
public static final int HEADERSIZEThe struct member offsets. -
HEADERVERSION
public static final int HEADERVERSIONThe struct member offsets. -
VENDORID
public static final int VENDORIDThe struct member offsets. -
DEVICEID
public static final int DEVICEIDThe struct member offsets. -
PIPELINECACHEUUID
public static final int PIPELINECACHEUUIDThe struct member offsets.
-
-
Constructor Details
-
VkPipelineCacheHeaderVersionOne
Creates aVkPipelineCacheHeaderVersionOneinstance at the current position of the specifiedByteBuffercontainer. 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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkPipelineCacheHeaderVersionOne>
-
headerSize
public int headerSize()the length in bytes of the pipeline cache header. -
headerVersion
public int headerVersion()aVkPipelineCacheHeaderVersionvalue specifying the version of the header. A consumer of the pipeline cache should use the cache version to interpret the remainder of the cache header. -
vendorID
public int vendorID()theVkPhysicalDeviceProperties::vendorIDof the implementation. -
deviceID
public int deviceID()theVkPhysicalDeviceProperties::deviceIDof the implementation. -
pipelineCacheUUID
theVkPhysicalDeviceProperties::pipelineCacheUUIDof the implementation. -
pipelineCacheUUID
public byte pipelineCacheUUID(int index) theVkPhysicalDeviceProperties::pipelineCacheUUIDof the implementation. -
headerSize
Sets the specified value to theheaderSize()field. -
headerVersion
Sets the specified value to theheaderVersion()field. -
vendorID
Sets the specified value to thevendorID()field. -
deviceID
Sets the specified value to thedeviceID()field. -
pipelineCacheUUID
Copies the specifiedByteBufferto thepipelineCacheUUID()field. -
pipelineCacheUUID
Sets the specified value at the specified index of thepipelineCacheUUID()field. -
set
public VkPipelineCacheHeaderVersionOne set(int headerSize, int headerVersion, int vendorID, int deviceID, ByteBuffer pipelineCacheUUID) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkPipelineCacheHeaderVersionOneinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkPipelineCacheHeaderVersionOneinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkPipelineCacheHeaderVersionOneinstance allocated withBufferUtils. -
create
Returns a newVkPipelineCacheHeaderVersionOneinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkPipelineCacheHeaderVersionOne.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkPipelineCacheHeaderVersionOne.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkPipelineCacheHeaderVersionOneinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkPipelineCacheHeaderVersionOneinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPipelineCacheHeaderVersionOne.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkPipelineCacheHeaderVersionOne.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nheaderSize
public static int nheaderSize(long struct) Unsafe version ofheaderSize(). -
nheaderVersion
public static int nheaderVersion(long struct) Unsafe version ofheaderVersion(). -
nvendorID
public static int nvendorID(long struct) Unsafe version ofvendorID(). -
ndeviceID
public static int ndeviceID(long struct) Unsafe version ofdeviceID(). -
npipelineCacheUUID
Unsafe version ofpipelineCacheUUID(). -
npipelineCacheUUID
public static byte npipelineCacheUUID(long struct, int index) Unsafe version ofpipelineCacheUUID. -
nheaderSize
public static void nheaderSize(long struct, int value) Unsafe version ofheaderSize. -
nheaderVersion
public static void nheaderVersion(long struct, int value) Unsafe version ofheaderVersion. -
nvendorID
public static void nvendorID(long struct, int value) Unsafe version ofvendorID. -
ndeviceID
public static void ndeviceID(long struct, int value) Unsafe version ofdeviceID. -
npipelineCacheUUID
Unsafe version ofpipelineCacheUUID. -
npipelineCacheUUID
public static void npipelineCacheUUID(long struct, int index, byte value) Unsafe version ofpipelineCacheUUID.
-