Package org.lwjgl.vulkan
Class VkPipelineViewportStateCreateInfo
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPipelineViewportStateCreateInfo>
org.lwjgl.vulkan.VkPipelineViewportStateCreateInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkPipelineViewportStateCreateInfo
extends org.lwjgl.system.Struct<VkPipelineViewportStateCreateInfo>
implements org.lwjgl.system.NativeResource
Structure specifying parameters of a newly created pipeline viewport state.
Valid Usage
- If the
multiViewportfeature is not enabled,viewportCountmust not be greater than 1 - If the
multiViewportfeature is not enabled,scissorCountmust not be greater than 1 viewportCountmust be less than or equal toVkPhysicalDeviceLimits::maxViewportsscissorCountmust be less than or equal toVkPhysicalDeviceLimits::maxViewports- The
xandymembers ofoffsetmember of any element ofpScissorsmust be greater than or equal to 0 - Evaluation of
(offset.x + extent.width)must not cause a signed integer addition overflow for any element ofpScissors - Evaluation of
(offset.y + extent.height)must not cause a signed integer addition overflow for any element ofpScissors - If
scissorCountandviewportCountare both not dynamic, thenscissorCountandviewportCountmust be identical - If the graphics pipeline is being created with
DYNAMIC_STATE_VIEWPORT_WITH_COUNTset thenviewportCountmust be 0, otherwiseviewportCountmust be greater than 0 - If the graphics pipeline is being created with
DYNAMIC_STATE_SCISSOR_WITH_COUNTset thenscissorCountmust be 0, otherwisescissorCountmust be greater than 0 - If the
viewportWScalingEnablemember of aVkPipelineViewportWScalingStateCreateInfoNVstructure included in thepNextchain isTRUE, theviewportCountmember of theVkPipelineViewportWScalingStateCreateInfoNVstructure must be greater than or equal toVkPipelineViewportStateCreateInfo::viewportCount
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkPipelineViewportCoarseSampleOrderStateCreateInfoNV,VkPipelineViewportDepthClampControlCreateInfoEXT,VkPipelineViewportDepthClipControlCreateInfoEXT,VkPipelineViewportExclusiveScissorStateCreateInfoNV,VkPipelineViewportShadingRateImageStateCreateInfoNV,VkPipelineViewportSwizzleStateCreateInfoNV, orVkPipelineViewportWScalingStateCreateInfoNV - The
sTypevalue of each struct in thepNextchain must be unique flagsmust be 0
See Also
VkGraphicsPipelineCreateInfo, VkRect2D, VkViewport
Layout
struct VkPipelineViewportStateCreateInfo {
VkStructureType sType();
void const * pNext();
VkPipelineViewportStateCreateFlags flags();
uint32_t viewportCount();
VkViewport const * pViewports();
uint32_t scissorCount();
VkRect2D const * pScissors();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkPipelineViewportStateCreateInfostructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkPipelineViewportStateCreateInfo(ByteBuffer container) Creates aVkPipelineViewportStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkPipelineViewportStateCreateInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkPipelineViewportStateCreateInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkPipelineViewportStateCreateInfoinstance for the specified memory address.create(long address, int capacity) Create aVkPipelineViewportStateCreateInfo.Bufferinstance at the specified memory.static @Nullable VkPipelineViewportStateCreateInfocreateSafe(long address) static @Nullable VkPipelineViewportStateCreateInfo.BuffercreateSafe(long address, int capacity) intflags()reserved for future use.flags(int value) Sets the specified value to theflags()field.malloc()Returns a newVkPipelineViewportStateCreateInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static @Nullable VkRect2D.BuffernpScissors(long struct) Unsafe version ofpScissors().static voidnpScissors(long struct, @Nullable VkRect2D.Buffer value) Unsafe version ofpScissors.static @Nullable VkViewport.BuffernpViewports(long struct) Unsafe version ofpViewports().static voidnpViewports(long struct, @Nullable VkViewport.Buffer value) Unsafe version ofpViewports.static intnscissorCount(long struct) Unsafe version ofscissorCount().static voidnscissorCount(long struct, int value) Sets the specified value to thescissorCountfield of the specifiedstruct.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intnviewportCount(long struct) Unsafe version ofviewportCount().static voidnviewportCount(long struct, int value) Sets the specified value to theviewportCountfield of the specifiedstruct.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkPipelineViewportCoarseSampleOrderStateCreateInfoNVvalue to thepNextchain.Prepends the specifiedVkPipelineViewportDepthClampControlCreateInfoEXTvalue to thepNextchain.Prepends the specifiedVkPipelineViewportDepthClipControlCreateInfoEXTvalue to thepNextchain.Prepends the specifiedVkPipelineViewportExclusiveScissorStateCreateInfoNVvalue to thepNextchain.Prepends the specifiedVkPipelineViewportShadingRateImageStateCreateInfoNVvalue to thepNextchain.Prepends the specifiedVkPipelineViewportSwizzleStateCreateInfoNVvalue to thepNextchain.Prepends the specifiedVkPipelineViewportWScalingStateCreateInfoNVvalue to thepNextchain.@Nullable VkRect2D.Buffera pointer to an array ofVkRect2Dstructures defining the rectangular bounds of the scissor for the corresponding viewport.pScissors(@Nullable VkRect2D.Buffer value) Sets the address of the specifiedVkRect2D.Bufferto thepScissors()field.@Nullable VkViewport.Buffera pointer to an array ofVkViewportstructures, defining the viewport transforms.pViewports(@Nullable VkViewport.Buffer value) Sets the address of the specifiedVkViewport.Bufferto thepViewports()field.intthe number of scissors and must match the number of viewports.scissorCount(int value) Sets the specified value to thescissorCount()field.set(int sType, long pNext, int flags, int viewportCount, @Nullable VkViewport.Buffer pViewports, int scissorCount, @Nullable VkRect2D.Buffer pScissors) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFOvalue to thesType()field.intthe number of viewports used by the pipeline.viewportCount(int value) Sets the specified value to theviewportCount()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
VIEWPORTCOUNT
public static final int VIEWPORTCOUNTThe struct member offsets. -
PVIEWPORTS
public static final int PVIEWPORTSThe struct member offsets. -
SCISSORCOUNT
public static final int SCISSORCOUNTThe struct member offsets. -
PSCISSORS
public static final int PSCISSORSThe struct member offsets.
-
-
Constructor Details
-
VkPipelineViewportStateCreateInfo
Creates aVkPipelineViewportStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkPipelineViewportStateCreateInfo>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
flags
public int flags()reserved for future use. -
viewportCount
public int viewportCount()the number of viewports used by the pipeline. -
pViewports
a pointer to an array ofVkViewportstructures, defining the viewport transforms. If the viewport state is dynamic, this member is ignored. -
scissorCount
public int scissorCount()the number of scissors and must match the number of viewports. -
pScissors
a pointer to an array ofVkRect2Dstructures defining the rectangular bounds of the scissor for the corresponding viewport. If the scissor state is dynamic, this member is ignored. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
public VkPipelineViewportStateCreateInfo pNext(VkPipelineViewportCoarseSampleOrderStateCreateInfoNV value) Prepends the specifiedVkPipelineViewportCoarseSampleOrderStateCreateInfoNVvalue to thepNextchain. -
pNext
public VkPipelineViewportStateCreateInfo pNext(VkPipelineViewportDepthClampControlCreateInfoEXT value) Prepends the specifiedVkPipelineViewportDepthClampControlCreateInfoEXTvalue to thepNextchain. -
pNext
public VkPipelineViewportStateCreateInfo pNext(VkPipelineViewportDepthClipControlCreateInfoEXT value) Prepends the specifiedVkPipelineViewportDepthClipControlCreateInfoEXTvalue to thepNextchain. -
pNext
public VkPipelineViewportStateCreateInfo pNext(VkPipelineViewportExclusiveScissorStateCreateInfoNV value) Prepends the specifiedVkPipelineViewportExclusiveScissorStateCreateInfoNVvalue to thepNextchain. -
pNext
public VkPipelineViewportStateCreateInfo pNext(VkPipelineViewportShadingRateImageStateCreateInfoNV value) Prepends the specifiedVkPipelineViewportShadingRateImageStateCreateInfoNVvalue to thepNextchain. -
pNext
Prepends the specifiedVkPipelineViewportSwizzleStateCreateInfoNVvalue to thepNextchain. -
pNext
Prepends the specifiedVkPipelineViewportWScalingStateCreateInfoNVvalue to thepNextchain. -
flags
Sets the specified value to theflags()field. -
viewportCount
Sets the specified value to theviewportCount()field. -
pViewports
Sets the address of the specifiedVkViewport.Bufferto thepViewports()field. -
scissorCount
Sets the specified value to thescissorCount()field. -
pScissors
Sets the address of the specifiedVkRect2D.Bufferto thepScissors()field. -
set
public VkPipelineViewportStateCreateInfo set(int sType, long pNext, int flags, int viewportCount, @Nullable VkViewport.Buffer pViewports, int scissorCount, @Nullable VkRect2D.Buffer pScissors) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkPipelineViewportStateCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkPipelineViewportStateCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkPipelineViewportStateCreateInfoinstance allocated withBufferUtils. -
create
Returns a newVkPipelineViewportStateCreateInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkPipelineViewportStateCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkPipelineViewportStateCreateInfo.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkPipelineViewportStateCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkPipelineViewportStateCreateInfo callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkPipelineViewportStateCreateInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkPipelineViewportStateCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPipelineViewportStateCreateInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkPipelineViewportStateCreateInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
nviewportCount
public static int nviewportCount(long struct) Unsafe version ofviewportCount(). -
npViewports
Unsafe version ofpViewports(). -
nscissorCount
public static int nscissorCount(long struct) Unsafe version ofscissorCount(). -
npScissors
Unsafe version ofpScissors(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags. -
nviewportCount
public static void nviewportCount(long struct, int value) Sets the specified value to theviewportCountfield of the specifiedstruct. -
npViewports
Unsafe version ofpViewports. -
nscissorCount
public static void nscissorCount(long struct, int value) Sets the specified value to thescissorCountfield of the specifiedstruct. -
npScissors
Unsafe version ofpScissors.
-