Package org.lwjgl.vulkan
Class VkPipelineCacheHeaderVersionOne
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPipelineCacheHeaderVersionOne
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkPipelineCacheHeaderVersionOne extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure 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_ONE
Valid Usage (Implicit)
headerVersionmust be a validVkPipelineCacheHeaderVersionvalue
Layout
struct VkPipelineCacheHeaderVersionOne { uint32_theaderSize(); VkPipelineCacheHeaderVersionheaderVersion(); uint32_tvendorID(); uint32_tdeviceID(); uint8_tpipelineCacheUUID()[VK_UUID_SIZE]; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkPipelineCacheHeaderVersionOne.BufferAn array ofVkPipelineCacheHeaderVersionOnestructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intDEVICEID
HEADERSIZE
HEADERVERSION
PIPELINECACHEUUIDThe struct member offsets.static intSIZEOFThe struct size in bytes.static intVENDORIDThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPipelineCacheHeaderVersionOne(java.nio.ByteBuffer container)Creates aVkPipelineCacheHeaderVersionOneinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPipelineCacheHeaderVersionOnecalloc()Returns a newVkPipelineCacheHeaderVersionOneinstance allocated withmemCalloc.static VkPipelineCacheHeaderVersionOne.Buffercalloc(int capacity)Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated withmemCalloc.static VkPipelineCacheHeaderVersionOne.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineCacheHeaderVersionOnecalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineCacheHeaderVersionOneinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineCacheHeaderVersionOnecreate()Returns a newVkPipelineCacheHeaderVersionOneinstance allocated withBufferUtils.static VkPipelineCacheHeaderVersionOne.Buffercreate(int capacity)Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated withBufferUtils.static VkPipelineCacheHeaderVersionOnecreate(long address)Returns a newVkPipelineCacheHeaderVersionOneinstance for the specified memory address.static VkPipelineCacheHeaderVersionOne.Buffercreate(long address, int capacity)Create aVkPipelineCacheHeaderVersionOne.Bufferinstance at the specified memory.static VkPipelineCacheHeaderVersionOnecreateSafe(long address)static VkPipelineCacheHeaderVersionOne.BuffercreateSafe(long address, int capacity)intdeviceID()theVkPhysicalDeviceProperties::deviceIDof the implementation.VkPipelineCacheHeaderVersionOnedeviceID(int value)Sets the specified value to thedeviceID()field.intheaderSize()the length in bytes of the pipeline cache header.VkPipelineCacheHeaderVersionOneheaderSize(int value)Sets the specified value to theheaderSize()field.intheaderVersion()aVkPipelineCacheHeaderVersionenum value specifying the version of the header.VkPipelineCacheHeaderVersionOneheaderVersion(int value)Sets the specified value to theheaderVersion()field.static VkPipelineCacheHeaderVersionOnemalloc()Returns a newVkPipelineCacheHeaderVersionOneinstance allocated withmemAlloc.static VkPipelineCacheHeaderVersionOne.Buffermalloc(int capacity)Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated withmemAlloc.static VkPipelineCacheHeaderVersionOne.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated on the specifiedMemoryStack.static VkPipelineCacheHeaderVersionOnemalloc(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 java.nio.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, java.nio.ByteBuffer value)Unsafe version ofpipelineCacheUUID.static intnvendorID(long struct)Unsafe version ofvendorID().static voidnvendorID(long struct, int value)Unsafe version ofvendorID.java.nio.ByteBufferpipelineCacheUUID()theVkPhysicalDeviceProperties::pipelineCacheUUIDof the implementation.bytepipelineCacheUUID(int index)theVkPhysicalDeviceProperties::pipelineCacheUUIDof the implementation.VkPipelineCacheHeaderVersionOnepipelineCacheUUID(int index, byte value)Sets the specified value at the specified index of thepipelineCacheUUID()field.VkPipelineCacheHeaderVersionOnepipelineCacheUUID(java.nio.ByteBuffer value)Copies the specifiedByteBufferto thepipelineCacheUUID()field.VkPipelineCacheHeaderVersionOneset(int headerSize, int headerVersion, int vendorID, int deviceID, java.nio.ByteBuffer pipelineCacheUUID)Initializes this struct with the specified values.VkPipelineCacheHeaderVersionOneset(VkPipelineCacheHeaderVersionOne src)Copies the specified struct data to this struct.intsizeof()intvendorID()theVkPhysicalDeviceProperties::vendorIDof the implementation.VkPipelineCacheHeaderVersionOnevendorID(int value)Sets the specified value to thevendorID()field.
-
-
-
Constructor Detail
-
VkPipelineCacheHeaderVersionOne
public VkPipelineCacheHeaderVersionOne(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
headerSize
public int headerSize()
the length in bytes of the pipeline cache header.
-
headerVersion
public int headerVersion()
aVkPipelineCacheHeaderVersionenum value 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
public java.nio.ByteBuffer pipelineCacheUUID() public byte pipelineCacheUUID(int index)
theVkPhysicalDeviceProperties::pipelineCacheUUIDof the implementation.
-
headerSize
public VkPipelineCacheHeaderVersionOne headerSize(int value)
Sets the specified value to theheaderSize()field.
-
headerVersion
public VkPipelineCacheHeaderVersionOne headerVersion(int value)
Sets the specified value to theheaderVersion()field.
-
vendorID
public VkPipelineCacheHeaderVersionOne vendorID(int value)
Sets the specified value to thevendorID()field.
-
deviceID
public VkPipelineCacheHeaderVersionOne deviceID(int value)
Sets the specified value to thedeviceID()field.
-
pipelineCacheUUID
public VkPipelineCacheHeaderVersionOne pipelineCacheUUID(java.nio.ByteBuffer value)
Copies the specifiedByteBufferto thepipelineCacheUUID()field.
-
pipelineCacheUUID
public VkPipelineCacheHeaderVersionOne pipelineCacheUUID(int index, byte value)
Sets the specified value at the specified index of thepipelineCacheUUID()field.
-
set
public VkPipelineCacheHeaderVersionOne set(int headerSize, int headerVersion, int vendorID, int deviceID, java.nio.ByteBuffer pipelineCacheUUID)
Initializes this struct with the specified values.
-
set
public VkPipelineCacheHeaderVersionOne set(VkPipelineCacheHeaderVersionOne src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkPipelineCacheHeaderVersionOne malloc()
Returns a newVkPipelineCacheHeaderVersionOneinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPipelineCacheHeaderVersionOne calloc()
Returns a newVkPipelineCacheHeaderVersionOneinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPipelineCacheHeaderVersionOne create()
Returns a newVkPipelineCacheHeaderVersionOneinstance allocated withBufferUtils.
-
create
public static VkPipelineCacheHeaderVersionOne create(long address)
Returns a newVkPipelineCacheHeaderVersionOneinstance for the specified memory address.
-
createSafe
@Nullable public static VkPipelineCacheHeaderVersionOne createSafe(long address)
-
malloc
public static VkPipelineCacheHeaderVersionOne.Buffer malloc(int capacity)
Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPipelineCacheHeaderVersionOne.Buffer calloc(int capacity)
Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineCacheHeaderVersionOne.Buffer create(int capacity)
Returns a newVkPipelineCacheHeaderVersionOne.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineCacheHeaderVersionOne.Buffer create(long address, int capacity)
Create aVkPipelineCacheHeaderVersionOne.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkPipelineCacheHeaderVersionOne.Buffer createSafe(long address, int capacity)
-
malloc
public static VkPipelineCacheHeaderVersionOne malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineCacheHeaderVersionOneinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkPipelineCacheHeaderVersionOne calloc(org.lwjgl.system.MemoryStack stack)
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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
public static java.nio.ByteBuffer npipelineCacheUUID(long struct)
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
public static void npipelineCacheUUID(long struct, java.nio.ByteBuffer value)Unsafe version ofpipelineCacheUUID.
-
npipelineCacheUUID
public static void npipelineCacheUUID(long struct, int index, byte value)Unsafe version ofpipelineCacheUUID.
-
-