Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_EXT_pipeline_creation_feedback

Synopsis

data PipelineCreationFeedbackEXT = PipelineCreationFeedbackEXT {
- flags :: PipelineCreationFeedbackFlagsEXT
- duration :: Word64
}
data PipelineCreationFeedbackCreateInfoEXT = PipelineCreationFeedbackCreateInfoEXT {
}
newtype PipelineCreationFeedbackFlagBitsEXT where
type PipelineCreationFeedbackFlagsEXT = PipelineCreationFeedbackFlagBitsEXT
type EXT_PIPELINE_CREATION_FEEDBACK_SPEC_VERSION = 1
pattern EXT_PIPELINE_CREATION_FEEDBACK_SPEC_VERSION :: forall a. Integral a => a
type EXT_PIPELINE_CREATION_FEEDBACK_EXTENSION_NAME = "VK_EXT_pipeline_creation_feedback"
pattern EXT_PIPELINE_CREATION_FEEDBACK_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

data PipelineCreationFeedbackEXT Source #

VkPipelineCreationFeedbackEXT - Feedback about the creation of a pipeline or pipeline stage

Description

If the PIPELINE_CREATION_FEEDBACK_VALID_BIT_EXT is not set in flags, an implementation must not set any other bits in flags, and the values of all other PipelineCreationFeedbackEXT data members are undefined.

Description

An implementation should write pipeline creation feedback to pPipelineCreationFeedback and may write pipeline stage creation feedback to pPipelineStageCreationFeedbacks. An implementation must set or clear the PIPELINE_CREATION_FEEDBACK_VALID_BIT_EXT in PipelineCreationFeedbackEXT::flags for pPipelineCreationFeedback and every element of pPipelineStageCreationFeedbacks.

Note

One common scenario for an implementation to skip per-stage feedback is when PIPELINE_CREATION_FEEDBACK_APPLICATION_PIPELINE_CACHE_HIT_BIT_EXT is set in pPipelineCreationFeedback.

When chained to RayTracingPipelineCreateInfoKHR, RayTracingPipelineCreateInfoNV, or GraphicsPipelineCreateInfo, the i element of pPipelineStageCreationFeedbacks corresponds to the i element of RayTracingPipelineCreateInfoKHR::pStages, RayTracingPipelineCreateInfoNV::pStages, or GraphicsPipelineCreateInfo::pStages. When chained to ComputePipelineCreateInfo, the first element of pPipelineStageCreationFeedbacks corresponds to ComputePipelineCreateInfo::stage.

Valid Usage

When chained to GraphicsPipelineCreateInfo, PipelineCreationFeedbackEXT::pipelineStageCreationFeedbackCount must equal GraphicsPipelineCreateInfo::stageCount

When chained to ComputePipelineCreateInfo, PipelineCreationFeedbackEXT::pipelineStageCreationFeedbackCount must equal 1
When chained to RayTracingPipelineCreateInfoKHR, PipelineCreationFeedbackEXT::pipelineStageCreationFeedbackCount must equal RayTracingPipelineCreateInfoKHR::stageCount
When chained to RayTracingPipelineCreateInfoNV, PipelineCreationFeedbackEXT::pipelineStageCreationFeedbackCount must equal RayTracingPipelineCreateInfoNV::stageCount

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_PIPELINE_CREATION_FEEDBACK_CREATE_INFO_EXT

pPipelineCreationFeedback must be a valid pointer to a PipelineCreationFeedbackEXT structure
pPipelineStageCreationFeedbacks must be a valid pointer to an array of pipelineStageCreationFeedbackCount PipelineCreationFeedbackEXT structures
pipelineStageCreationFeedbackCount must be greater than 0

pipelineCreationFeedback :: Ptr PipelineCreationFeedbackEXT
pPipelineCreationFeedback is a pointer to a PipelineCreationFeedbackEXT structure.
pipelineStageCreationFeedbackCount :: Word32
pipelineStageCreationFeedbackCount is the number of elements in pPipelineStageCreationFeedbacks.
pipelineStageCreationFeedbacks :: Ptr PipelineCreationFeedbackEXT
pPipelineStageCreationFeedbacks is a pointer to an array of pipelineStageCreationFeedbackCount PipelineCreationFeedbackEXT structures.

Instances

Instances details

Eq PipelineCreationFeedbackCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods (==) :: PipelineCreationFeedbackCreateInfoEXT -> PipelineCreationFeedbackCreateInfoEXT -> Bool # (/=) :: PipelineCreationFeedbackCreateInfoEXT -> PipelineCreationFeedbackCreateInfoEXT -> Bool #
Show PipelineCreationFeedbackCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods showsPrec :: Int -> PipelineCreationFeedbackCreateInfoEXT -> ShowS # show :: PipelineCreationFeedbackCreateInfoEXT -> String # showList :: [PipelineCreationFeedbackCreateInfoEXT] -> ShowS #
Generic PipelineCreationFeedbackCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Associated Types type Rep PipelineCreationFeedbackCreateInfoEXT :: Type -> Type # Methods from :: PipelineCreationFeedbackCreateInfoEXT -> Rep PipelineCreationFeedbackCreateInfoEXT x # to :: Rep PipelineCreationFeedbackCreateInfoEXT x -> PipelineCreationFeedbackCreateInfoEXT #
Storable PipelineCreationFeedbackCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods sizeOf :: PipelineCreationFeedbackCreateInfoEXT -> Int # alignment :: PipelineCreationFeedbackCreateInfoEXT -> Int # peekElemOff :: Ptr PipelineCreationFeedbackCreateInfoEXT -> Int -> IO PipelineCreationFeedbackCreateInfoEXT # pokeElemOff :: Ptr PipelineCreationFeedbackCreateInfoEXT -> Int -> PipelineCreationFeedbackCreateInfoEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO PipelineCreationFeedbackCreateInfoEXT # pokeByteOff :: Ptr b -> Int -> PipelineCreationFeedbackCreateInfoEXT -> IO () # peek :: Ptr PipelineCreationFeedbackCreateInfoEXT -> IO PipelineCreationFeedbackCreateInfoEXT # poke :: Ptr PipelineCreationFeedbackCreateInfoEXT -> PipelineCreationFeedbackCreateInfoEXT -> IO () #
FromCStruct PipelineCreationFeedbackCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods peekCStruct :: Ptr PipelineCreationFeedbackCreateInfoEXT -> IO PipelineCreationFeedbackCreateInfoEXT Source #
ToCStruct PipelineCreationFeedbackCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods withCStruct :: PipelineCreationFeedbackCreateInfoEXT -> (Ptr PipelineCreationFeedbackCreateInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PipelineCreationFeedbackCreateInfoEXT -> PipelineCreationFeedbackCreateInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PipelineCreationFeedbackCreateInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PipelineCreationFeedbackCreateInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PipelineCreationFeedbackCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods zero :: PipelineCreationFeedbackCreateInfoEXT Source #
type Rep PipelineCreationFeedbackCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback type Rep PipelineCreationFeedbackCreateInfoEXT = D1 ('MetaData "PipelineCreationFeedbackCreateInfoEXT" "Vulkan.Extensions.VK_EXT_pipeline_creation_feedback" "vulkan-3.6.3-inplace" 'False) (C1 ('MetaCons "PipelineCreationFeedbackCreateInfoEXT" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineCreationFeedback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr PipelineCreationFeedbackEXT)) :: (S1 ('MetaSel ('Just "pipelineStageCreationFeedbackCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :: S1 ('MetaSel ('Just "pipelineStageCreationFeedbacks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr PipelineCreationFeedbackEXT)))))

newtype PipelineCreationFeedbackFlagBitsEXT Source #

VkPipelineCreationFeedbackFlagBitsEXT - Bitmask specifying pipeline or pipeline stage creation feedback

An implementation should set the PIPELINE_CREATION_FEEDBACK_APPLICATION_PIPELINE_CACHE_HIT_BIT_EXT bit if it was able to avoid the large majority of pipeline or pipeline stage creation work by using the pipelineCache parameter of createGraphicsPipelines, createRayTracingPipelinesKHR, createRayTracingPipelinesNV, or createComputePipelines. When an implementation sets this bit for the entire pipeline, it may leave it unset for any stage.

Note

Implementations are encouraged to provide a meaningful signal to applications using this bit. The intention is to communicate to the application that the pipeline or pipeline stage was created "as fast as it gets" using the pipeline cache provided by the application. If an implementation uses an internal cache, it is discouraged from setting this bit as the feedback would be unactionable.

pattern PIPELINE_CREATION_FEEDBACK_BASE_PIPELINE_ACCELERATION_BIT_EXT :: PipelineCreationFeedbackFlagBitsEXT

PIPELINE_CREATION_FEEDBACK_BASE_PIPELINE_ACCELERATION_BIT_EXT indicates that the base pipeline specified by the basePipelineHandle or basePipelineIndex member of the Vk*PipelineCreateInfo structure was used to accelerate the creation of the pipeline.

An implementation should set the PIPELINE_CREATION_FEEDBACK_BASE_PIPELINE_ACCELERATION_BIT_EXT bit if it was able to avoid a significant amount of work by using the base pipeline.

Note

While "significant amount of work" is subjective, implementations are encouraged to provide a meaningful signal to applications using this bit. For example, a 1% reduction in duration may not warrant setting this bit, while a 50% reduction would.

Instances

Instances details

Eq PipelineCreationFeedbackFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods (==) :: PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT -> Bool # (/=) :: PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT -> Bool #
Ord PipelineCreationFeedbackFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods compare :: PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT -> Ordering # (<) :: PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT -> Bool # (<=) :: PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT -> Bool # (>) :: PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT -> Bool # (>=) :: PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT -> Bool # max :: PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT # min :: PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT #
Read PipelineCreationFeedbackFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods readsPrec :: Int -> ReadS PipelineCreationFeedbackFlagBitsEXT # readList :: ReadS [PipelineCreationFeedbackFlagBitsEXT] # readPrec :: ReadPrec PipelineCreationFeedbackFlagBitsEXT # readListPrec :: ReadPrec [PipelineCreationFeedbackFlagBitsEXT] #
Show PipelineCreationFeedbackFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods showsPrec :: Int -> PipelineCreationFeedbackFlagBitsEXT -> ShowS # show :: PipelineCreationFeedbackFlagBitsEXT -> String # showList :: [PipelineCreationFeedbackFlagBitsEXT] -> ShowS #
Storable PipelineCreationFeedbackFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods sizeOf :: PipelineCreationFeedbackFlagBitsEXT -> Int # alignment :: PipelineCreationFeedbackFlagBitsEXT -> Int # peekElemOff :: Ptr PipelineCreationFeedbackFlagBitsEXT -> Int -> IO PipelineCreationFeedbackFlagBitsEXT # pokeElemOff :: Ptr PipelineCreationFeedbackFlagBitsEXT -> Int -> PipelineCreationFeedbackFlagBitsEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO PipelineCreationFeedbackFlagBitsEXT # pokeByteOff :: Ptr b -> Int -> PipelineCreationFeedbackFlagBitsEXT -> IO () # peek :: Ptr PipelineCreationFeedbackFlagBitsEXT -> IO PipelineCreationFeedbackFlagBitsEXT # poke :: Ptr PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT -> IO () #
Bits PipelineCreationFeedbackFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods (.&.) :: PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT # (.\|.) :: PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT # xor :: PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT # complement :: PipelineCreationFeedbackFlagBitsEXT -> PipelineCreationFeedbackFlagBitsEXT # shift :: PipelineCreationFeedbackFlagBitsEXT -> Int -> PipelineCreationFeedbackFlagBitsEXT # rotate :: PipelineCreationFeedbackFlagBitsEXT -> Int -> PipelineCreationFeedbackFlagBitsEXT # zeroBits :: PipelineCreationFeedbackFlagBitsEXT # bit :: Int -> PipelineCreationFeedbackFlagBitsEXT # setBit :: PipelineCreationFeedbackFlagBitsEXT -> Int -> PipelineCreationFeedbackFlagBitsEXT # clearBit :: PipelineCreationFeedbackFlagBitsEXT -> Int -> PipelineCreationFeedbackFlagBitsEXT # complementBit :: PipelineCreationFeedbackFlagBitsEXT -> Int -> PipelineCreationFeedbackFlagBitsEXT # testBit :: PipelineCreationFeedbackFlagBitsEXT -> Int -> Bool # bitSizeMaybe :: PipelineCreationFeedbackFlagBitsEXT -> Maybe Int # bitSize :: PipelineCreationFeedbackFlagBitsEXT -> Int # isSigned :: PipelineCreationFeedbackFlagBitsEXT -> Bool # shiftL :: PipelineCreationFeedbackFlagBitsEXT -> Int -> PipelineCreationFeedbackFlagBitsEXT # unsafeShiftL :: PipelineCreationFeedbackFlagBitsEXT -> Int -> PipelineCreationFeedbackFlagBitsEXT # shiftR :: PipelineCreationFeedbackFlagBitsEXT -> Int -> PipelineCreationFeedbackFlagBitsEXT # unsafeShiftR :: PipelineCreationFeedbackFlagBitsEXT -> Int -> PipelineCreationFeedbackFlagBitsEXT # rotateL :: PipelineCreationFeedbackFlagBitsEXT -> Int -> PipelineCreationFeedbackFlagBitsEXT # rotateR :: PipelineCreationFeedbackFlagBitsEXT -> Int -> PipelineCreationFeedbackFlagBitsEXT # popCount :: PipelineCreationFeedbackFlagBitsEXT -> Int #
Zero PipelineCreationFeedbackFlagBitsEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods zero :: PipelineCreationFeedbackFlagBitsEXT Source #

type PipelineCreationFeedbackFlagsEXT = PipelineCreationFeedbackFlagBitsEXT Source #

type EXT_PIPELINE_CREATION_FEEDBACK_SPEC_VERSION = 1 Source #

pattern EXT_PIPELINE_CREATION_FEEDBACK_SPEC_VERSION :: forall a. Integral a => a Source #

type EXT_PIPELINE_CREATION_FEEDBACK_EXTENSION_NAME = "VK_EXT_pipeline_creation_feedback" Source #

pattern EXT_PIPELINE_CREATION_FEEDBACK_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #

Eq PipelineCreationFeedbackEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods (==) :: PipelineCreationFeedbackEXT -> PipelineCreationFeedbackEXT -> Bool # (/=) :: PipelineCreationFeedbackEXT -> PipelineCreationFeedbackEXT -> Bool #
Show PipelineCreationFeedbackEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods showsPrec :: Int -> PipelineCreationFeedbackEXT -> ShowS # show :: PipelineCreationFeedbackEXT -> String # showList :: [PipelineCreationFeedbackEXT] -> ShowS #
Generic PipelineCreationFeedbackEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Associated Types type Rep PipelineCreationFeedbackEXT :: Type -> Type # Methods from :: PipelineCreationFeedbackEXT -> Rep PipelineCreationFeedbackEXT x # to :: Rep PipelineCreationFeedbackEXT x -> PipelineCreationFeedbackEXT #
Storable PipelineCreationFeedbackEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods sizeOf :: PipelineCreationFeedbackEXT -> Int # alignment :: PipelineCreationFeedbackEXT -> Int # peekElemOff :: Ptr PipelineCreationFeedbackEXT -> Int -> IO PipelineCreationFeedbackEXT # pokeElemOff :: Ptr PipelineCreationFeedbackEXT -> Int -> PipelineCreationFeedbackEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO PipelineCreationFeedbackEXT # pokeByteOff :: Ptr b -> Int -> PipelineCreationFeedbackEXT -> IO () # peek :: Ptr PipelineCreationFeedbackEXT -> IO PipelineCreationFeedbackEXT # poke :: Ptr PipelineCreationFeedbackEXT -> PipelineCreationFeedbackEXT -> IO () #
FromCStruct PipelineCreationFeedbackEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods peekCStruct :: Ptr PipelineCreationFeedbackEXT -> IO PipelineCreationFeedbackEXT Source #
ToCStruct PipelineCreationFeedbackEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods withCStruct :: PipelineCreationFeedbackEXT -> (Ptr PipelineCreationFeedbackEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PipelineCreationFeedbackEXT -> PipelineCreationFeedbackEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PipelineCreationFeedbackEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PipelineCreationFeedbackEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PipelineCreationFeedbackEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback Methods zero :: PipelineCreationFeedbackEXT Source #
type Rep PipelineCreationFeedbackEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_pipeline_creation_feedback type Rep PipelineCreationFeedbackEXT = D1 ('MetaData "PipelineCreationFeedbackEXT" "Vulkan.Extensions.VK_EXT_pipeline_creation_feedback" "vulkan-3.6.3-inplace" 'False) (C1 ('MetaCons "PipelineCreationFeedbackEXT" 'PrefixI 'True) (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PipelineCreationFeedbackFlagsEXT) :*: S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word64)))

Documentation

Description

See Also

Instances

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

See Also

Instances

PipelineCreationFeedbackEXT
Fields flags :: PipelineCreationFeedbackFlagsEXT `flags` is a bitmask of `PipelineCreationFeedbackFlagBitsEXT` providing feedback about the creation of a pipeline or of a pipeline stage. duration :: Word64 `duration` is the duration spent creating a pipeline or pipeline stage in nanoseconds.