Package org.lwjgl.vulkan

Class VkSwapchainPresentScalingCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSwapchainPresentScalingCreateInfoEXT>

org.lwjgl.vulkan.VkSwapchainPresentScalingCreateInfoEXT

All Implemented Interfaces:

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

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

Scaling behavior when presenting to the surface.

Description

If scalingBehavior is 0, the result of presenting a swapchain image with dimensions that do not match the surface dimensions is implementation and platform-dependent. If presentGravityX or presentGravityY are 0, the presentation gravity must match that defined by the native platform surface on platforms which define surface gravity.

Valid Usage

• If presentGravityX is 0, presentGravityY must be 0
• If presentGravityX is not 0, presentGravityY must not be 0
• scalingBehavior must not have more than one bit set
• presentGravityX must not have more than one bit set
• presentGravityY must not have more than one bit set
• scalingBehavior must be 0 or a valid scaling method for the surface as returned in VkSurfacePresentScalingCapabilitiesEXT::supportedPresentScaling, given VkSwapchainCreateInfoKHR::presentMode in VkSurfacePresentModeEXT
• If the swapchain is created with VkSwapchainPresentModesCreateInfoEXT, scalingBehavior must be 0 or a valid scaling method for the surface as returned in VkSurfacePresentScalingCapabilitiesEXT::supportedPresentScaling, given each present mode in VkSwapchainPresentModesCreateInfoEXT::pPresentModes in VkSurfacePresentModeEXT
• presentGravityX must be 0 or a valid x-axis present gravity for the surface as returned in VkSurfacePresentScalingCapabilitiesEXT::supportedPresentGravityX, given VkSwapchainCreateInfoKHR::presentMode in VkSurfacePresentModeEXT
• If the swapchain is created with VkSwapchainPresentModesCreateInfoEXT, presentGravityX must be 0 or a valid x-axis present gravity for the surface as returned in VkSurfacePresentScalingCapabilitiesEXT::supportedPresentGravityX, given each present mode in VkSwapchainPresentModesCreateInfoEXT::pPresentModes in VkSurfacePresentModeEXT
• presentGravityY must be 0 or a valid y-axis present gravity for the surface as returned in VkSurfacePresentScalingCapabilitiesEXT::supportedPresentGravityY, given VkSwapchainCreateInfoKHR::presentMode in VkSurfacePresentModeEXT
• If the swapchain is created with VkSwapchainPresentModesCreateInfoEXT, presentGravityY must be 0 or a valid y-axis present gravity for the surface as returned in VkSurfacePresentScalingCapabilitiesEXT::supportedPresentGravityY, given each present mode in VkSwapchainPresentModesCreateInfoEXT::pPresentModes in VkSurfacePresentModeEXT
• If the swapchainMaintenance1 feature is not enabled, then presentScaling, presentGravityX, and presentGravityY must be 0

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT
• scalingBehavior must be a valid combination of VkPresentScalingFlagBitsEXT values
• presentGravityX must be a valid combination of VkPresentGravityFlagBitsEXT values
• presentGravityY must be a valid combination of VkPresentGravityFlagBitsEXT values

Layout

 struct VkSwapchainPresentScalingCreateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkPresentScalingFlagsEXT scalingBehavior();
     VkPresentGravityFlagsEXT presentGravityX();
     VkPresentGravityFlagsEXT presentGravityY();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSwapchainPresentScalingCreateInfoEXT.Buffer	An array of VkSwapchainPresentScalingCreateInfoEXT 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	PNEXT	The struct member offsets.
