Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSamplerBorderColorComponentMappingCreateInfoEXT

extends Struct<VkSamplerBorderColorComponentMappingCreateInfoEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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
Valid Usage (Implicit)
See Also

VkComponentMapping

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
COMPONENTS

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
SRGB

The struct member offsets.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkSamplerBorderColorComponentMappingCreateInfoEXT(ByteBuffer container)

Creates a VkSamplerBorderColorComponentMappingCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkSamplerBorderColorComponentMappingCreateInfoEXT
calloc()

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance allocated with memCalloc.

public static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance allocated with memCalloc.

public static VkSamplerBorderColorComponentMappingCreateInfoEXT
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public VkComponentMapping
components()

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

public VkSamplerBorderColorComponentMappingCreateInfoEXT
components(VkComponentMapping value)

Copies the specified VkComponentMapping to the components field.

public VkSamplerBorderColorComponentMappingCreateInfoEXT
components(Consumer<VkComponentMapping> consumer)

Passes the components field to the specified Consumer.

protected VkSamplerBorderColorComponentMappingCreateInfoEXT
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 VkSamplerBorderColorComponentMappingCreateInfoEXT
create()

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance allocated with BufferUtils.

public static VkSamplerBorderColorComponentMappingCreateInfoEXT
create(long address)

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance for the specified memory address.

public static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance at the specified memory.

public static VkSamplerBorderColorComponentMappingCreateInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkSamplerBorderColorComponentMappingCreateInfoEXT
malloc()

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance allocated with memAlloc.

public static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance allocated with memAlloc.

public static VkSamplerBorderColorComponentMappingCreateInfoEXT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance allocated on the specified MemoryStack.

public static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkComponentMapping
ncomponents(long struct)

Unsafe version of components.

public static void
ncomponents(long struct, VkComponentMapping value)

Unsafe version of components.

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
nsrgb(long struct)

Unsafe version of srgb.

public static void
nsrgb(long struct, int value)

Unsafe version of srgb.

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 VkSamplerBorderColorComponentMappingCreateInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkSamplerBorderColorComponentMappingCreateInfoEXT

Returns:

