Package org.lwjgl.vulkan

Class VkSamplerBorderColorComponentMappingCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSamplerBorderColorComponentMappingCreateInfoEXT>

org.lwjgl.vulkan.VkSamplerBorderColorComponentMappingCreateInfoEXT

All Implemented Interfaces:

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

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

Structure specifying the component mapping of the border color.

Description

The VkComponentMapping components member describes a remapping from components of the border color to components of the vector returned by shader image instructions when the border color is used.

Valid Usage

• The borderColorSwizzle feature must be enabled

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SAMPLER_BORDER_COLOR_COMPONENT_MAPPING_CREATE_INFO_EXT
• components must be a valid VkComponentMapping structure

See Also

VkComponentMapping

Layout

 struct VkSamplerBorderColorComponentMappingCreateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkComponentMapping components();
     VkBool32 srgb();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer	An array of VkSamplerBorderColorComponentMappingCreateInfoEXT 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	COMPONENTS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SRGB	The struct member offsets.
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
VkSamplerBorderColorComponentMappingCreateInfoEXT(ByteBuffer container)	Creates a VkSamplerBorderColorComponentMappingCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkSamplerBorderColorComponentMappingCreateInfoEXT	calloc()	Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance allocated with memCalloc.
static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSamplerBorderColorComponentMappingCreateInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
VkComponentMapping	components()	a VkComponentMapping structure specifying a remapping of the border color components.
VkSamplerBorderColorComponentMappingCreateInfoEXT	components(Consumer<VkComponentMapping> consumer)	Passes the components() field to the specified Consumer.
VkSamplerBorderColorComponentMappingCreateInfoEXT	components(VkComponentMapping value)	Copies the specified VkComponentMapping to the components() field.
static VkSamplerBorderColorComponentMappingCreateInfoEXT	create()	Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance allocated with BufferUtils.
static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkSamplerBorderColorComponentMappingCreateInfoEXT	create(long address)	Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance for the specified memory address.
static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance at the specified memory.
static @Nullable VkSamplerBorderColorComponentMappingCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSamplerBorderColorComponentMappingCreateInfoEXT	malloc()	Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance allocated with memAlloc.
static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkSamplerBorderColorComponentMappingCreateInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance allocated on the specified MemoryStack.
static VkComponentMapping	ncomponents(long struct)	Unsafe version of components().
static void	ncomponents(long struct, VkComponentMapping value)	Unsafe version of components.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsrgb(long struct)	Unsafe version of srgb().
static void	nsrgb(long struct, int value)	Unsafe version of srgb.
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.
VkSamplerBorderColorComponentMappingCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkSamplerBorderColorComponentMappingCreateInfoEXT	set(int sType, long pNext, VkComponentMapping components, boolean srgb)	Initializes this struct with the specified values.
VkSamplerBorderColorComponentMappingCreateInfoEXT	set(VkSamplerBorderColorComponentMappingCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
boolean	srgb()	indicates that the sampler will be combined with an image view that has an image format which is sRGB encoded.
VkSamplerBorderColorComponentMappingCreateInfoEXT	srgb(boolean value)	Sets the specified value to the srgb() field.
int	sType()	a VkStructureType value identifying this structure.
VkSamplerBorderColorComponentMappingCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkSamplerBorderColorComponentMappingCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_SAMPLER_BORDER_COLOR_COMPONENT_MAPPING_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.

COMPONENTS

public static final int COMPONENTS

The struct member offsets.

SRGB

public static final int SRGB

The struct member offsets.

Constructor Details

VkSamplerBorderColorComponentMappingCreateInfoEXT

public VkSamplerBorderColorComponentMappingCreateInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

components

public VkComponentMapping components()

a VkComponentMapping structure specifying a remapping of the border color components.

srgb

public boolean srgb()

indicates that the sampler will be combined with an image view that has an image format which is sRGB encoded.

sType

public VkSamplerBorderColorComponentMappingCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSamplerBorderColorComponentMappingCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_SAMPLER_BORDER_COLOR_COMPONENT_MAPPING_CREATE_INFO_EXT value to the sType() field.

pNext

public VkSamplerBorderColorComponentMappingCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

components

public VkSamplerBorderColorComponentMappingCreateInfoEXT components(VkComponentMapping value)

Copies the specified VkComponentMapping to the components() field.

components

public VkSamplerBorderColorComponentMappingCreateInfoEXT components(Consumer<VkComponentMapping> consumer)

Passes the components() field to the specified Consumer.

srgb

public VkSamplerBorderColorComponentMappingCreateInfoEXT srgb(boolean value)

Sets the specified value to the srgb() field.

set

public VkSamplerBorderColorComponentMappingCreateInfoEXT set(int sType,
 long pNext,
 VkComponentMapping components,
 boolean srgb)

Initializes this struct with the specified values.

set

public VkSamplerBorderColorComponentMappingCreateInfoEXT set(VkSamplerBorderColorComponentMappingCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSamplerBorderColorComponentMappingCreateInfoEXT malloc()

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

calloc

public static VkSamplerBorderColorComponentMappingCreateInfoEXT calloc()

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

create

public static VkSamplerBorderColorComponentMappingCreateInfoEXT create()

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance allocated with BufferUtils.

create

public static VkSamplerBorderColorComponentMappingCreateInfoEXT create(long address)

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkSamplerBorderColorComponentMappingCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer create(int capacity)

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncomponents

public static VkComponentMapping ncomponents(long struct)

Unsafe version of components().

nsrgb

public static int nsrgb(long struct)

Unsafe version of srgb().

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.

ncomponents

public static void ncomponents(long struct,
 VkComponentMapping value)

Unsafe version of components.

nsrgb

public static void nsrgb(long struct,
 int value)

Unsafe version of srgb.