Package org.lwjgl.vulkan

Class VkSamplerCustomBorderColorCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSamplerCustomBorderColorCreateInfoEXT>

org.lwjgl.vulkan.VkSamplerCustomBorderColorCreateInfoEXT

All Implemented Interfaces:

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

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

Structure specifying custom border color.

Description

Note

If format is a depth/stencil format, the aspect is determined by the value of VkSamplerCreateInfo::borderColor. If VkSamplerCreateInfo::borderColor is BORDER_COLOR_FLOAT_CUSTOM_EXT, the depth aspect is considered. If VkSamplerCreateInfo::borderColor is BORDER_COLOR_INT_CUSTOM_EXT, the stencil aspect is considered.

If format is FORMAT_UNDEFINED, the VkSamplerCreateInfo::borderColor is BORDER_COLOR_INT_CUSTOM_EXT, and the sampler is used with an image with a stencil format, then the implementation must source the custom border color from either the first or second components of VkSamplerCreateInfo::customBorderColor and should source it from the first component.

Valid Usage

• If format is not FORMAT_UNDEFINED and format is not a depth/stencil format then the VkSamplerCreateInfo::borderColor type must match the sampled type of the provided format, as shown in the SPIR-V Type column of the Interpretation of Numeric Format table
• If the customBorderColorWithoutFormat feature is not enabled then format must not be FORMAT_UNDEFINED
• If the sampler is used to sample an image view of FORMAT_B4G4R4A4_UNORM_PACK16, FORMAT_B5G6R5_UNORM_PACK16, FORMAT_A1B5G5R5_UNORM_PACK16, or FORMAT_B5G5R5A1_UNORM_PACK16 format then format must not be FORMAT_UNDEFINED

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SAMPLER_CUSTOM_BORDER_COLOR_CREATE_INFO_EXT
• format must be a valid VkFormat value

See Also

VkClearColorValue

Layout

 struct VkSamplerCustomBorderColorCreateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkClearColorValue customBorderColor();
     VkFormat format();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkSamplerCustomBorderColorCreateInfoEXT	calloc()	Returns a new VkSamplerCustomBorderColorCreateInfoEXT instance allocated with memCalloc.
static VkSamplerCustomBorderColorCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkSamplerCustomBorderColorCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkSamplerCustomBorderColorCreateInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSamplerCustomBorderColorCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSamplerCustomBorderColorCreateInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSamplerCustomBorderColorCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSamplerCustomBorderColorCreateInfoEXT	create()	Returns a new VkSamplerCustomBorderColorCreateInfoEXT instance allocated with BufferUtils.
static VkSamplerCustomBorderColorCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkSamplerCustomBorderColorCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkSamplerCustomBorderColorCreateInfoEXT	create(long address)	Returns a new VkSamplerCustomBorderColorCreateInfoEXT instance for the specified memory address.
static VkSamplerCustomBorderColorCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkSamplerCustomBorderColorCreateInfoEXT.Buffer instance at the specified memory.
static @Nullable VkSamplerCustomBorderColorCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSamplerCustomBorderColorCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkClearColorValue	customBorderColor()	a VkClearColorValue representing the desired custom sampler border color.
VkSamplerCustomBorderColorCreateInfoEXT	customBorderColor(Consumer<VkClearColorValue> consumer)	Passes the customBorderColor() field to the specified Consumer.
VkSamplerCustomBorderColorCreateInfoEXT	customBorderColor(VkClearColorValue value)	Copies the specified VkClearColorValue to the customBorderColor() field.
int	format()	a VkFormat representing the format of the sampled image view(s).
VkSamplerCustomBorderColorCreateInfoEXT	format(int value)	Sets the specified value to the format() field.
static VkSamplerCustomBorderColorCreateInfoEXT	malloc()	Returns a new VkSamplerCustomBorderColorCreateInfoEXT instance allocated with memAlloc.
static VkSamplerCustomBorderColorCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkSamplerCustomBorderColorCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkSamplerCustomBorderColorCreateInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSamplerCustomBorderColorCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkSamplerCustomBorderColorCreateInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSamplerCustomBorderColorCreateInfoEXT instance allocated on the specified MemoryStack.
static VkClearColorValue	ncustomBorderColor(long struct)	Unsafe version of customBorderColor().
static void	ncustomBorderColor(long struct, VkClearColorValue value)	Unsafe version of customBorderColor.
static int	nformat(long struct)	Unsafe version of format().
static void	nformat(long struct, int value)	Unsafe version of format.
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.
VkSamplerCustomBorderColorCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkSamplerCustomBorderColorCreateInfoEXT	set(int sType, long pNext, VkClearColorValue customBorderColor, int format)	Initializes this struct with the specified values.
VkSamplerCustomBorderColorCreateInfoEXT	set(VkSamplerCustomBorderColorCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkSamplerCustomBorderColorCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkSamplerCustomBorderColorCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_SAMPLER_CUSTOM_BORDER_COLOR_CREATE_INFO_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.

CUSTOMBORDERCOLOR

public static final int CUSTOMBORDERCOLOR

The struct member offsets.

FORMAT

public static final int FORMAT

The struct member offsets.

Constructor Details

VkSamplerCustomBorderColorCreateInfoEXT

public VkSamplerCustomBorderColorCreateInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

customBorderColor

public VkClearColorValue customBorderColor()

a VkClearColorValue representing the desired custom sampler border color.

format

public int format()

a VkFormat representing the format of the sampled image view(s). This field may be FORMAT_UNDEFINED if the customBorderColorWithoutFormat feature is enabled.

sType

public VkSamplerCustomBorderColorCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSamplerCustomBorderColorCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_SAMPLER_CUSTOM_BORDER_COLOR_CREATE_INFO_EXT value to the sType() field.

pNext

public VkSamplerCustomBorderColorCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

customBorderColor

public VkSamplerCustomBorderColorCreateInfoEXT customBorderColor(VkClearColorValue value)

Copies the specified VkClearColorValue to the customBorderColor() field.

customBorderColor

public VkSamplerCustomBorderColorCreateInfoEXT customBorderColor(Consumer<VkClearColorValue> consumer)

Passes the customBorderColor() field to the specified Consumer.

format

public VkSamplerCustomBorderColorCreateInfoEXT format(int value)

Sets the specified value to the format() field.

set

public VkSamplerCustomBorderColorCreateInfoEXT set(int sType,
 long pNext,
 VkClearColorValue customBorderColor,
 int format)

Initializes this struct with the specified values.

set

public VkSamplerCustomBorderColorCreateInfoEXT set(VkSamplerCustomBorderColorCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSamplerCustomBorderColorCreateInfoEXT malloc()

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

calloc

public static VkSamplerCustomBorderColorCreateInfoEXT calloc()

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

create

public static VkSamplerCustomBorderColorCreateInfoEXT create()

Returns a new VkSamplerCustomBorderColorCreateInfoEXT instance allocated with BufferUtils.

create

public static VkSamplerCustomBorderColorCreateInfoEXT create(long address)

Returns a new VkSamplerCustomBorderColorCreateInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkSamplerCustomBorderColorCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSamplerCustomBorderColorCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSamplerCustomBorderColorCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSamplerCustomBorderColorCreateInfoEXT.Buffer create(int capacity)

Returns a new VkSamplerCustomBorderColorCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSamplerCustomBorderColorCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkSamplerCustomBorderColorCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncustomBorderColor

public static VkClearColorValue ncustomBorderColor(long struct)

Unsafe version of customBorderColor().

nformat

public static int nformat(long struct)

Unsafe version of format().

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.

ncustomBorderColor

public static void ncustomBorderColor(long struct,
 VkClearColorValue value)

Unsafe version of customBorderColor.

nformat

public static void nformat(long struct,
 int value)

Unsafe version of format.