Package org.lwjgl.vulkan

Class VkPhysicalDeviceBorderColorSwizzleFeaturesEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceBorderColorSwizzleFeaturesEXT>

org.lwjgl.vulkan.VkPhysicalDeviceBorderColorSwizzleFeaturesEXT

All Implemented Interfaces:

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

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

Structure describing whether samplers with custom border colors require the component swizzle specified in order to have defined behavior.

Description

If the VkPhysicalDeviceBorderColorSwizzleFeaturesEXT 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. VkPhysicalDeviceBorderColorSwizzleFeaturesEXT 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_BORDER_COLOR_SWIZZLE_FEATURES_EXT

Layout

 struct VkPhysicalDeviceBorderColorSwizzleFeaturesEXT {
     VkStructureType sType();
     void * pNext();
     VkBool32 borderColorSwizzle();
     VkBool32 borderColorSwizzleFromImage();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer	An array of VkPhysicalDeviceBorderColorSwizzleFeaturesEXT 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	BORDERCOLORSWIZZLE	The struct member offsets.
static final int	BORDERCOLORSWIZZLEFROMIMAGE	The struct member offsets.
static final int	PNEXT	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
VkPhysicalDeviceBorderColorSwizzleFeaturesEXT(ByteBuffer container)	Creates a VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
boolean	borderColorSwizzle()	indicates that defined values are returned by sampled image operations when used with a sampler that uses a BORDER_COLOR_FLOAT_OPAQUE_BLACK, BORDER_COLOR_INT_OPAQUE_BLACK, BORDER_COLOR_FLOAT_CUSTOM_EXT, or BORDER_COLOR_INT_CUSTOM_EXT borderColor and an image view that uses a non-identity component mapping, when either borderColorSwizzleFromImage is enabled or the VkSamplerBorderColorComponentMappingCreateInfoEXT is specified.
VkPhysicalDeviceBorderColorSwizzleFeaturesEXT	borderColorSwizzle(boolean value)	Sets the specified value to the borderColorSwizzle() field.
boolean	borderColorSwizzleFromImage()	indicates that the implementation will return the correct border color values from sampled image operations under the conditions expressed above, without the application having to specify the border color component mapping when creating the sampler object.
VkPhysicalDeviceBorderColorSwizzleFeaturesEXT	borderColorSwizzleFromImage(boolean value)	Sets the specified value to the borderColorSwizzleFromImage() field.
static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT	calloc()	Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance allocated with memCalloc.
static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT	create()	Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance allocated with BufferUtils.
static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT	create(long address)	Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance for the specified memory address.
static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceBorderColorSwizzleFeaturesEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT	malloc()	Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance allocated with memAlloc.
static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance allocated on the specified MemoryStack.
static int	nborderColorSwizzle(long struct)	Unsafe version of borderColorSwizzle().
static void	nborderColorSwizzle(long struct, int value)	Unsafe version of borderColorSwizzle.
static int	nborderColorSwizzleFromImage(long struct)	Unsafe version of borderColorSwizzleFromImage().
static void	nborderColorSwizzleFromImage(long struct, int value)	Unsafe version of borderColorSwizzleFromImage.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
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.
VkPhysicalDeviceBorderColorSwizzleFeaturesEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceBorderColorSwizzleFeaturesEXT	set(int sType, long pNext, boolean borderColorSwizzle, boolean borderColorSwizzleFromImage)	Initializes this struct with the specified values.
VkPhysicalDeviceBorderColorSwizzleFeaturesEXT	set(VkPhysicalDeviceBorderColorSwizzleFeaturesEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceBorderColorSwizzleFeaturesEXT	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceBorderColorSwizzleFeaturesEXT	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_BORDER_COLOR_SWIZZLE_FEATURES_EXT 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.

BORDERCOLORSWIZZLE

public static final int BORDERCOLORSWIZZLE

The struct member offsets.

BORDERCOLORSWIZZLEFROMIMAGE

public static final int BORDERCOLORSWIZZLEFROMIMAGE

The struct member offsets.

Constructor Details

VkPhysicalDeviceBorderColorSwizzleFeaturesEXT

public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

borderColorSwizzle

public boolean borderColorSwizzle()

indicates that defined values are returned by sampled image operations when used with a sampler that uses a BORDER_COLOR_FLOAT_OPAQUE_BLACK, BORDER_COLOR_INT_OPAQUE_BLACK, BORDER_COLOR_FLOAT_CUSTOM_EXT, or BORDER_COLOR_INT_CUSTOM_EXT borderColor and an image view that uses a non-identity component mapping, when either borderColorSwizzleFromImage is enabled or the VkSamplerBorderColorComponentMappingCreateInfoEXT is specified.

borderColorSwizzleFromImage

public boolean borderColorSwizzleFromImage()

indicates that the implementation will return the correct border color values from sampled image operations under the conditions expressed above, without the application having to specify the border color component mapping when creating the sampler object. If this feature bit is not set, applications can chain a VkSamplerBorderColorComponentMappingCreateInfoEXT structure when creating samplers for use with image views that do not have an identity swizzle and, when those samplers are combined with image views using the same component mapping, sampled image operations that use opaque black or custom border colors will return the correct border color values.

sType

public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_BORDER_COLOR_SWIZZLE_FEATURES_EXT value to the sType() field.

pNext

public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT pNext(long value)

Sets the specified value to the pNext() field.

borderColorSwizzle

public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT borderColorSwizzle(boolean value)

Sets the specified value to the borderColorSwizzle() field.

borderColorSwizzleFromImage

public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT borderColorSwizzleFromImage(boolean value)

Sets the specified value to the borderColorSwizzleFromImage() field.

set

public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT set(int sType,
 long pNext,
 boolean borderColorSwizzle,
 boolean borderColorSwizzleFromImage)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT set(VkPhysicalDeviceBorderColorSwizzleFeaturesEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT malloc()

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

calloc

public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT calloc()

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

create

public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT create()

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance allocated with BufferUtils.

create

public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT create(long address)

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceBorderColorSwizzleFeaturesEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer create(int capacity)

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.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().

nborderColorSwizzle

public static int nborderColorSwizzle(long struct)

Unsafe version of borderColorSwizzle().

nborderColorSwizzleFromImage

public static int nborderColorSwizzleFromImage(long struct)

Unsafe version of borderColorSwizzleFromImage().

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.

nborderColorSwizzle

public static void nborderColorSwizzle(long struct,
 int value)

Unsafe version of borderColorSwizzle.

nborderColorSwizzleFromImage

public static void nborderColorSwizzleFromImage(long struct,
 int value)

Unsafe version of borderColorSwizzleFromImage.