LWJGL 3.3.3 · org.lwjgl.vulkan.VkSamplerCustomBorderColorCreateInfoEXT

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_KHR, 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

Layout


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

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	CUSTOMBORDERCOLOR The struct member offsets.
public static final int	FORMAT The struct member offsets.
public static final int	PNEXT 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	VkSamplerCustomBorderColorCreateInfoEXT(long address, ByteBuffer container)
public	VkSamplerCustomBorderColorCreateInfoEXT(ByteBuffer container) Creates a `VkSamplerCustomBorderColorCreateInfoEXT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

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

Field Detail

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

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

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

PNEXT	back to summary
public static final int PNEXT 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

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

VkSamplerCustomBorderColorCreateInfoEXT back to summary

VkSamplerCustomBorderColorCreateInfoEXT	back to summary
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.

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 Detail

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

calloc back to summary

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

public static VkSamplerCustomBorderColorCreateInfoEXT.Buffer calloc(int capacity)

Returns a new VkSamplerCustomBorderColorCreateInfoEXT.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 VkSamplerCustomBorderColorCreateInfoEXT calloc(MemoryStack stack) Returns a new `VkSamplerCustomBorderColorCreateInfoEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkSamplerCustomBorderColorCreateInfoEXT calloc(MemoryStack stack)

Returns a new VkSamplerCustomBorderColorCreateInfoEXT 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 VkSamplerCustomBorderColorCreateInfoEXT.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkSamplerCustomBorderColorCreateInfoEXT.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 VkSamplerCustomBorderColorCreateInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkSamplerCustomBorderColorCreateInfoEXT.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 VkSamplerCustomBorderColorCreateInfoEXT 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 VkSamplerCustomBorderColorCreateInfoEXT 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 VkSamplerCustomBorderColorCreateInfoEXT create() Returns a new `VkSamplerCustomBorderColorCreateInfoEXT` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VkSamplerCustomBorderColorCreateInfoEXT.Buffer create(int capacity)

Returns a new VkSamplerCustomBorderColorCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a VkSamplerCustomBorderColorCreateInfoEXT.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 VkSamplerCustomBorderColorCreateInfoEXT createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkSamplerCustomBorderColorCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

customBorderColor	back to summary
public VkClearColorValue customBorderColor() a `VkClearColorValue` representing the desired custom sampler border color.

customBorderColor	back to summary
public VkSamplerCustomBorderColorCreateInfoEXT customBorderColor(VkClearColorValue value) Copies the specified `VkClearColorValue` to the `customBorderColor` field.

customBorderColor	back to summary
public VkSamplerCustomBorderColorCreateInfoEXT customBorderColor(Consumer<VkClearColorValue> consumer) Passes the `customBorderColor` field to the specified `Consumer`.

format back to summary

format	back to summary
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. Annotations @NativeType:VkFormat

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.

Annotations

@NativeType:VkFormat

format	back to summary
public VkSamplerCustomBorderColorCreateInfoEXT format(int value) Sets the specified value to the `format` field.

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

malloc back to summary

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

public static VkSamplerCustomBorderColorCreateInfoEXT.Buffer malloc(int capacity)

Returns a new VkSamplerCustomBorderColorCreateInfoEXT.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 VkSamplerCustomBorderColorCreateInfoEXT malloc(MemoryStack stack) Returns a new `VkSamplerCustomBorderColorCreateInfoEXT` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkSamplerCustomBorderColorCreateInfoEXT malloc(MemoryStack stack)

Returns a new VkSamplerCustomBorderColorCreateInfoEXT 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 VkSamplerCustomBorderColorCreateInfoEXT.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkSamplerCustomBorderColorCreateInfoEXT.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

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

ncustomBorderColor	back to summary
public static VkClearColorValue ncustomBorderColor(long struct) Unsafe version of `customBorderColor`.

ncustomBorderColor	back to summary
public static void ncustomBorderColor(long struct, VkClearColorValue value) Unsafe version of `customBorderColor`.

nformat	back to summary
public static int nformat(long struct) Unsafe version of `format`.

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

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`.

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 VkSamplerCustomBorderColorCreateInfoEXT pNext(long value) Sets the specified value to the `pNext` field.

set	back to summary
public VkSamplerCustomBorderColorCreateInfoEXT set(int sType, long pNext, VkClearColorValue customBorderColor, int format) Initializes this struct with the specified values.

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

set

back to summary

public VkSamplerCustomBorderColorCreateInfoEXT set(VkSamplerCustomBorderColorCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters

src:VkSamplerCustomBorderColorCreateInfoEXT: the source struct

Returns:VkSamplerCustomBorderColorCreateInfoEXT

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 VkSamplerCustomBorderColorCreateInfoEXT sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkSamplerCustomBorderColorCreateInfoEXT sType$Default() Sets the `STRUCTURE_TYPE_SAMPLER_CUSTOM_BORDER_COLOR_CREATE_INFO_EXT` value to the `sType` field.

Modifier and Type	Method and Description
public VkClearColorValue	Returns: a `VkClearColorValue` view of the `VkSamplerCustomBorderColorCreateInfoEXT#customBorderColor` field. customBorderColor()
public VkSamplerCustomBorderColorCreateInfoEXT.Buffer	customBorderColor(VkClearColorValue value) Copies the specified `VkClearColorValue` to the `VkSamplerCustomBorderColorCreateInfoEXT#customBorderColor` field.
public VkSamplerCustomBorderColorCreateInfoEXT.Buffer	customBorderColor(Consumer<VkClearColorValue> consumer) Passes the `VkSamplerCustomBorderColorCreateInfoEXT#customBorderColor` field to the specified `Consumer`.
public int	Returns: the value of the `VkSamplerCustomBorderColorCreateInfoEXT#format` field. format()
public VkSamplerCustomBorderColorCreateInfoEXT.Buffer	format(int value) Sets the specified value to the `VkSamplerCustomBorderColorCreateInfoEXT#format` field.
protected VkSamplerCustomBorderColorCreateInfoEXT	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkSamplerCustomBorderColorCreateInfoEXT#pNext` field. pNext()
public VkSamplerCustomBorderColorCreateInfoEXT.Buffer	pNext(long value) Sets the specified value to the `VkSamplerCustomBorderColorCreateInfoEXT#pNext` field.
protected VkSamplerCustomBorderColorCreateInfoEXT.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkSamplerCustomBorderColorCreateInfoEXT#sType` field. sType()
public VkSamplerCustomBorderColorCreateInfoEXT.Buffer	sType(int value) Sets the specified value to the `VkSamplerCustomBorderColorCreateInfoEXT#sType` field.
public VkSamplerCustomBorderColorCreateInfoEXT.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_SAMPLER_CUSTOM_BORDER_COLOR_CREATE_INFO_EXT` value to the `VkSamplerCustomBorderColorCreateInfoEXT#sType` field.

public Class VkSamplerCustomBorderColorCreateInfoEXT

Description

Note

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkSamplerCustomBorderColorCreateInfoEXT.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkSamplerCustomBorderColorCreateInfoEXT.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)