Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceCustomBorderColorFeaturesEXT

extends Struct<VkPhysicalDeviceCustomBorderColorFeaturesEXT>
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 custom border colors can be supported by an implementation.
Description

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

Valid Usage (Implicit)

Layout


struct VkPhysicalDeviceCustomBorderColorFeaturesEXT {
    VkStructureType sType;
    void * pNext;
    VkBool32 customBorderColors;
    VkBool32 customBorderColorWithoutFormat;
}

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
CUSTOMBORDERCOLORS

The struct member offsets.

public static final int
CUSTOMBORDERCOLORWITHOUTFORMAT

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
VkPhysicalDeviceCustomBorderColorFeaturesEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPhysicalDeviceCustomBorderColorFeaturesEXT
calloc()

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance allocated with memCalloc.

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

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance allocated with BufferUtils.

public static VkPhysicalDeviceCustomBorderColorFeaturesEXT
create(long address)

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance for the specified memory address.

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

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer instance allocated with BufferUtils.

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

Create a VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer instance at the specified memory.

public static VkPhysicalDeviceCustomBorderColorFeaturesEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public boolean
customBorderColors()

indicates that the implementation supports providing a borderColor value with one of the following values at sampler creation time:

public VkPhysicalDeviceCustomBorderColorFeaturesEXT
customBorderColors(boolean value)

Sets the specified value to the customBorderColors field.

public boolean
customBorderColorWithoutFormat()

indicates that explicit formats are not required for custom border colors and the value of the format member of the VkSamplerCustomBorderColorCreateInfoEXT structure may be FORMAT_UNDEFINED.

public VkPhysicalDeviceCustomBorderColorFeaturesEXT
customBorderColorWithoutFormat(boolean value)

Sets the specified value to the customBorderColorWithoutFormat field.

public static VkPhysicalDeviceCustomBorderColorFeaturesEXT
malloc()

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance allocated on the specified MemoryStack.

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

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

public static int
ncustomBorderColors(long struct)

Unsafe version of customBorderColors.

public static void
ncustomBorderColors(long struct, int value)

Unsafe version of customBorderColors.

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

Unsafe version of customBorderColorWithoutFormat.

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

Sets the specified value to the pNext field.

public VkPhysicalDeviceCustomBorderColorFeaturesEXT
set(int sType, long pNext, boolean customBorderColors, boolean customBorderColorWithoutFormat)

Initializes this struct with the specified values.

public VkPhysicalDeviceCustomBorderColorFeaturesEXT

Returns:

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

Sets the specified value to the sType field.

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

CUSTOMBORDERCOLORSback to summary
public static final int CUSTOMBORDERCOLORS

The struct member offsets.

CUSTOMBORDERCOLORWITHOUTFORMATback to summary
public static final int CUSTOMBORDERCOLORWITHOUTFORMAT

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

VkPhysicalDeviceCustomBorderColorFeaturesEXTback to summary
protected VkPhysicalDeviceCustomBorderColorFeaturesEXT(long address, ByteBuffer container)
VkPhysicalDeviceCustomBorderColorFeaturesEXTback to summary
public VkPhysicalDeviceCustomBorderColorFeaturesEXT(ByteBuffer container)

Creates a VkPhysicalDeviceCustomBorderColorFeaturesEXT 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 VkPhysicalDeviceCustomBorderColorFeaturesEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceCustomBorderColorFeaturesEXT calloc(MemoryStack stack)

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

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

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceCustomBorderColorFeaturesEXT create(long address)

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance for the specified memory address.

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

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceCustomBorderColorFeaturesEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
customBorderColorsback to summary
public boolean customBorderColors()

indicates that the implementation supports providing a borderColor value with one of the following values at sampler creation time:

Annotations
@NativeType:VkBool32
customBorderColorsback to summary
public VkPhysicalDeviceCustomBorderColorFeaturesEXT customBorderColors(boolean value)

Sets the specified value to the customBorderColors field.

customBorderColorWithoutFormatback to summary
public boolean customBorderColorWithoutFormat()