this struct
set
(VkSamplerBorderColorComponentMappingCreateInfoEXT
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 boolean
srgb()

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

public VkSamplerBorderColorComponentMappingCreateInfoEXT
srgb(boolean value)

Sets the specified value to the srgb field.

public int
sType()

a VkStructureType value identifying this structure.

public VkSamplerBorderColorComponentMappingCreateInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkSamplerBorderColorComponentMappingCreateInfoEXT
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

COMPONENTSback to summary
public static final int COMPONENTS

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SRGBback to summary
public static final int SRGB

The struct member offsets.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkSamplerBorderColorComponentMappingCreateInfoEXTback to summary
protected VkSamplerBorderColorComponentMappingCreateInfoEXT(long address, ByteBuffer container)
VkSamplerBorderColorComponentMappingCreateInfoEXTback to summary
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 Detail

callocback to summary
public static VkSamplerBorderColorComponentMappingCreateInfoEXT calloc()

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

callocback to summary
public static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSamplerBorderColorComponentMappingCreateInfoEXT calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

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

componentsback to summary
public VkComponentMapping components()

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

componentsback to summary
public VkSamplerBorderColorComponentMappingCreateInfoEXT components(VkComponentMapping value)

Copies the specified VkComponentMapping to the components field.

componentsback to summary
public VkSamplerBorderColorComponentMappingCreateInfoEXT components(Consumer<VkComponentMapping> consumer)

Passes the components field to the specified Consumer.

createback to summary
protected VkSamplerBorderColorComponentMappingCreateInfoEXT 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
createback to summary
public static VkSamplerBorderColorComponentMappingCreateInfoEXT create()

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkSamplerBorderColorComponentMappingCreateInfoEXT create(long address)

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance for the specified memory address.

createback to summary
public static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer create(int capacity)

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSamplerBorderColorComponentMappingCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkSamplerBorderColorComponentMappingCreateInfoEXT malloc()

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

mallocback to summary
public static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSamplerBorderColorComponentMappingCreateInfoEXT malloc(MemoryStack stack)

Returns a new VkSamplerBorderColorComponentMappingCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncomponentsback to summary
public static VkComponentMapping ncomponents(long struct)

Unsafe version of components.

ncomponentsback to summary
public static void ncomponents(long struct, VkComponentMapping value)

Unsafe version of components.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsrgbback to summary
public static int nsrgb(long struct)

Unsafe version of srgb.

nsrgbback to summary
public static void nsrgb(long struct, int value)

Unsafe version of srgb.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkSamplerBorderColorComponentMappingCreateInfoEXT pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkSamplerBorderColorComponentMappingCreateInfoEXT set(VkSamplerBorderColorComponentMappingCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkSamplerBorderColorComponentMappingCreateInfoEXT

the source struct

Returns:VkSamplerBorderColorComponentMappingCreateInfoEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
srgbback to summary
public boolean srgb()

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

Annotations
@NativeType:VkBool32
srgbback to summary
public VkSamplerBorderColorComponentMappingCreateInfoEXT srgb(boolean value)

Sets the specified value to the srgb field.

sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkSamplerBorderColorComponentMappingCreateInfoEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkSamplerBorderColorComponentMappingCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_SAMPLER_BORDER_COLOR_COMPONENT_MAPPING_CREATE_INFO_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer

extends StructBuffer<VkSamplerBorderColorComponentMappingCreateInfoEXT, VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkSamplerBorderColorComponentMappingCreateInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkSamplerBorderColorComponentMappingCreateInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public VkComponentMapping
public VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer
public VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer
protected VkSamplerBorderColorComponentMappingCreateInfoEXT
public long
public VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkSamplerBorderColorComponentMappingCreateInfoEXT#pNext field.

protected VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer
public boolean
public VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer
srgb(boolean value)

Sets the specified value to the VkSamplerBorderColorComponentMappingCreateInfoEXT#srgb field.

public int
public VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkSamplerBorderColorComponentMappingCreateInfoEXT#sType field.

public VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSamplerBorderColorComponentMappingCreateInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkSamplerBorderColorComponentMappingCreateInfoEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

componentsback to summary
public VkComponentMapping components()
Returns:VkComponentMapping

a VkComponentMapping view of the VkSamplerBorderColorComponentMappingCreateInfoEXT#components field.

componentsback to summary
public VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer components(VkComponentMapping value)

Copies the specified VkComponentMapping to the VkSamplerBorderColorComponentMappingCreateInfoEXT#components field.

componentsback to summary
public VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer components(Consumer<VkComponentMapping> consumer)

Passes the VkSamplerBorderColorComponentMappingCreateInfoEXT#components field to the specified Consumer.

getElementFactoryback to summary
protected VkSamplerBorderColorComponentMappingCreateInfoEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkSamplerBorderColorComponentMappingCreateInfoEXT#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer pNext(long value)

Sets the specified value to the VkSamplerBorderColorComponentMappingCreateInfoEXT#pNext field.

selfback to summary
protected VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
srgbback to summary
public boolean srgb()
Returns:boolean

the value of the VkSamplerBorderColorComponentMappingCreateInfoEXT#srgb field.

Annotations
@NativeType:VkBool32
srgbback to summary
public VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer srgb(boolean value)

Sets the specified value to the VkSamplerBorderColorComponentMappingCreateInfoEXT#srgb field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkSamplerBorderColorComponentMappingCreateInfoEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer sType(int value)

Sets the specified value to the VkSamplerBorderColorComponentMappingCreateInfoEXT#sType field.

sType$Defaultback to summary
public VkSamplerBorderColorComponentMappingCreateInfoEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_SAMPLER_BORDER_COLOR_COMPONENT_MAPPING_CREATE_INFO_EXT value to the VkSamplerBorderColorComponentMappingCreateInfoEXT#sType field.