Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPipelineCacheHeaderVersionOne

extends Struct<VkPipelineCacheHeaderVersionOne>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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
Valid Usage (Implicit)

Layout


struct VkPipelineCacheHeaderVersionOne {
    uint32_t headerSize;
    VkPipelineCacheHeaderVersion headerVersion;
    uint32_t vendorID;
    uint32_t deviceID;
    uint8_t pipelineCacheUUID[VK_UUID_SIZE];
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkPipelineCacheHeaderVersionOne.Buffer

An array of VkPipelineCacheHeaderVersionOne structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DEVICEID

The struct member offsets.

public static final int
HEADERSIZE

The struct member offsets.

public static final int
HEADERVERSION

The struct member offsets.

public static final int
PIPELINECACHEUUID

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
VENDORID

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkPipelineCacheHeaderVersionOne(long address, ByteBuffer container)

public
VkPipelineCacheHeaderVersionOne(ByteBuffer container)

Creates a VkPipelineCacheHeaderVersionOne instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkPipelineCacheHeaderVersionOne
calloc()

Returns a new VkPipelineCacheHeaderVersionOne instance allocated with memCalloc.

public static VkPipelineCacheHeaderVersionOne.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkPipelineCacheHeaderVersionOne.Buffer instance allocated with memCalloc.

public static VkPipelineCacheHeaderVersionOne
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkPipelineCacheHeaderVersionOne instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkPipelineCacheHeaderVersionOne.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkPipelineCacheHeaderVersionOne.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected VkPipelineCacheHeaderVersionOne
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkPipelineCacheHeaderVersionOne
create()

Returns a new VkPipelineCacheHeaderVersionOne instance allocated with BufferUtils.

public static VkPipelineCacheHeaderVersionOne
create(long address)

Returns a new VkPipelineCacheHeaderVersionOne instance for the specified memory address.

public static VkPipelineCacheHeaderVersionOne.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkPipelineCacheHeaderVersionOne.Buffer instance allocated with BufferUtils.

public static VkPipelineCacheHeaderVersionOne.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a VkPipelineCacheHeaderVersionOne.Buffer instance at the specified memory.

public static VkPipelineCacheHeaderVersionOne
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkPipelineCacheHeaderVersionOne.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
deviceID()

the VkPhysicalDeviceProperties::deviceID of the implementation.

public VkPipelineCacheHeaderVersionOne
deviceID(int value)

Sets the specified value to the deviceID field.

public int
headerSize()

the length in bytes of the pipeline cache header.

public VkPipelineCacheHeaderVersionOne
headerSize(int value)

Sets the specified value to the headerSize field.

public int
headerVersion()

a VkPipelineCacheHeaderVersion enum value specifying the version of the header.

public VkPipelineCacheHeaderVersionOne
headerVersion(int value)

Sets the specified value to the headerVersion field.

public static VkPipelineCacheHeaderVersionOne
malloc()

Returns a new VkPipelineCacheHeaderVersionOne instance allocated with memAlloc.

public static VkPipelineCacheHeaderVersionOne.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkPipelineCacheHeaderVersionOne.Buffer instance allocated with memAlloc.

public static VkPipelineCacheHeaderVersionOne
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkPipelineCacheHeaderVersionOne instance allocated on the specified MemoryStack.

public static VkPipelineCacheHeaderVersionOne.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkPipelineCacheHeaderVersionOne.Buffer instance allocated on the specified MemoryStack.

public static int
ndeviceID(long struct)

Unsafe version of deviceID.

public static void
ndeviceID(long struct, int value)

Unsafe version of deviceID.

public static int
nheaderSize(long struct)

Unsafe version of headerSize.

public static void
nheaderSize(long struct, int value)

Unsafe version of headerSize.

public static int
nheaderVersion(long struct)

Unsafe version of headerVersion.

public static void
nheaderVersion(long struct, int value)

Unsafe version of headerVersion.

public static ByteBuffer
npipelineCacheUUID(long struct)

Unsafe version of pipelineCacheUUID.

public static byte
npipelineCacheUUID(long struct, int index)

Unsafe version of pipelineCacheUUID.

public static void
npipelineCacheUUID(long struct, ByteBuffer value)

Unsafe version of pipelineCacheUUID.

public static void
npipelineCacheUUID(long struct, int index, byte value)

Unsafe version of pipelineCacheUUID.

public static int
nvendorID(long struct)

Unsafe version of vendorID.

public static void
nvendorID(long struct, int value)

Unsafe version of vendorID.

public ByteBuffer
pipelineCacheUUID()

the VkPhysicalDeviceProperties::pipelineCacheUUID of the implementation.

public byte
pipelineCacheUUID(int index)

the VkPhysicalDeviceProperties::pipelineCacheUUID of the implementation.

public VkPipelineCacheHeaderVersionOne
pipelineCacheUUID(ByteBuffer value)

Copies the specified ByteBuffer to the pipelineCacheUUID field.

public VkPipelineCacheHeaderVersionOne
pipelineCacheUUID(int index, byte value)

Sets the specified value at the specified index of the pipelineCacheUUID field.

public VkPipelineCacheHeaderVersionOne
set(int headerSize, int headerVersion, int vendorID, int deviceID, ByteBuffer pipelineCacheUUID)

Initializes this struct with the specified values.

public VkPipelineCacheHeaderVersionOne

Returns:

this struct
set(VkPipelineCacheHeaderVersionOne
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
vendorID()

the VkPhysicalDeviceProperties::vendorID of the implementation.

public VkPipelineCacheHeaderVersionOne
vendorID(int value)

Sets the specified value to the vendorID field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DEVICEIDback to summary
public static final int DEVICEID

The struct member offsets.

HEADERSIZEback to summary
public static final int HEADERSIZE

The struct member offsets.

HEADERVERSIONback to summary
public static final int HEADERVERSION

The struct member offsets.

PIPELINECACHEUUIDback to summary
public static final int PIPELINECACHEUUID

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

VENDORIDback to summary
public static final int VENDORID

The struct member offsets.

Constructor Detail

VkPipelineCacheHeaderVersionOneback to summary
protected VkPipelineCacheHeaderVersionOne(long address, ByteBuffer container)
VkPipelineCacheHeaderVersionOneback to summary
public VkPipelineCacheHeaderVersionOne(ByteBuffer container)

Creates a VkPipelineCacheHeaderVersionOne 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

callocback to summary
public static VkPipelineCacheHeaderVersionOne calloc()

Returns a new VkPipelineCacheHeaderVersionOne instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkPipelineCacheHeaderVersionOne.Buffer calloc(int capacity)

Returns a new VkPipelineCacheHeaderVersionOne.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPipelineCacheHeaderVersionOne calloc(MemoryStack stack)

Returns a new VkPipelineCacheHeaderVersionOne instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkPipelineCacheHeaderVersionOne.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkPipelineCacheHeaderVersionOne.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkPipelineCacheHeaderVersionOne create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkPipelineCacheHeaderVersionOne create()

Returns a new VkPipelineCacheHeaderVersionOne instance allocated with BufferUtils.

createback to summary
public static VkPipelineCacheHeaderVersionOne create(long address)

Returns a new VkPipelineCacheHeaderVersionOne instance for the specified memory address.

createback to summary
public static VkPipelineCacheHeaderVersionOne.Buffer create(int capacity)

Returns a new VkPipelineCacheHeaderVersionOne.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkPipelineCacheHeaderVersionOne.Buffer create(long address, int capacity)

Create a VkPipelineCacheHeaderVersionOne.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPipelineCacheHeaderVersionOne createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkPipelineCacheHeaderVersionOne.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
deviceIDback to summary
public int deviceID()

the VkPhysicalDeviceProperties::deviceID of the implementation.

Annotations
@NativeType:uint32_t
deviceIDback to summary
public VkPipelineCacheHeaderVersionOne deviceID(int value)

Sets the specified value to the deviceID field.

headerSizeback to summary
public int headerSize()

the length in bytes of the pipeline cache header.

Annotations
@NativeType:uint32_t
headerSizeback to summary
public VkPipelineCacheHeaderVersionOne headerSize(int value)

Sets the specified value to the headerSize field.

headerVersionback to summary
public int headerVersion()

a VkPipelineCacheHeaderVersion enum 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.

Annotations
@NativeType:VkPipelineCacheHeaderVersion
headerVersionback to summary
public VkPipelineCacheHeaderVersionOne headerVersion(int value)

Sets the specified value to the headerVersion field.

mallocback to summary
public static VkPipelineCacheHeaderVersionOne malloc()

Returns a new VkPipelineCacheHeaderVersionOne instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkPipelineCacheHeaderVersionOne.Buffer malloc(int capacity)

Returns a new VkPipelineCacheHeaderVersionOne.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPipelineCacheHeaderVersionOne malloc(MemoryStack stack)

Returns a new VkPipelineCacheHeaderVersionOne instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkPipelineCacheHeaderVersionOne.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkPipelineCacheHeaderVersionOne.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndeviceIDback to summary
public static int ndeviceID(long struct)

Unsafe version of deviceID.

ndeviceIDback to summary
public static void ndeviceID(long struct, int value)

Unsafe version of deviceID.

nheaderSizeback to summary
public static int nheaderSize(long struct)

Unsafe version of headerSize.

nheaderSizeback to summary
public static void nheaderSize(long struct, int value)

Unsafe version of headerSize.

nheaderVersionback to summary
public static int nheaderVersion(long struct)

Unsafe version of headerVersion.

nheaderVersionback to summary
public static void nheaderVersion(long struct, int value)

Unsafe version of headerVersion.

npipelineCacheUUIDback to summary
public static ByteBuffer npipelineCacheUUID(long struct)

Unsafe version of pipelineCacheUUID.

npipelineCacheUUIDback to summary
public static byte npipelineCacheUUID(long struct, int index)

Unsafe version of pipelineCacheUUID.

npipelineCacheUUIDback to summary
public static void npipelineCacheUUID(long struct, ByteBuffer value)

Unsafe version of pipelineCacheUUID.

npipelineCacheUUIDback to summary
public static void npipelineCacheUUID(long struct, int index, byte value)

Unsafe version of pipelineCacheUUID.

nvendorIDback to summary
public static int nvendorID(long struct)

Unsafe version of vendorID.

nvendorIDback to summary
public static void nvendorID(long struct, int value)

Unsafe version of vendorID.

pipelineCacheUUIDback to summary
public ByteBuffer pipelineCacheUUID()

the VkPhysicalDeviceProperties::pipelineCacheUUID of the implementation.

Annotations
@NativeType:uint8_t[VK_UUID_SIZE]
pipelineCacheUUIDback to summary
public byte pipelineCacheUUID(int index)

the VkPhysicalDeviceProperties::pipelineCacheUUID of the implementation.

Annotations
@NativeType:uint8_t
pipelineCacheUUIDback to summary
public VkPipelineCacheHeaderVersionOne pipelineCacheUUID(ByteBuffer value)

Copies the specified ByteBuffer to the pipelineCacheUUID field.

pipelineCacheUUIDback to summary
public VkPipelineCacheHeaderVersionOne pipelineCacheUUID(int index, byte value)

Sets the specified value at the specified index of the pipelineCacheUUID field.

setback to summary
public VkPipelineCacheHeaderVersionOne set(int headerSize, int headerVersion, int vendorID, int deviceID, ByteBuffer pipelineCacheUUID)

Initializes this struct with the specified values.

setback to summary
public VkPipelineCacheHeaderVersionOne set(VkPipelineCacheHeaderVersionOne src)

Copies the specified struct data to this struct.

Parameters
src:VkPipelineCacheHeaderVersionOne

the source struct

Returns:VkPipelineCacheHeaderVersionOne

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
vendorIDback to summary
public int vendorID()

the VkPhysicalDeviceProperties::vendorID of the implementation.

Annotations
@NativeType:uint32_t
vendorIDback to summary
public VkPipelineCacheHeaderVersionOne vendorID(int value)

Sets the specified value to the vendorID field.

org.lwjgl.vulkan back to summary

public Class VkPipelineCacheHeaderVersionOne.Buffer

extends StructBuffer<VkPipelineCacheHeaderVersionOne, VkPipelineCacheHeaderVersionOne.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkPipelineCacheHeaderVersionOne structs.

Field Summary

Modifier and TypeField and Description
private static final VkPipelineCacheHeaderVersionOne
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPipelineCacheHeaderVersionOne.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the VkPipelineCacheHeaderVersionOne#deviceID field.
deviceID()

public VkPipelineCacheHeaderVersionOne.Buffer
deviceID(int value)

Sets the specified value to the VkPipelineCacheHeaderVersionOne#deviceID field.

protected VkPipelineCacheHeaderVersionOne
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public int

Returns:

the value of the VkPipelineCacheHeaderVersionOne#headerSize field.
headerSize()

public VkPipelineCacheHeaderVersionOne.Buffer
headerSize(int value)

Sets the specified value to the VkPipelineCacheHeaderVersionOne#headerSize field.

public int

Returns:

the value of the VkPipelineCacheHeaderVersionOne#headerVersion field.
headerVersion()

public VkPipelineCacheHeaderVersionOne.Buffer
headerVersion(int value)

Sets the specified value to the VkPipelineCacheHeaderVersionOne#headerVersion field.

public ByteBuffer

Returns:

a ByteBuffer view of the VkPipelineCacheHeaderVersionOne#pipelineCacheUUID field.
pipelineCacheUUID()

public byte

Returns:

the value at the specified index of the VkPipelineCacheHeaderVersionOne#pipelineCacheUUID field.
pipelineCacheUUID(int index)

public VkPipelineCacheHeaderVersionOne.Buffer
pipelineCacheUUID(ByteBuffer value)

Copies the specified ByteBuffer to the VkPipelineCacheHeaderVersionOne#pipelineCacheUUID field.

public VkPipelineCacheHeaderVersionOne.Buffer
pipelineCacheUUID(int index, byte value)

Sets the specified value at the specified index of the VkPipelineCacheHeaderVersionOne#pipelineCacheUUID field.

protected VkPipelineCacheHeaderVersionOne.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the VkPipelineCacheHeaderVersionOne#vendorID field.
vendorID()

public VkPipelineCacheHeaderVersionOne.Buffer
vendorID(int value)

Sets the specified value to the VkPipelineCacheHeaderVersionOne#vendorID field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPipelineCacheHeaderVersionOne ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPipelineCacheHeaderVersionOne.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 VkPipelineCacheHeaderVersionOne#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

deviceIDback to summary
public int deviceID()
Returns:int

the value of the VkPipelineCacheHeaderVersionOne#deviceID field.

Annotations
@NativeType:uint32_t
deviceIDback to summary
public VkPipelineCacheHeaderVersionOne.Buffer deviceID(int value)

Sets the specified value to the VkPipelineCacheHeaderVersionOne#deviceID field.

getElementFactoryback to summary
protected VkPipelineCacheHeaderVersionOne getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
headerSizeback to summary
public int headerSize()
Returns:int

the value of the VkPipelineCacheHeaderVersionOne#headerSize field.

Annotations
@NativeType:uint32_t
headerSizeback to summary
public VkPipelineCacheHeaderVersionOne.Buffer headerSize(int value)

Sets the specified value to the VkPipelineCacheHeaderVersionOne#headerSize field.

headerVersionback to summary
public int headerVersion()
Returns:int

the value of the VkPipelineCacheHeaderVersionOne#headerVersion field.

Annotations
@NativeType:VkPipelineCacheHeaderVersion
headerVersionback to summary
public VkPipelineCacheHeaderVersionOne.Buffer headerVersion(int value)

Sets the specified value to the VkPipelineCacheHeaderVersionOne#headerVersion field.

pipelineCacheUUIDback to summary
public ByteBuffer pipelineCacheUUID()
Returns:ByteBuffer

a ByteBuffer view of the VkPipelineCacheHeaderVersionOne#pipelineCacheUUID field.

Annotations
@NativeType:uint8_t[VK_UUID_SIZE]
pipelineCacheUUIDback to summary
public byte pipelineCacheUUID(int index)
Returns:byte

the value at the specified index of the VkPipelineCacheHeaderVersionOne#pipelineCacheUUID field.

Annotations
@NativeType:uint8_t
pipelineCacheUUIDback to summary
public VkPipelineCacheHeaderVersionOne.Buffer pipelineCacheUUID(ByteBuffer value)

Copies the specified ByteBuffer to the VkPipelineCacheHeaderVersionOne#pipelineCacheUUID field.

pipelineCacheUUIDback to summary
public VkPipelineCacheHeaderVersionOne.Buffer pipelineCacheUUID(int index, byte value)

Sets the specified value at the specified index of the VkPipelineCacheHeaderVersionOne#pipelineCacheUUID field.

selfback to summary
protected VkPipelineCacheHeaderVersionOne.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
vendorIDback to summary
public int vendorID()
Returns:int

the value of the VkPipelineCacheHeaderVersionOne#vendorID field.

Annotations
@NativeType:uint32_t
vendorIDback to summary
public VkPipelineCacheHeaderVersionOne.Buffer vendorID(int value)

Sets the specified value to the VkPipelineCacheHeaderVersionOne#vendorID field.