Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceBorderColorSwizzleFeaturesEXT

extends Struct<VkPhysicalDeviceBorderColorSwizzleFeaturesEXT>
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 describing whether samplers with custom border colors require the component swizzle specified in order to have defined behavior.
Description

If the VkPhysicalDeviceBorderColorSwizzleFeaturesEXT 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. VkPhysicalDeviceBorderColorSwizzleFeaturesEXT can also be used in the pNext chain of VkDeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

Layout


struct VkPhysicalDeviceBorderColorSwizzleFeaturesEXT {
    VkStructureType sType;
    void * pNext;
    VkBool32 borderColorSwizzle;
    VkBool32 borderColorSwizzleFromImage;
}

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
BORDERCOLORSWIZZLE

The struct member offsets.

public static final int
BORDERCOLORSWIZZLEFROMIMAGE

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:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkPhysicalDeviceBorderColorSwizzleFeaturesEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public boolean
borderColorSwizzle()

indicates that defined values are returned by sampled image operations when used with a sampler that uses a BORDER_COLOR_FLOAT_OPAQUE_BLACK, BORDER_COLOR_INT_OPAQUE_BLACK, BORDER_COLOR_FLOAT_CUSTOM_EXT, or BORDER_COLOR_INT_CUSTOM_EXT borderColor and an image view that uses a non-identity component mapping, when either borderColorSwizzleFromImage is enabled or the VkSamplerBorderColorComponentMappingCreateInfoEXT is specified.

public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT
borderColorSwizzle(boolean value)

Sets the specified value to the borderColorSwizzle field.

public boolean
borderColorSwizzleFromImage()

indicates that the implementation will return the correct border color values from sampled image operations under the conditions expressed above, without the application having to specify the border color component mapping when creating the sampler object.

public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT
borderColorSwizzleFromImage(boolean value)

Sets the specified value to the borderColorSwizzleFromImage field.

public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT
calloc()

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance allocated with memCalloc.

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

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance allocated with BufferUtils.

public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT
create(long address)

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance for the specified memory address.

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

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer instance allocated with BufferUtils.

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

Create a VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer instance at the specified memory.

public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT
malloc()

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance allocated on the specified MemoryStack.

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

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

public static int
nborderColorSwizzle(long struct)

Unsafe version of borderColorSwizzle.

public static void
nborderColorSwizzle(long struct, int value)

Unsafe version of borderColorSwizzle.

public static int
public static void
nborderColorSwizzleFromImage(long struct, int value)

Unsafe version of borderColorSwizzleFromImage.

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

Sets the specified value to the pNext field.

public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT
set(int sType, long pNext, boolean borderColorSwizzle, boolean borderColorSwizzleFromImage)

Initializes this struct with the specified values.

public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT

Returns:

