Package org.lwjgl.vulkan

Class VkPhysicalDeviceShaderImageFootprintFeaturesNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.vulkan.VkPhysicalDeviceShaderImageFootprintFeaturesNV

All Implemented Interfaces:

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

public class VkPhysicalDeviceShaderImageFootprintFeaturesNV
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Structure describing shader image footprint features that can be supported by an implementation.

Description

See Texel Footprint Evaluation for more information.

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

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_IMAGE_FOOTPRINT_FEATURES_NV

Layout

 struct VkPhysicalDeviceShaderImageFootprintFeaturesNV {
     VkStructureType sType();
     void * pNext();
     VkBool32 imageFootprint();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer	An array of VkPhysicalDeviceShaderImageFootprintFeaturesNV structs.

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Field Summary

Fields

Modifier and Type	Field	Description
static int	ALIGNOF	The struct alignment in bytes.
static int	IMAGEFOOTPRINT PNEXT	The struct member offsets.
static int	SIZEOF	The struct size in bytes.
static 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
VkPhysicalDeviceShaderImageFootprintFeaturesNV(java.nio.ByteBuffer container)	Creates a VkPhysicalDeviceShaderImageFootprintFeaturesNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceShaderImageFootprintFeaturesNV	calloc()	Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV instance allocated with memCalloc.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV	callocStack()	Deprecated.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer	callocStack(int capacity)	Deprecated.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV	create()	Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV instance allocated with BufferUtils.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV	create(long address)	Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV instance for the specified memory address.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer instance at the specified memory.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV	createSafe(long address)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	imageFootprint()	specifies whether the implementation supports the ImageFootprintNV SPIR-V capability.
VkPhysicalDeviceShaderImageFootprintFeaturesNV	imageFootprint(boolean value)	Sets the specified value to the imageFootprint() field.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV	malloc()	Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV instance allocated with memAlloc.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV instance allocated on the specified MemoryStack.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV	mallocStack()	Deprecated.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer	mallocStack(int capacity)	Deprecated.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceShaderImageFootprintFeaturesNV	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nimageFootprint(long struct)	Unsafe version of imageFootprint().
static void	nimageFootprint(long struct, int value)	Unsafe version of imageFootprint.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
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.
VkPhysicalDeviceShaderImageFootprintFeaturesNV	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceShaderImageFootprintFeaturesNV	set(int sType, long pNext, boolean imageFootprint)	Initializes this struct with the specified values.
VkPhysicalDeviceShaderImageFootprintFeaturesNV	set(VkPhysicalDeviceShaderImageFootprintFeaturesNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	the type of this structure.
VkPhysicalDeviceShaderImageFootprintFeaturesNV	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceShaderImageFootprintFeaturesNV	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_IMAGE_FOOTPRINT_FEATURES_NV value to the sType() field.

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Field Detail

SIZEOF

The struct size in bytes.

ALIGNOF

The struct alignment in bytes.

STYPE, PNEXT, IMAGEFOOTPRINT

The struct member offsets.

Constructor Detail

VkPhysicalDeviceShaderImageFootprintFeaturesNV

public VkPhysicalDeviceShaderImageFootprintFeaturesNV(java.nio.ByteBuffer container)

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

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct

sType

public int sType()

the type of this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

imageFootprint

public boolean imageFootprint()

specifies whether the implementation supports the ImageFootprintNV SPIR-V capability.

sType

public VkPhysicalDeviceShaderImageFootprintFeaturesNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceShaderImageFootprintFeaturesNV sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_IMAGE_FOOTPRINT_FEATURES_NV value to the sType() field.

pNext

public VkPhysicalDeviceShaderImageFootprintFeaturesNV pNext(long value)

Sets the specified value to the pNext() field.

imageFootprint

public VkPhysicalDeviceShaderImageFootprintFeaturesNV imageFootprint(boolean value)

Sets the specified value to the imageFootprint() field.

set

public VkPhysicalDeviceShaderImageFootprintFeaturesNV set(int sType,
                                                          long pNext,
                                                          boolean imageFootprint)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceShaderImageFootprintFeaturesNV set(VkPhysicalDeviceShaderImageFootprintFeaturesNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceShaderImageFootprintFeaturesNV malloc()

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

calloc

public static VkPhysicalDeviceShaderImageFootprintFeaturesNV calloc()

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

create

public static VkPhysicalDeviceShaderImageFootprintFeaturesNV create()

Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV instance allocated with BufferUtils.

create

public static VkPhysicalDeviceShaderImageFootprintFeaturesNV create(long address)

Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV instance for the specified memory address.

createSafe

@Nullable
public static VkPhysicalDeviceShaderImageFootprintFeaturesNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer create(int capacity)

Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPhysicalDeviceShaderImageFootprintFeaturesNV mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkPhysicalDeviceShaderImageFootprintFeaturesNV callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkPhysicalDeviceShaderImageFootprintFeaturesNV mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkPhysicalDeviceShaderImageFootprintFeaturesNV callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer mallocStack(int capacity,
                                                                                org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkPhysicalDeviceShaderImageFootprintFeaturesNV.Buffer callocStack(int capacity,
                                                                                org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

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

Returns a new VkPhysicalDeviceShaderImageFootprintFeaturesNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

calloc

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

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

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nimageFootprint

public static int nimageFootprint(long struct)

Unsafe version of imageFootprint().

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.

nimageFootprint

public static void nimageFootprint(long struct,
                                   int value)

Unsafe version of imageFootprint.