Package org.lwjgl.vulkan

Class VkPhysicalDeviceCustomBorderColorFeaturesEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceCustomBorderColorFeaturesEXT>

org.lwjgl.vulkan.VkPhysicalDeviceCustomBorderColorFeaturesEXT

All Implemented Interfaces:

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

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

Structure describing whether custom border colors can be supported by an implementation.

Description

If the VkPhysicalDeviceCustomBorderColorFeaturesEXT 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. VkPhysicalDeviceCustomBorderColorFeaturesEXT 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_CUSTOM_BORDER_COLOR_FEATURES_EXT

Layout

 struct VkPhysicalDeviceCustomBorderColorFeaturesEXT {
     VkStructureType sType();
     void * pNext();
     VkBool32 customBorderColors();
     VkBool32 customBorderColorWithoutFormat();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceCustomBorderColorFeaturesEXT	calloc()	Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance allocated with memCalloc.
static VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceCustomBorderColorFeaturesEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceCustomBorderColorFeaturesEXT	create()	Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance allocated with BufferUtils.
static VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceCustomBorderColorFeaturesEXT	create(long address)	Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance for the specified memory address.
static VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceCustomBorderColorFeaturesEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	customBorderColors()	indicates that the implementation supports providing a borderColor value with one of the following values at sampler creation time: BORDER_COLOR_FLOAT_CUSTOM_EXT BORDER_COLOR_INT_CUSTOM_EXT
VkPhysicalDeviceCustomBorderColorFeaturesEXT	customBorderColors(boolean value)	Sets the specified value to the customBorderColors() field.
boolean	customBorderColorWithoutFormat()	indicates that explicit formats are not required for custom border colors and the value of the format member of the VkSamplerCustomBorderColorCreateInfoEXT structure may be FORMAT_UNDEFINED.
VkPhysicalDeviceCustomBorderColorFeaturesEXT	customBorderColorWithoutFormat(boolean value)	Sets the specified value to the customBorderColorWithoutFormat() field.
static VkPhysicalDeviceCustomBorderColorFeaturesEXT	malloc()	Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance allocated with memAlloc.
static VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceCustomBorderColorFeaturesEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance allocated on the specified MemoryStack.
static int	ncustomBorderColors(long struct)	Unsafe version of customBorderColors().
static void	ncustomBorderColors(long struct, int value)	Unsafe version of customBorderColors.
static int	ncustomBorderColorWithoutFormat(long struct)	Unsafe version of customBorderColorWithoutFormat().
static void	ncustomBorderColorWithoutFormat(long struct, int value)	Unsafe version of customBorderColorWithoutFormat.
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.
VkPhysicalDeviceCustomBorderColorFeaturesEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceCustomBorderColorFeaturesEXT	set(int sType, long pNext, boolean customBorderColors, boolean customBorderColorWithoutFormat)	Initializes this struct with the specified values.
VkPhysicalDeviceCustomBorderColorFeaturesEXT	set(VkPhysicalDeviceCustomBorderColorFeaturesEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceCustomBorderColorFeaturesEXT	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceCustomBorderColorFeaturesEXT	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_CUSTOM_BORDER_COLOR_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.

CUSTOMBORDERCOLORS

public static final int CUSTOMBORDERCOLORS

The struct member offsets.

CUSTOMBORDERCOLORWITHOUTFORMAT

public static final int CUSTOMBORDERCOLORWITHOUTFORMAT

The struct member offsets.

Constructor Details

VkPhysicalDeviceCustomBorderColorFeaturesEXT

public VkPhysicalDeviceCustomBorderColorFeaturesEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

customBorderColors

public boolean customBorderColors()

indicates that the implementation supports providing a borderColor value with one of the following values at sampler creation time:

• BORDER_COLOR_FLOAT_CUSTOM_EXT
• BORDER_COLOR_INT_CUSTOM_EXT

customBorderColorWithoutFormat

public boolean customBorderColorWithoutFormat()

indicates that explicit formats are not required for custom border colors and the value of the format member of the VkSamplerCustomBorderColorCreateInfoEXT structure may be FORMAT_UNDEFINED. If this feature bit is not set, applications must provide the VkFormat of the image view(s) being sampled by this sampler in the format member of the VkSamplerCustomBorderColorCreateInfoEXT structure.

sType

public VkPhysicalDeviceCustomBorderColorFeaturesEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceCustomBorderColorFeaturesEXT sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_CUSTOM_BORDER_COLOR_FEATURES_EXT value to the sType() field.

pNext

public VkPhysicalDeviceCustomBorderColorFeaturesEXT pNext(long value)

Sets the specified value to the pNext() field.

customBorderColors

public VkPhysicalDeviceCustomBorderColorFeaturesEXT customBorderColors(boolean value)

Sets the specified value to the customBorderColors() field.

customBorderColorWithoutFormat

public VkPhysicalDeviceCustomBorderColorFeaturesEXT customBorderColorWithoutFormat(boolean value)

Sets the specified value to the customBorderColorWithoutFormat() field.

set

public VkPhysicalDeviceCustomBorderColorFeaturesEXT set(int sType,
 long pNext,
 boolean customBorderColors,
 boolean customBorderColorWithoutFormat)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceCustomBorderColorFeaturesEXT set(VkPhysicalDeviceCustomBorderColorFeaturesEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceCustomBorderColorFeaturesEXT malloc()

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

calloc

public static VkPhysicalDeviceCustomBorderColorFeaturesEXT calloc()

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

create

public static VkPhysicalDeviceCustomBorderColorFeaturesEXT create()

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance allocated with BufferUtils.

create

public static VkPhysicalDeviceCustomBorderColorFeaturesEXT create(long address)

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceCustomBorderColorFeaturesEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer create(int capacity)

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncustomBorderColors

public static int ncustomBorderColors(long struct)

Unsafe version of customBorderColors().

ncustomBorderColorWithoutFormat

public static int ncustomBorderColorWithoutFormat(long struct)

Unsafe version of customBorderColorWithoutFormat().

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.

ncustomBorderColors

public static void ncustomBorderColors(long struct,
 int value)

Unsafe version of customBorderColors.

ncustomBorderColorWithoutFormat

public static void ncustomBorderColorWithoutFormat(long struct,
 int value)

Unsafe version of customBorderColorWithoutFormat.