this struct
set
(VkPhysicalDeviceBorderColorSwizzleFeaturesEXT
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 VkPhysicalDeviceBorderColorSwizzleFeaturesEXT
sType(int value)

Sets the specified value to the sType field.

public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT
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.

BORDERCOLORSWIZZLEback to summary
public static final int BORDERCOLORSWIZZLE

The struct member offsets.

BORDERCOLORSWIZZLEFROMIMAGEback to summary
public static final int BORDERCOLORSWIZZLEFROMIMAGE

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.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkPhysicalDeviceBorderColorSwizzleFeaturesEXTback to summary
protected VkPhysicalDeviceBorderColorSwizzleFeaturesEXT(long address, ByteBuffer container)
VkPhysicalDeviceBorderColorSwizzleFeaturesEXTback to summary
public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT(ByteBuffer container)

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

borderColorSwizzleback to summary
public boolean borderColorSwizzle()

indicates that defined values are returned by sampled image operations when used with a sampler that uses a BORDER_COLOR_FLOAT_OPAQUE_BLACK, BORDER_COLOR_INT_OPAQUE_BLACK, BORDER_COLOR_FLOAT_CUSTOM_EXT, or BORDER_COLOR_INT_CUSTOM_EXT borderColor and an image view that uses a non-identity component mapping, when either borderColorSwizzleFromImage is enabled or the VkSamplerBorderColorComponentMappingCreateInfoEXT is specified.

Annotations
@NativeType:VkBool32
borderColorSwizzleback to summary
public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT borderColorSwizzle(boolean value)

Sets the specified value to the borderColorSwizzle field.

borderColorSwizzleFromImageback to summary
public boolean borderColorSwizzleFromImage()

indicates that the implementation will return the correct border color values from sampled image operations under the conditions expressed above, without the application having to specify the border color component mapping when creating the sampler object. If this feature bit is not set, applications can chain a VkSamplerBorderColorComponentMappingCreateInfoEXT structure when creating samplers for use with image views that do not have an identity swizzle and, when those samplers are combined with image views using the same component mapping, sampled image operations that use opaque black or custom border colors will return the correct border color values.

Annotations
@NativeType:VkBool32
borderColorSwizzleFromImageback to summary
public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT borderColorSwizzleFromImage(boolean value)

Sets the specified value to the borderColorSwizzleFromImage field.

callocback to summary
public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT calloc(MemoryStack stack)

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

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

createback to summary
protected VkPhysicalDeviceBorderColorSwizzleFeaturesEXT 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 VkPhysicalDeviceBorderColorSwizzleFeaturesEXT create()

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT create(long address)

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance for the specified memory address.

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

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceBorderColorSwizzleFeaturesEXT malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nborderColorSwizzleback to summary
public static int nborderColorSwizzle(long struct)

Unsafe version of borderColorSwizzle.

nborderColorSwizzleback to summary
public static void nborderColorSwizzle(long struct, int value)

Unsafe version of borderColorSwizzle.

nborderColorSwizzleFromImageback to summary
public static int nborderColorSwizzleFromImage(long struct)

Unsafe version of borderColorSwizzleFromImage.

nborderColorSwizzleFromImageback to summary
public static void nborderColorSwizzleFromImage(long struct, int value)

Unsafe version of borderColorSwizzleFromImage.

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.

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 *
pNextback to summary
public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT set(int sType, long pNext, boolean borderColorSwizzle, boolean borderColorSwizzleFromImage)

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT set(VkPhysicalDeviceBorderColorSwizzleFeaturesEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceBorderColorSwizzleFeaturesEXT

the source struct

Returns:VkPhysicalDeviceBorderColorSwizzleFeaturesEXT

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
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_BORDER_COLOR_SWIZZLE_FEATURES_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer

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

An array of VkPhysicalDeviceBorderColorSwizzleFeaturesEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceBorderColorSwizzleFeaturesEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.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 boolean
public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer
borderColorSwizzle(boolean value)

Sets the specified value to the VkPhysicalDeviceBorderColorSwizzleFeaturesEXT#borderColorSwizzle field.

public boolean
public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer
protected VkPhysicalDeviceBorderColorSwizzleFeaturesEXT
public long
public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer
pNext(long value)

Sets the specified value to the VkPhysicalDeviceBorderColorSwizzleFeaturesEXT#pNext field.

protected VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer
public int
public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer
sType(int value)

Sets the specified value to the VkPhysicalDeviceBorderColorSwizzleFeaturesEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceBorderColorSwizzleFeaturesEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.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 VkPhysicalDeviceBorderColorSwizzleFeaturesEXT#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

borderColorSwizzleback to summary
public boolean borderColorSwizzle()
Returns:boolean

the value of the VkPhysicalDeviceBorderColorSwizzleFeaturesEXT#borderColorSwizzle field.

Annotations
@NativeType:VkBool32
borderColorSwizzleback to summary
public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer borderColorSwizzle(boolean value)

Sets the specified value to the VkPhysicalDeviceBorderColorSwizzleFeaturesEXT#borderColorSwizzle field.

borderColorSwizzleFromImageback to summary
public boolean borderColorSwizzleFromImage()
Returns:boolean

the value of the VkPhysicalDeviceBorderColorSwizzleFeaturesEXT#borderColorSwizzleFromImage field.

Annotations
@NativeType:VkBool32
borderColorSwizzleFromImageback to summary
public VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer borderColorSwizzleFromImage(boolean value)

Sets the specified value to the VkPhysicalDeviceBorderColorSwizzleFeaturesEXT#borderColorSwizzleFromImage field.

getElementFactoryback to summary
protected VkPhysicalDeviceBorderColorSwizzleFeaturesEXT getElementFactory()

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

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

the value of the VkPhysicalDeviceBorderColorSwizzleFeaturesEXT#pNext field.

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

Sets the specified value to the VkPhysicalDeviceBorderColorSwizzleFeaturesEXT#pNext field.

selfback to summary
protected VkPhysicalDeviceBorderColorSwizzleFeaturesEXT.Buffer self()

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

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkPhysicalDeviceBorderColorSwizzleFeaturesEXT#sType field.

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

Sets the specified value to the VkPhysicalDeviceBorderColorSwizzleFeaturesEXT#sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_BORDER_COLOR_SWIZZLE_FEATURES_EXT value to the VkPhysicalDeviceBorderColorSwizzleFeaturesEXT#sType field.