Structure specifying the type of a newly created semaphore.

Description

To create a semaphore of a specific type, add a VkSemaphoreTypeCreateInfo structure to the VkSemaphoreCreateInfo::pNext chain.

If no VkSemaphoreTypeCreateInfo structure is included in the pNext chain of VkSemaphoreCreateInfo, then the created semaphore will have a default VkSemaphoreType of SEMAPHORE_TYPE_BINARY.

Valid Usage

If the timelineSemaphore feature is not enabled, semaphoreType must not equal SEMAPHORE_TYPE_TIMELINE
If semaphoreType is SEMAPHORE_TYPE_BINARY, initialValue must be zero

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO
semaphoreType must be a valid VkSemaphoreType value

Layout


struct VkSemaphoreTypeCreateInfo {
    VkStructureType sType;
    void const * pNext;
    VkSemaphoreType semaphoreType;
    uint64_t initialValue;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkSemaphoreTypeCreateInfo.Buffer An array of `VkSemaphoreTypeCreateInfo` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	INITIALVALUE The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	SEMAPHORETYPE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkSemaphoreTypeCreateInfo(long address, ByteBuffer container)
public	VkSemaphoreTypeCreateInfo(ByteBuffer container) Creates a `VkSemaphoreTypeCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkSemaphoreTypeCreateInfo	calloc() Returns a new `VkSemaphoreTypeCreateInfo` instance allocated with `memCalloc`.
public static VkSemaphoreTypeCreateInfo.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkSemaphoreTypeCreateInfo.Buffer` instance allocated with `memCalloc`.
public static VkSemaphoreTypeCreateInfo	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSemaphoreTypeCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSemaphoreTypeCreateInfo.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSemaphoreTypeCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkSemaphoreTypeCreateInfo	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 VkSemaphoreTypeCreateInfo	create() Returns a new `VkSemaphoreTypeCreateInfo` instance allocated with `BufferUtils`.
public static VkSemaphoreTypeCreateInfo	create(long address) Returns a new `VkSemaphoreTypeCreateInfo` instance for the specified memory address.
public static VkSemaphoreTypeCreateInfo.Buffer	create(int the buffer capacity capacity) Returns a new `VkSemaphoreTypeCreateInfo.Buffer` instance allocated with `BufferUtils`.
public static VkSemaphoreTypeCreateInfo.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkSemaphoreTypeCreateInfo.Buffer` instance at the specified memory.
public static VkSemaphoreTypeCreateInfo	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkSemaphoreTypeCreateInfo.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public long	initialValue() the initial payload value if `semaphoreType` is `SEMAPHORE_TYPE_TIMELINE`.
public VkSemaphoreTypeCreateInfo	initialValue(long value) Sets the specified value to the `initialValue` field.
public static VkSemaphoreTypeCreateInfo	malloc() Returns a new `VkSemaphoreTypeCreateInfo` instance allocated with `memAlloc`.
public static VkSemaphoreTypeCreateInfo.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkSemaphoreTypeCreateInfo.Buffer` instance allocated with `memAlloc`.
public static VkSemaphoreTypeCreateInfo	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSemaphoreTypeCreateInfo` instance allocated on the specified `MemoryStack`.
public static VkSemaphoreTypeCreateInfo.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSemaphoreTypeCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
public static long	ninitialValue(long struct) Unsafe version of `initialValue`.
public static void	ninitialValue(long struct, long value) Unsafe version of `initialValue`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static int	nsemaphoreType(long struct) Unsafe version of `semaphoreType`.
public static void	nsemaphoreType(long struct, int value) Unsafe version of `semaphoreType`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkSemaphoreTypeCreateInfo	pNext(long value) Sets the specified value to the `pNext` field.
public int	semaphoreType() a `VkSemaphoreType` value specifying the type of the semaphore.
public VkSemaphoreTypeCreateInfo	semaphoreType(int value) Sets the specified value to the `semaphoreType` field.
public VkSemaphoreTypeCreateInfo	set(int sType, long pNext, int semaphoreType, long initialValue) Initializes this struct with the specified values.
public VkSemaphoreTypeCreateInfo	Returns: this struct set(VkSemaphoreTypeCreateInfo 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	sType() a `VkStructureType` value identifying this structure.
public VkSemaphoreTypeCreateInfo	sType(int value) Sets the specified value to the `sType` field.
public VkSemaphoreTypeCreateInfo	sType$Default() Sets the `STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO` value to the `sType` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

INITIALVALUE	back to summary
public static final int INITIALVALUE The struct member offsets.

PNEXT	back to summary
public static final int PNEXT The struct member offsets.

SEMAPHORETYPE	back to summary
public static final int SEMAPHORETYPE The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

STYPE	back to summary
public static final int STYPE The struct member offsets.

Constructor Detail

VkSemaphoreTypeCreateInfo	back to summary
protected VkSemaphoreTypeCreateInfo(long address, ByteBuffer container)

VkSemaphoreTypeCreateInfo back to summary

VkSemaphoreTypeCreateInfo	back to summary
public VkSemaphoreTypeCreateInfo(ByteBuffer container) Creates a `VkSemaphoreTypeCreateInfo` 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.

public VkSemaphoreTypeCreateInfo(ByteBuffer container)

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

calloc	back to summary
public static VkSemaphoreTypeCreateInfo calloc() Returns a new `VkSemaphoreTypeCreateInfo` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkSemaphoreTypeCreateInfo.Buffer calloc(int capacity) Returns a new `VkSemaphoreTypeCreateInfo.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkSemaphoreTypeCreateInfo.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkSemaphoreTypeCreateInfo calloc(MemoryStack stack) Returns a new `VkSemaphoreTypeCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkSemaphoreTypeCreateInfo calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkSemaphoreTypeCreateInfo.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkSemaphoreTypeCreateInfo.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

public static VkSemaphoreTypeCreateInfo.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkSemaphoreTypeCreateInfo.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

create back to summary

create	back to summary
protected VkSemaphoreTypeCreateInfo 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

protected VkSemaphoreTypeCreateInfo 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

create	back to summary
public static VkSemaphoreTypeCreateInfo create() Returns a new `VkSemaphoreTypeCreateInfo` instance allocated with `BufferUtils`.

create	back to summary
public static VkSemaphoreTypeCreateInfo create(long address) Returns a new `VkSemaphoreTypeCreateInfo` instance for the specified memory address.

create back to summary

create	back to summary
public static VkSemaphoreTypeCreateInfo.Buffer create(int capacity) Returns a new `VkSemaphoreTypeCreateInfo.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkSemaphoreTypeCreateInfo.Buffer create(int capacity)

Returns a new VkSemaphoreTypeCreateInfo.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkSemaphoreTypeCreateInfo.Buffer create(long address, int capacity) Create a `VkSemaphoreTypeCreateInfo.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static VkSemaphoreTypeCreateInfo.Buffer create(long address, int capacity)

Create a VkSemaphoreTypeCreateInfo.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkSemaphoreTypeCreateInfo createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkSemaphoreTypeCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkSemaphoreTypeCreateInfo.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

initialValue back to summary

initialValue	back to summary
public long initialValue() the initial payload value if `semaphoreType` is `SEMAPHORE_TYPE_TIMELINE`. Annotations @NativeType:uint64_t

public long initialValue()

the initial payload value if semaphoreType is SEMAPHORE_TYPE_TIMELINE.

Annotations

@NativeType:uint64_t

initialValue	back to summary
public VkSemaphoreTypeCreateInfo initialValue(long value) Sets the specified value to the `initialValue` field.

malloc	back to summary
public static VkSemaphoreTypeCreateInfo malloc() Returns a new `VkSemaphoreTypeCreateInfo` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkSemaphoreTypeCreateInfo.Buffer malloc(int capacity) Returns a new `VkSemaphoreTypeCreateInfo.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkSemaphoreTypeCreateInfo.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkSemaphoreTypeCreateInfo malloc(MemoryStack stack) Returns a new `VkSemaphoreTypeCreateInfo` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkSemaphoreTypeCreateInfo malloc(MemoryStack stack)

Returns a new VkSemaphoreTypeCreateInfo instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkSemaphoreTypeCreateInfo.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkSemaphoreTypeCreateInfo.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkSemaphoreTypeCreateInfo.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

ninitialValue	back to summary
public static long ninitialValue(long struct) Unsafe version of `initialValue`.

ninitialValue	back to summary
public static void ninitialValue(long struct, long value) Unsafe version of `initialValue`.

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

npNext	back to summary
public static void npNext(long struct, long value) Unsafe version of `pNext`.

nsemaphoreType	back to summary
public static int nsemaphoreType(long struct) Unsafe version of `semaphoreType`.

nsemaphoreType	back to summary
public static void nsemaphoreType(long struct, int value) Unsafe version of `semaphoreType`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

nsType	back to summary
public static void nsType(long struct, int value) Unsafe version of `sType`.

pNext back to summary

pNext	back to summary
public long pNext() `NULL` or a pointer to a structure extending this structure. Annotations @NativeType:void const *

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void const *

pNext	back to summary
public VkSemaphoreTypeCreateInfo pNext(long value) Sets the specified value to the `pNext` field.

semaphoreType back to summary

semaphoreType	back to summary
public int semaphoreType() a `VkSemaphoreType` value specifying the type of the semaphore. Annotations @NativeType:VkSemaphoreType

public int semaphoreType()

a VkSemaphoreType value specifying the type of the semaphore.

Annotations

@NativeType:VkSemaphoreType

semaphoreType	back to summary
public VkSemaphoreTypeCreateInfo semaphoreType(int value) Sets the specified value to the `semaphoreType` field.

set	back to summary
public VkSemaphoreTypeCreateInfo set(int sType, long pNext, int semaphoreType, long initialValue) Initializes this struct with the specified values.

set	back to summary
public VkSemaphoreTypeCreateInfo set(VkSemaphoreTypeCreateInfo src) Copies the specified struct data to this struct. Parameters src:VkSemaphoreTypeCreateInfo the source struct Returns:VkSemaphoreTypeCreateInfo this struct

set

back to summary

public VkSemaphoreTypeCreateInfo set(VkSemaphoreTypeCreateInfo src)

Copies the specified struct data to this struct.

Parameters

src:VkSemaphoreTypeCreateInfo: the source struct

Returns:VkSemaphoreTypeCreateInfo

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

sType back to summary

sType	back to summary
public int sType() a `VkStructureType` value identifying this structure. Annotations @NativeType:VkStructureType

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkSemaphoreTypeCreateInfo sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkSemaphoreTypeCreateInfo sType$Default() Sets the `STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO` value to the `sType` field.

org.lwjgl.vulkan back to summary

public Class VkSemaphoreTypeCreateInfo.Buffer

Class Inheritance

extends StructBuffer<VkSemaphoreTypeCreateInfo, VkSemaphoreTypeCreateInfo.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkSemaphoreTypeCreateInfo.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

Known Direct Subclasses

org.lwjgl.vulkan.VkSemaphoreTypeCreateInfoKHR.Buffer

An array of VkSemaphoreTypeCreateInfo structs.

Field Summary

Modifier and Type	Field and Description
private static final VkSemaphoreTypeCreateInfo	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkSemaphoreTypeCreateInfo.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 Type	Method and Description
protected VkSemaphoreTypeCreateInfo	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkSemaphoreTypeCreateInfo#initialValue` field. initialValue()
public VkSemaphoreTypeCreateInfo.Buffer	initialValue(long value) Sets the specified value to the `VkSemaphoreTypeCreateInfo#initialValue` field.
public long	Returns: the value of the `VkSemaphoreTypeCreateInfo#pNext` field. pNext()
public VkSemaphoreTypeCreateInfo.Buffer	pNext(long value) Sets the specified value to the `VkSemaphoreTypeCreateInfo#pNext` field.
protected VkSemaphoreTypeCreateInfo.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkSemaphoreTypeCreateInfo#semaphoreType` field. semaphoreType()
public VkSemaphoreTypeCreateInfo.Buffer	semaphoreType(int value) Sets the specified value to the `VkSemaphoreTypeCreateInfo#semaphoreType` field.
public int	Returns: the value of the `VkSemaphoreTypeCreateInfo#sType` field. sType()
public VkSemaphoreTypeCreateInfo.Buffer	sType(int value) Sets the specified value to the `VkSemaphoreTypeCreateInfo#sType` field.
public VkSemaphoreTypeCreateInfo.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO` value to the `VkSemaphoreTypeCreateInfo#sType` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkSemaphoreTypeCreateInfo ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

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

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

getElementFactory

back to summary

protected VkSemaphoreTypeCreateInfo getElementFactory()

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

Annotations

@Override

initialValue	back to summary
public long initialValue() Returns:long the value of the `VkSemaphoreTypeCreateInfo#initialValue` field. Annotations @NativeType:uint64_t

initialValue	back to summary
public VkSemaphoreTypeCreateInfo.Buffer initialValue(long value) Sets the specified value to the `VkSemaphoreTypeCreateInfo#initialValue` field.

pNext	back to summary
public long pNext() Returns:long the value of the `VkSemaphoreTypeCreateInfo#pNext` field. Annotations @NativeType:void const *

pNext	back to summary
public VkSemaphoreTypeCreateInfo.Buffer pNext(long value) Sets the specified value to the `VkSemaphoreTypeCreateInfo#pNext` field.

self

back to summary

protected VkSemaphoreTypeCreateInfo.Buffer self()

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

Annotations

@Override

semaphoreType	back to summary
public int semaphoreType() Returns:int the value of the `VkSemaphoreTypeCreateInfo#semaphoreType` field. Annotations @NativeType:VkSemaphoreType

semaphoreType	back to summary
public VkSemaphoreTypeCreateInfo.Buffer semaphoreType(int value) Sets the specified value to the `VkSemaphoreTypeCreateInfo#semaphoreType` field.

sType	back to summary
public int sType() Returns:int the value of the `VkSemaphoreTypeCreateInfo#sType` field. Annotations @NativeType:VkStructureType

sType	back to summary
public VkSemaphoreTypeCreateInfo.Buffer sType(int value) Sets the specified value to the `VkSemaphoreTypeCreateInfo#sType` field.

sType$Default	back to summary
public VkSemaphoreTypeCreateInfo.Buffer sType$Default() Sets the `STRUCTURE_TYPE_SEMAPHORE_TYPE_CREATE_INFO` value to the `VkSemaphoreTypeCreateInfo#sType` field.