Package org.lwjgl.vulkan
Class VkPipelineViewportStateCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPipelineViewportStateCreateInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkPipelineViewportStateCreateInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying parameters of a newly created pipeline viewport state.Valid Usage
- If the multiple viewports feature is not enabled,
viewportCountmust not be greater than 1 - If the multiple viewports feature 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 the graphics pipeline is being created without
DYNAMIC_STATE_VIEWPORT_WITH_COUNTandDYNAMIC_STATE_SCISSOR_WITH_COUNTset thenscissorCountandviewportCountmust be identical - If the graphics pipeline is being created with
DYNAMIC_STATE_VIEWPORT_WITH_COUNTset thenviewportCountmust be 0, otherwise it must be greater than 0 - If the graphics pipeline is being created with
DYNAMIC_STATE_SCISSOR_WITH_COUNTset thenscissorCountmust be 0, otherwise it must 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,VkPipelineViewportDepthClipControlCreateInfoEXT,VkPipelineViewportExclusiveScissorStateCreateInfoNV,VkPipelineViewportShadingRateImageStateCreateInfoNV,VkPipelineViewportSwizzleStateCreateInfoNV, orVkPipelineViewportWScalingStateCreateInfoNV - The
sTypevalue of each struct in thepNextchain must be unique flagsmust be 0
See Also
VkGraphicsPipelineCreateInfo,VkRect2D,VkViewportLayout
struct VkPipelineViewportStateCreateInfo { VkStructureTypesType(); void const *pNext(); VkPipelineViewportStateCreateFlagsflags(); uint32_tviewportCount();VkViewportconst *pViewports(); uint32_tscissorCount();VkRect2Dconst *pScissors(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkPipelineViewportStateCreateInfo.BufferAn array ofVkPipelineViewportStateCreateInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intFLAGS
PNEXT
PSCISSORS
PVIEWPORTS
SCISSORCOUNTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPE
VIEWPORTCOUNTThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPipelineViewportStateCreateInfo(java.nio.ByteBuffer container)Creates aVkPipelineViewportStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkPipelineViewportStateCreateInfocalloc()Returns a newVkPipelineViewportStateCreateInfoinstance allocated withmemCalloc.static VkPipelineViewportStateCreateInfo.Buffercalloc(int capacity)Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withmemCalloc.static VkPipelineViewportStateCreateInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineViewportStateCreateInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineViewportStateCreateInfocallocStack()Deprecated.static VkPipelineViewportStateCreateInfo.BuffercallocStack(int capacity)Deprecated.static VkPipelineViewportStateCreateInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineViewportStateCreateInfocallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineViewportStateCreateInfocreate()Returns a newVkPipelineViewportStateCreateInfoinstance allocated withBufferUtils.static VkPipelineViewportStateCreateInfo.Buffercreate(int capacity)Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withBufferUtils.static VkPipelineViewportStateCreateInfocreate(long address)Returns a newVkPipelineViewportStateCreateInfoinstance for the specified memory address.static VkPipelineViewportStateCreateInfo.Buffercreate(long address, int capacity)Create aVkPipelineViewportStateCreateInfo.Bufferinstance at the specified memory.static VkPipelineViewportStateCreateInfocreateSafe(long address)static VkPipelineViewportStateCreateInfo.BuffercreateSafe(long address, int capacity)intflags()reserved for future use.VkPipelineViewportStateCreateInfoflags(int value)Sets the specified value to theflags()field.static VkPipelineViewportStateCreateInfomalloc()Returns a newVkPipelineViewportStateCreateInfoinstance allocated withmemAlloc.static VkPipelineViewportStateCreateInfo.Buffermalloc(int capacity)Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withmemAlloc.static VkPipelineViewportStateCreateInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkPipelineViewportStateCreateInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the specifiedMemoryStack.static VkPipelineViewportStateCreateInfomallocStack()Deprecated.static VkPipelineViewportStateCreateInfo.BuffermallocStack(int capacity)Deprecated.static VkPipelineViewportStateCreateInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineViewportStateCreateInfomallocStack(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 VkRect2D.BuffernpScissors(long struct)Unsafe version ofpScissors().static voidnpScissors(long struct, VkRect2D.Buffer value)Unsafe version ofpScissors.static VkViewport.BuffernpViewports(long struct)Unsafe version ofpViewports().static voidnpViewports(long struct, 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.VkPipelineViewportStateCreateInfopNext(long value)Sets the specified value to thepNext()field.VkPipelineViewportStateCreateInfopNext(VkPipelineViewportCoarseSampleOrderStateCreateInfoNV value)Prepends the specifiedVkPipelineViewportCoarseSampleOrderStateCreateInfoNVvalue to thepNextchain.VkPipelineViewportStateCreateInfopNext(VkPipelineViewportDepthClipControlCreateInfoEXT value)Prepends the specifiedVkPipelineViewportDepthClipControlCreateInfoEXTvalue to thepNextchain.VkPipelineViewportStateCreateInfopNext(VkPipelineViewportExclusiveScissorStateCreateInfoNV value)Prepends the specifiedVkPipelineViewportExclusiveScissorStateCreateInfoNVvalue to thepNextchain.VkPipelineViewportStateCreateInfopNext(VkPipelineViewportShadingRateImageStateCreateInfoNV value)Prepends the specifiedVkPipelineViewportShadingRateImageStateCreateInfoNVvalue to thepNextchain.VkPipelineViewportStateCreateInfopNext(VkPipelineViewportSwizzleStateCreateInfoNV value)Prepends the specifiedVkPipelineViewportSwizzleStateCreateInfoNVvalue to thepNextchain.VkPipelineViewportStateCreateInfopNext(VkPipelineViewportWScalingStateCreateInfoNV value)Prepends the specifiedVkPipelineViewportWScalingStateCreateInfoNVvalue to thepNextchain.VkRect2D.BufferpScissors()a pointer to an array ofVkRect2Dstructures defining the rectangular bounds of the scissor for the corresponding viewport.VkPipelineViewportStateCreateInfopScissors(VkRect2D.Buffer value)Sets the address of the specifiedVkRect2D.Bufferto thepScissors()field.VkViewport.BufferpViewports()a pointer to an array ofVkViewportstructures, defining the viewport transforms.VkPipelineViewportStateCreateInfopViewports(VkViewport.Buffer value)Sets the address of the specifiedVkViewport.Bufferto thepViewports()field.intscissorCount()the number of scissors and must match the number of viewports.VkPipelineViewportStateCreateInfoscissorCount(int value)Sets the specified value to thescissorCount()field.VkPipelineViewportStateCreateInfoset(int sType, long pNext, int flags, int viewportCount, VkViewport.Buffer pViewports, int scissorCount, VkRect2D.Buffer pScissors)Initializes this struct with the specified values.VkPipelineViewportStateCreateInfoset(VkPipelineViewportStateCreateInfo src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkPipelineViewportStateCreateInfosType(int value)Sets the specified value to thesType()field.VkPipelineViewportStateCreateInfosType$Default()Sets theSTRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFOvalue to thesType()field.intviewportCount()the number of viewports used by the pipeline.VkPipelineViewportStateCreateInfoviewportCount(int value)Sets the specified value to theviewportCount()field.
-
-
-
Constructor Detail
-
VkPipelineViewportStateCreateInfo
public VkPipelineViewportStateCreateInfo(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of 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
@Nullable public VkViewport.Buffer 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
@Nullable public VkRect2D.Buffer 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
public VkPipelineViewportStateCreateInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkPipelineViewportStateCreateInfo sType$Default()
Sets theSTRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFOvalue to thesType()field.
-
pNext
public VkPipelineViewportStateCreateInfo pNext(long value)
Sets the specified value to thepNext()field.
-
pNext
public VkPipelineViewportStateCreateInfo pNext(VkPipelineViewportCoarseSampleOrderStateCreateInfoNV value)
Prepends the specifiedVkPipelineViewportCoarseSampleOrderStateCreateInfoNVvalue 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
public VkPipelineViewportStateCreateInfo pNext(VkPipelineViewportSwizzleStateCreateInfoNV value)
Prepends the specifiedVkPipelineViewportSwizzleStateCreateInfoNVvalue to thepNextchain.
-
pNext
public VkPipelineViewportStateCreateInfo pNext(VkPipelineViewportWScalingStateCreateInfoNV value)
Prepends the specifiedVkPipelineViewportWScalingStateCreateInfoNVvalue to thepNextchain.
-
flags
public VkPipelineViewportStateCreateInfo flags(int value)
Sets the specified value to theflags()field.
-
viewportCount
public VkPipelineViewportStateCreateInfo viewportCount(int value)
Sets the specified value to theviewportCount()field.
-
pViewports
public VkPipelineViewportStateCreateInfo pViewports(@Nullable VkViewport.Buffer value)
Sets the address of the specifiedVkViewport.Bufferto thepViewports()field.
-
scissorCount
public VkPipelineViewportStateCreateInfo scissorCount(int value)
Sets the specified value to thescissorCount()field.
-
pScissors
public VkPipelineViewportStateCreateInfo pScissors(@Nullable VkRect2D.Buffer value)
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
public VkPipelineViewportStateCreateInfo set(VkPipelineViewportStateCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkPipelineViewportStateCreateInfo malloc()
Returns a newVkPipelineViewportStateCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPipelineViewportStateCreateInfo calloc()
Returns a newVkPipelineViewportStateCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPipelineViewportStateCreateInfo create()
Returns a newVkPipelineViewportStateCreateInfoinstance allocated withBufferUtils.
-
create
public static VkPipelineViewportStateCreateInfo create(long address)
Returns a newVkPipelineViewportStateCreateInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkPipelineViewportStateCreateInfo createSafe(long address)
-
malloc
public static VkPipelineViewportStateCreateInfo.Buffer malloc(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPipelineViewportStateCreateInfo.Buffer calloc(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineViewportStateCreateInfo.Buffer create(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineViewportStateCreateInfo.Buffer create(long address, int capacity)
Create aVkPipelineViewportStateCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkPipelineViewportStateCreateInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkPipelineViewportStateCreateInfo mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkPipelineViewportStateCreateInfo 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 public static VkPipelineViewportStateCreateInfo.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkPipelineViewportStateCreateInfo.Buffer callocStack(int capacity)
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
public static VkPipelineViewportStateCreateInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkPipelineViewportStateCreateInfo calloc(org.lwjgl.system.MemoryStack stack)
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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
@Nullable public static VkViewport.Buffer npViewports(long struct)
Unsafe version ofpViewports().
-
nscissorCount
public static int nscissorCount(long struct)
Unsafe version ofscissorCount().
-
npScissors
@Nullable public static VkRect2D.Buffer npScissors(long struct)
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
public static void npViewports(long struct, @Nullable VkViewport.Buffer value)Unsafe version ofpViewports.
-
nscissorCount
public static void nscissorCount(long struct, int value)Sets the specified value to thescissorCountfield of the specifiedstruct.
-
npScissors
public static void npScissors(long struct, @Nullable VkRect2D.Buffer value)Unsafe version ofpScissors.
-
-