indicates that explicit formats are not required for custom border colors and the value of the format member of the VkSamplerCustomBorderColorCreateInfoEXT structure may be FORMAT_UNDEFINED. If this feature bit is not set, applications must provide the VkFormat of the image view(s) being sampled by this sampler in the format member of the VkSamplerCustomBorderColorCreateInfoEXT structure.

Annotations
@NativeType:VkBool32
customBorderColorWithoutFormatback to summary
public VkPhysicalDeviceCustomBorderColorFeaturesEXT customBorderColorWithoutFormat(boolean value)

Sets the specified value to the customBorderColorWithoutFormat field.

mallocback to summary
public static VkPhysicalDeviceCustomBorderColorFeaturesEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceCustomBorderColorFeaturesEXT malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceCustomBorderColorFeaturesEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncustomBorderColorsback to summary
public static int ncustomBorderColors(long struct)

Unsafe version of customBorderColors.

ncustomBorderColorsback to summary
public static void ncustomBorderColors(long struct, int value)

Unsafe version of customBorderColors.

ncustomBorderColorWithoutFormatback to summary
public static int ncustomBorderColorWithoutFormat(long struct)

Unsafe version of customBorderColorWithoutFormat.

ncustomBorderColorWithoutFormatback to summary
public static void ncustomBorderColorWithoutFormat(long struct, int value)

Unsafe version of customBorderColorWithoutFormat.

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

Sets the specified value to the pNext field.

setback to summary
public VkPhysicalDeviceCustomBorderColorFeaturesEXT set(int sType, long pNext, boolean customBorderColors, boolean customBorderColorWithoutFormat)

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceCustomBorderColorFeaturesEXT set(VkPhysicalDeviceCustomBorderColorFeaturesEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceCustomBorderColorFeaturesEXT

the source struct

Returns:VkPhysicalDeviceCustomBorderColorFeaturesEXT

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 VkPhysicalDeviceCustomBorderColorFeaturesEXT sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_CUSTOM_BORDER_COLOR_FEATURES_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer

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

An array of VkPhysicalDeviceCustomBorderColorFeaturesEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceCustomBorderColorFeaturesEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceCustomBorderColorFeaturesEXT.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 VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer
customBorderColors(boolean value)

Sets the specified value to the VkPhysicalDeviceCustomBorderColorFeaturesEXT#customBorderColors field.

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

Sets the specified value to the VkPhysicalDeviceCustomBorderColorFeaturesEXT#pNext field.

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

Sets the specified value to the VkPhysicalDeviceCustomBorderColorFeaturesEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceCustomBorderColorFeaturesEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

customBorderColorsback to summary
public boolean customBorderColors()
Returns:boolean

the value of the VkPhysicalDeviceCustomBorderColorFeaturesEXT#customBorderColors field.

Annotations
@NativeType:VkBool32
customBorderColorsback to summary
public VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer customBorderColors(boolean value)

Sets the specified value to the VkPhysicalDeviceCustomBorderColorFeaturesEXT#customBorderColors field.

customBorderColorWithoutFormatback to summary
public boolean customBorderColorWithoutFormat()
Returns:boolean

the value of the VkPhysicalDeviceCustomBorderColorFeaturesEXT#customBorderColorWithoutFormat field.

Annotations
@NativeType:VkBool32
customBorderColorWithoutFormatback to summary
public VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer customBorderColorWithoutFormat(boolean value)

Sets the specified value to the VkPhysicalDeviceCustomBorderColorFeaturesEXT#customBorderColorWithoutFormat field.

getElementFactoryback to summary
protected VkPhysicalDeviceCustomBorderColorFeaturesEXT getElementFactory()

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

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

the value of the VkPhysicalDeviceCustomBorderColorFeaturesEXT#pNext field.

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

Sets the specified value to the VkPhysicalDeviceCustomBorderColorFeaturesEXT#pNext field.

selfback to summary
protected VkPhysicalDeviceCustomBorderColorFeaturesEXT.Buffer self()

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

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

the value of the VkPhysicalDeviceCustomBorderColorFeaturesEXT#sType field.

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

Sets the specified value to the VkPhysicalDeviceCustomBorderColorFeaturesEXT#sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_CUSTOM_BORDER_COLOR_FEATURES_EXT value to the VkPhysicalDeviceCustomBorderColorFeaturesEXT#sType field.