Package org.lwjgl.vulkan

Class VkPhysicalDeviceShaderTerminateInvocationFeatures

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceShaderTerminateInvocationFeatures>

org.lwjgl.vulkan.VkPhysicalDeviceShaderTerminateInvocationFeatures

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkPhysicalDeviceShaderTerminateInvocationFeaturesKHR

public class VkPhysicalDeviceShaderTerminateInvocationFeatures
extends org.lwjgl.system.Struct<VkPhysicalDeviceShaderTerminateInvocationFeatures>
implements org.lwjgl.system.NativeResource

Structure describing support for the SPIR-V SPV_KHR_terminate_invocation extension.

Description

If the VkPhysicalDeviceShaderTerminateInvocationFeatures structure is included in the pNext chain of the VkPhysicalDeviceFeatures2 structure passed to GetPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. VkPhysicalDeviceShaderTerminateInvocationFeatures can also be used in the pNext chain of VkDeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_TERMINATE_INVOCATION_FEATURES

Layout

 struct VkPhysicalDeviceShaderTerminateInvocationFeatures {
     VkStructureType sType();
     void * pNext();
     VkBool32 shaderTerminateInvocation();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer	An array of VkPhysicalDeviceShaderTerminateInvocationFeatures structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

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

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkPhysicalDeviceShaderTerminateInvocationFeatures(ByteBuffer container)	Creates a VkPhysicalDeviceShaderTerminateInvocationFeatures instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceShaderTerminateInvocationFeatures	calloc()	Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance allocated with memCalloc.
static VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceShaderTerminateInvocationFeatures	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceShaderTerminateInvocationFeatures	create()	Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance allocated with BufferUtils.
static VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceShaderTerminateInvocationFeatures	create(long address)	Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance for the specified memory address.
static VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceShaderTerminateInvocationFeatures	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceShaderTerminateInvocationFeatures	malloc()	Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance allocated with memAlloc.
static VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceShaderTerminateInvocationFeatures	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nshaderTerminateInvocation(long struct)	Unsafe version of shaderTerminateInvocation().
static void	nshaderTerminateInvocation(long struct, int value)	Unsafe version of shaderTerminateInvocation.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPhysicalDeviceShaderTerminateInvocationFeatures	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceShaderTerminateInvocationFeatures	set(int sType, long pNext, boolean shaderTerminateInvocation)	Initializes this struct with the specified values.
VkPhysicalDeviceShaderTerminateInvocationFeatures	set(VkPhysicalDeviceShaderTerminateInvocationFeatures src)	Copies the specified struct data to this struct.
boolean	shaderTerminateInvocation()	specifies whether the implementation supports SPIR-V modules that use the SPV_KHR_terminate_invocation extension.
VkPhysicalDeviceShaderTerminateInvocationFeatures	shaderTerminateInvocation(boolean value)	Sets the specified value to the shaderTerminateInvocation() field.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceShaderTerminateInvocationFeatures	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceShaderTerminateInvocationFeatures	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_TERMINATE_INVOCATION_FEATURES value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

SHADERTERMINATEINVOCATION

public static final int SHADERTERMINATEINVOCATION

The struct member offsets.

Constructor Details

VkPhysicalDeviceShaderTerminateInvocationFeatures

public VkPhysicalDeviceShaderTerminateInvocationFeatures(ByteBuffer container)

Creates a VkPhysicalDeviceShaderTerminateInvocationFeatures 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkPhysicalDeviceShaderTerminateInvocationFeatures>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

shaderTerminateInvocation

public boolean shaderTerminateInvocation()

specifies whether the implementation supports SPIR-V modules that use the SPV_KHR_terminate_invocation extension.

sType

public VkPhysicalDeviceShaderTerminateInvocationFeatures sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceShaderTerminateInvocationFeatures sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_TERMINATE_INVOCATION_FEATURES value to the sType() field.

pNext

public VkPhysicalDeviceShaderTerminateInvocationFeatures pNext(long value)

Sets the specified value to the pNext() field.

shaderTerminateInvocation

public VkPhysicalDeviceShaderTerminateInvocationFeatures shaderTerminateInvocation(boolean value)

Sets the specified value to the shaderTerminateInvocation() field.

set

public VkPhysicalDeviceShaderTerminateInvocationFeatures set(int sType,
 long pNext,
 boolean shaderTerminateInvocation)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceShaderTerminateInvocationFeatures set(VkPhysicalDeviceShaderTerminateInvocationFeatures src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceShaderTerminateInvocationFeatures malloc()

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

calloc

public static VkPhysicalDeviceShaderTerminateInvocationFeatures calloc()

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

create

public static VkPhysicalDeviceShaderTerminateInvocationFeatures create()

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance allocated with BufferUtils.

create

public static VkPhysicalDeviceShaderTerminateInvocationFeatures create(long address)

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceShaderTerminateInvocationFeatures createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer create(int capacity)

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceShaderTerminateInvocationFeatures malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceShaderTerminateInvocationFeatures calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nshaderTerminateInvocation

public static int nshaderTerminateInvocation(long struct)

Unsafe version of shaderTerminateInvocation().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nshaderTerminateInvocation

public static void nshaderTerminateInvocation(long struct,
 int value)

Unsafe version of shaderTerminateInvocation.