Package org.lwjgl.vulkan

Class VkSurfacePresentScalingCapabilitiesEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSurfacePresentScalingCapabilitiesEXT>

org.lwjgl.vulkan.VkSurfacePresentScalingCapabilitiesEXT

All Implemented Interfaces:

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

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

Structure describing the presentation scaling capabilities of the surface.

Description

Before creating a swapchain whose scaling mode can be specified through the use of VkSwapchainPresentScalingCreateInfoEXT, obtain the set of supported scaling modes by including a VkSurfacePresentModeEXT structure in the pNext chain of VkPhysicalDeviceSurfaceInfo2KHR when calling GetPhysicalDeviceSurfaceCapabilities2KHR. The implementation must return the same values in VkSurfacePresentScalingCapabilitiesEXT for any of the compatible present modes as obtained through VkSurfacePresentModeCompatibilityEXT.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SURFACE_PRESENT_SCALING_CAPABILITIES_EXT

See Also

VkExtent2D

Layout

 struct VkSurfacePresentScalingCapabilitiesEXT {
     VkStructureType sType();
     void * pNext();
     VkPresentScalingFlagsEXT supportedPresentScaling();
     VkPresentGravityFlagsEXT supportedPresentGravityX();
     VkPresentGravityFlagsEXT supportedPresentGravityY();
     VkExtent2D minScaledImageExtent();
     VkExtent2D maxScaledImageExtent();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkSurfacePresentScalingCapabilitiesEXT	calloc()	Returns a new VkSurfacePresentScalingCapabilitiesEXT instance allocated with memCalloc.
static VkSurfacePresentScalingCapabilitiesEXT.Buffer	calloc(int capacity)	Returns a new VkSurfacePresentScalingCapabilitiesEXT.Buffer instance allocated with memCalloc.
static VkSurfacePresentScalingCapabilitiesEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSurfacePresentScalingCapabilitiesEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSurfacePresentScalingCapabilitiesEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSurfacePresentScalingCapabilitiesEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSurfacePresentScalingCapabilitiesEXT	create()	Returns a new VkSurfacePresentScalingCapabilitiesEXT instance allocated with BufferUtils.
static VkSurfacePresentScalingCapabilitiesEXT.Buffer	create(int capacity)	Returns a new VkSurfacePresentScalingCapabilitiesEXT.Buffer instance allocated with BufferUtils.
static VkSurfacePresentScalingCapabilitiesEXT	create(long address)	Returns a new VkSurfacePresentScalingCapabilitiesEXT instance for the specified memory address.
static VkSurfacePresentScalingCapabilitiesEXT.Buffer	create(long address, int capacity)	Create a VkSurfacePresentScalingCapabilitiesEXT.Buffer instance at the specified memory.
static @Nullable VkSurfacePresentScalingCapabilitiesEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSurfacePresentScalingCapabilitiesEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSurfacePresentScalingCapabilitiesEXT	malloc()	Returns a new VkSurfacePresentScalingCapabilitiesEXT instance allocated with memAlloc.
static VkSurfacePresentScalingCapabilitiesEXT.Buffer	malloc(int capacity)	Returns a new VkSurfacePresentScalingCapabilitiesEXT.Buffer instance allocated with memAlloc.
static VkSurfacePresentScalingCapabilitiesEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSurfacePresentScalingCapabilitiesEXT.Buffer instance allocated on the specified MemoryStack.
static VkSurfacePresentScalingCapabilitiesEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSurfacePresentScalingCapabilitiesEXT instance allocated on the specified MemoryStack.
VkExtent2D	maxScaledImageExtent()	contains the largest valid swapchain extent for the surface on the specified device when one of the scaling methods specified in supportedPresentScaling is used, or the special value described above for minScaledImageExtent.
VkExtent2D	minScaledImageExtent()	contains the smallest valid swapchain extent for the surface on the specified device when one of the scaling methods specified in supportedPresentScaling is used, or the special value (0xFFFFFFFF, 0xFFFFFFFF) indicating that the surface size will be determined by the extent of a swapchain targeting the surface.
static VkExtent2D	nmaxScaledImageExtent(long struct)	Unsafe version of maxScaledImageExtent().
static VkExtent2D	nminScaledImageExtent(long struct)	Unsafe version of minScaledImageExtent().
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.
static int	nsupportedPresentGravityX(long struct)	Unsafe version of supportedPresentGravityX().
static int	nsupportedPresentGravityY(long struct)	Unsafe version of supportedPresentGravityY().
static int	nsupportedPresentScaling(long struct)	Unsafe version of supportedPresentScaling().
long	pNext()	NULL or a pointer to a structure extending this structure.
VkSurfacePresentScalingCapabilitiesEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkSurfacePresentScalingCapabilitiesEXT	set(int sType, long pNext)	Initializes this struct with the specified values.
VkSurfacePresentScalingCapabilitiesEXT	set(VkSurfacePresentScalingCapabilitiesEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkSurfacePresentScalingCapabilitiesEXT	sType(int value)	Sets the specified value to the sType() field.
VkSurfacePresentScalingCapabilitiesEXT	sType$Default()	Sets the STRUCTURE_TYPE_SURFACE_PRESENT_SCALING_CAPABILITIES_EXT value to the sType() field.
int	supportedPresentGravityX()	a bitmask of VkPresentGravityFlagBitsEXT representing the X-axis pixel gravity supported by the surface, or 0 if Vulkan-defined pixel gravity is not supported for the X axis.
int	supportedPresentGravityY()	a bitmask of VkPresentGravityFlagBitsEXT representing the Y-axis pixel gravity supported by the surface, or 0 if Vulkan-defined pixel gravity is not supported for the Y axis.
int	supportedPresentScaling()	a bitmask of VkPresentScalingFlagBitsEXT representing the scaling methods supported by the surface, or 0 if application-defined scaling is not supported.

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.

SUPPORTEDPRESENTSCALING

public static final int SUPPORTEDPRESENTSCALING

The struct member offsets.

SUPPORTEDPRESENTGRAVITYX

public static final int SUPPORTEDPRESENTGRAVITYX

The struct member offsets.

SUPPORTEDPRESENTGRAVITYY

public static final int SUPPORTEDPRESENTGRAVITYY

The struct member offsets.

MINSCALEDIMAGEEXTENT

public static final int MINSCALEDIMAGEEXTENT

The struct member offsets.

MAXSCALEDIMAGEEXTENT

public static final int MAXSCALEDIMAGEEXTENT

The struct member offsets.

Constructor Details

VkSurfacePresentScalingCapabilitiesEXT

public VkSurfacePresentScalingCapabilitiesEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

supportedPresentScaling

public int supportedPresentScaling()

a bitmask of VkPresentScalingFlagBitsEXT representing the scaling methods supported by the surface, or 0 if application-defined scaling is not supported.

supportedPresentGravityX

public int supportedPresentGravityX()

a bitmask of VkPresentGravityFlagBitsEXT representing the X-axis pixel gravity supported by the surface, or 0 if Vulkan-defined pixel gravity is not supported for the X axis.

supportedPresentGravityY

public int supportedPresentGravityY()

a bitmask of VkPresentGravityFlagBitsEXT representing the Y-axis pixel gravity supported by the surface, or 0 if Vulkan-defined pixel gravity is not supported for the Y axis.

minScaledImageExtent

public VkExtent2D minScaledImageExtent()

contains the smallest valid swapchain extent for the surface on the specified device when one of the scaling methods specified in supportedPresentScaling is used, or the special value (0xFFFFFFFF, 0xFFFFFFFF) indicating that the surface size will be determined by the extent of a swapchain targeting the surface. The width and height of the extent will each be smaller than or equal to the corresponding width and height of VkSurfaceCapabilitiesKHR::minImageExtent.

maxScaledImageExtent

public VkExtent2D maxScaledImageExtent()

contains the largest valid swapchain extent for the surface on the specified device when one of the scaling methods specified in supportedPresentScaling is used, or the special value described above for minScaledImageExtent. The width and height of the extent will each be greater than or equal to the corresponding width and height of VkSurfaceCapabilitiesKHR::maxImageExtent.

sType

public VkSurfacePresentScalingCapabilitiesEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSurfacePresentScalingCapabilitiesEXT sType$Default()

Sets the STRUCTURE_TYPE_SURFACE_PRESENT_SCALING_CAPABILITIES_EXT value to the sType() field.

pNext

public VkSurfacePresentScalingCapabilitiesEXT pNext(long value)

Sets the specified value to the pNext() field.

set

public VkSurfacePresentScalingCapabilitiesEXT set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkSurfacePresentScalingCapabilitiesEXT set(VkSurfacePresentScalingCapabilitiesEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSurfacePresentScalingCapabilitiesEXT malloc()

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

calloc

public static VkSurfacePresentScalingCapabilitiesEXT calloc()

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

create

public static VkSurfacePresentScalingCapabilitiesEXT create()

Returns a new VkSurfacePresentScalingCapabilitiesEXT instance allocated with BufferUtils.

create

public static VkSurfacePresentScalingCapabilitiesEXT create(long address)

Returns a new VkSurfacePresentScalingCapabilitiesEXT instance for the specified memory address.

createSafe

public static @Nullable VkSurfacePresentScalingCapabilitiesEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSurfacePresentScalingCapabilitiesEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSurfacePresentScalingCapabilitiesEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSurfacePresentScalingCapabilitiesEXT.Buffer create(int capacity)

Returns a new VkSurfacePresentScalingCapabilitiesEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSurfacePresentScalingCapabilitiesEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkSurfacePresentScalingCapabilitiesEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsupportedPresentScaling

public static int nsupportedPresentScaling(long struct)

Unsafe version of supportedPresentScaling().

nsupportedPresentGravityX

public static int nsupportedPresentGravityX(long struct)

Unsafe version of supportedPresentGravityX().

nsupportedPresentGravityY

public static int nsupportedPresentGravityY(long struct)

Unsafe version of supportedPresentGravityY().

nminScaledImageExtent

public static VkExtent2D nminScaledImageExtent(long struct)

Unsafe version of minScaledImageExtent().

nmaxScaledImageExtent

public static VkExtent2D nmaxScaledImageExtent(long struct)

Unsafe version of maxScaledImageExtent().

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.