static final int	PRESENTGRAVITYX	The struct member offsets.
static final int	PRESENTGRAVITYY	The struct member offsets.
static final int	SCALINGBEHAVIOR	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final 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
VkSwapchainPresentScalingCreateInfoEXT(ByteBuffer container)	Creates a VkSwapchainPresentScalingCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkSwapchainPresentScalingCreateInfoEXT	calloc()	Returns a new VkSwapchainPresentScalingCreateInfoEXT instance allocated with memCalloc.
static VkSwapchainPresentScalingCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkSwapchainPresentScalingCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkSwapchainPresentScalingCreateInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSwapchainPresentScalingCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSwapchainPresentScalingCreateInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSwapchainPresentScalingCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSwapchainPresentScalingCreateInfoEXT	create()	Returns a new VkSwapchainPresentScalingCreateInfoEXT instance allocated with BufferUtils.
static VkSwapchainPresentScalingCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkSwapchainPresentScalingCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkSwapchainPresentScalingCreateInfoEXT	create(long address)	Returns a new VkSwapchainPresentScalingCreateInfoEXT instance for the specified memory address.
static VkSwapchainPresentScalingCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkSwapchainPresentScalingCreateInfoEXT.Buffer instance at the specified memory.
static @Nullable VkSwapchainPresentScalingCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSwapchainPresentScalingCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSwapchainPresentScalingCreateInfoEXT	malloc()	Returns a new VkSwapchainPresentScalingCreateInfoEXT instance allocated with memAlloc.
static VkSwapchainPresentScalingCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkSwapchainPresentScalingCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkSwapchainPresentScalingCreateInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSwapchainPresentScalingCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkSwapchainPresentScalingCreateInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSwapchainPresentScalingCreateInfoEXT instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	npresentGravityX(long struct)	Unsafe version of presentGravityX().
static void	npresentGravityX(long struct, int value)	Unsafe version of presentGravityX.
static int	npresentGravityY(long struct)	Unsafe version of presentGravityY().
static void	npresentGravityY(long struct, int value)	Unsafe version of presentGravityY.
static int	nscalingBehavior(long struct)	Unsafe version of scalingBehavior().
static void	nscalingBehavior(long struct, int value)	Unsafe version of scalingBehavior.
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.
VkSwapchainPresentScalingCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
int	presentGravityX()	0 or the x-axis direction in which swapchain image pixels gravitate relative to the surface when scalingBehavior does not result in a one-to-one pixel mapping between the scaled swapchain image and the surface.
VkSwapchainPresentScalingCreateInfoEXT	presentGravityX(int value)	Sets the specified value to the presentGravityX() field.
int	presentGravityY()	0 or the y-axis direction in which swapchain image pixels gravitate relative to the surface when scalingBehavior does not result in a one-to-one pixel mapping between the scaled swapchain image and the surface.
VkSwapchainPresentScalingCreateInfoEXT	presentGravityY(int value)	Sets the specified value to the presentGravityY() field.
int	scalingBehavior()	0 or the scaling method to use when the dimensions of the surface and swapchain images differ.
VkSwapchainPresentScalingCreateInfoEXT	scalingBehavior(int value)	Sets the specified value to the scalingBehavior() field.
VkSwapchainPresentScalingCreateInfoEXT	set(int sType, long pNext, int scalingBehavior, int presentGravityX, int presentGravityY)	Initializes this struct with the specified values.
VkSwapchainPresentScalingCreateInfoEXT	set(VkSwapchainPresentScalingCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkSwapchainPresentScalingCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkSwapchainPresentScalingCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT value to the sType() field.

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.

SCALINGBEHAVIOR

public static final int SCALINGBEHAVIOR

The struct member offsets.

PRESENTGRAVITYX

public static final int PRESENTGRAVITYX

The struct member offsets.

PRESENTGRAVITYY

public static final int PRESENTGRAVITYY

The struct member offsets.

Constructor Details

VkSwapchainPresentScalingCreateInfoEXT

public VkSwapchainPresentScalingCreateInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

scalingBehavior

public int scalingBehavior()

0 or the scaling method to use when the dimensions of the surface and swapchain images differ.

presentGravityX

public int presentGravityX()

0 or the x-axis direction in which swapchain image pixels gravitate relative to the surface when scalingBehavior does not result in a one-to-one pixel mapping between the scaled swapchain image and the surface.

presentGravityY

public int presentGravityY()

0 or the y-axis direction in which swapchain image pixels gravitate relative to the surface when scalingBehavior does not result in a one-to-one pixel mapping between the scaled swapchain image and the surface.

sType

public VkSwapchainPresentScalingCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSwapchainPresentScalingCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT value to the sType() field.

pNext

public VkSwapchainPresentScalingCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

scalingBehavior

public VkSwapchainPresentScalingCreateInfoEXT scalingBehavior(int value)

Sets the specified value to the scalingBehavior() field.

presentGravityX

public VkSwapchainPresentScalingCreateInfoEXT presentGravityX(int value)

Sets the specified value to the presentGravityX() field.

presentGravityY

public VkSwapchainPresentScalingCreateInfoEXT presentGravityY(int value)

Sets the specified value to the presentGravityY() field.

set

public VkSwapchainPresentScalingCreateInfoEXT set(int sType,
 long pNext,
 int scalingBehavior,
 int presentGravityX,
 int presentGravityY)

Initializes this struct with the specified values.

set

public VkSwapchainPresentScalingCreateInfoEXT set(VkSwapchainPresentScalingCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSwapchainPresentScalingCreateInfoEXT malloc()

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

calloc

public static VkSwapchainPresentScalingCreateInfoEXT calloc()

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

create

public static VkSwapchainPresentScalingCreateInfoEXT create()

Returns a new VkSwapchainPresentScalingCreateInfoEXT instance allocated with BufferUtils.

create

public static VkSwapchainPresentScalingCreateInfoEXT create(long address)

Returns a new VkSwapchainPresentScalingCreateInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkSwapchainPresentScalingCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSwapchainPresentScalingCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSwapchainPresentScalingCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSwapchainPresentScalingCreateInfoEXT.Buffer create(int capacity)

Returns a new VkSwapchainPresentScalingCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSwapchainPresentScalingCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkSwapchainPresentScalingCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nscalingBehavior

public static int nscalingBehavior(long struct)

Unsafe version of scalingBehavior().

npresentGravityX

public static int npresentGravityX(long struct)

Unsafe version of presentGravityX().

npresentGravityY

public static int npresentGravityY(long struct)

Unsafe version of presentGravityY().

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.

nscalingBehavior

public static void nscalingBehavior(long struct,
 int value)

Unsafe version of scalingBehavior.

npresentGravityX

public static void npresentGravityX(long struct,
 int value)

Unsafe version of presentGravityX.

npresentGravityY

public static void npresentGravityY(long struct,
 int value)

Unsafe version of presentGravityY.