OpenXR.Extensions.XR_EXT_performance_settings

Name

XR_EXT_performance_settings - instance extension

Specification

See XR_EXT_performance_settings in the main specification for complete information.

Registered Extension Number

16

Revision

1

Extension and Version Dependencies

• Requires OpenXR 1.0

See Also

EventDataPerfSettingsEXT, PerfSettingsDomainEXT, PerfSettingsLevelEXT, PerfSettingsNotificationLevelEXT, PerfSettingsSubDomainEXT, perfSettingsSetPerformanceLevelEXT

Document Notes

For more information, see the OpenXR Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

perfSettingsSetPerformanceLevelEXT

Arguments

:: forall io. MonadIO io

=> Session

session is a valid Session handle.

-> PerfSettingsDomainEXT

domain: the processing domain for which the level hint is applied

-> PerfSettingsLevelEXT

level: the level hint to be applied

-> io Result

xrPerfSettingsSetPerformanceLevelEXT - xrPerfSettingsSetPerformanceLevelEXT

Valid Usage (Implicit)

• The @@ extension must be enabled prior to calling perfSettingsSetPerformanceLevelEXT

• session must be a valid Session handle
• domain must be a valid PerfSettingsDomainEXT value
• level must be a valid PerfSettingsLevelEXT value

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_SESSION_LOST
• ERROR_HANDLE_INVALID
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_FUNCTION_UNSUPPORTED

See Also

PerfSettingsDomainEXT, PerfSettingsLevelEXT, Session

data EventDataPerfSettingsEXT

XrEventDataPerfSettingsEXT - XrEventDataPerfSettingsEXT

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using EventDataPerfSettingsEXT

• type must be TYPE_EVENT_DATA_PERF_SETTINGS_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain
• domain must be a valid PerfSettingsDomainEXT value
• subDomain must be a valid PerfSettingsSubDomainEXT value
• fromLevel must be a valid PerfSettingsNotificationLevelEXT value
• toLevel must be a valid PerfSettingsNotificationLevelEXT value

See Also

PerfSettingsDomainEXT, PerfSettingsNotificationLevelEXT, PerfSettingsSubDomainEXT, StructureType

Constructors

EventDataPerfSettingsEXT

Fields

• domain :: PerfSettingsDomainEXT

  domain : processing domain in which a threshold has been crossed

• subDomain :: PerfSettingsSubDomainEXT

  subDomain : system area in which a threshold has been crossed

• fromLevel :: PerfSettingsNotificationLevelEXT

  fromLevel : enumerated notification level which has been exited

• toLevel :: PerfSettingsNotificationLevelEXT

  toLevel : enumerated notification level which has been entered

Instances

Eq EventDataPerfSettingsEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

(==) :: EventDataPerfSettingsEXT -> EventDataPerfSettingsEXT -> Bool

(/=) :: EventDataPerfSettingsEXT -> EventDataPerfSettingsEXT -> Bool

Show EventDataPerfSettingsEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

showsPrec :: Int -> EventDataPerfSettingsEXT -> ShowS

show :: EventDataPerfSettingsEXT -> String

showList :: [EventDataPerfSettingsEXT] -> ShowS

Storable EventDataPerfSettingsEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

sizeOf :: EventDataPerfSettingsEXT -> Int

alignment :: EventDataPerfSettingsEXT -> Int

peekElemOff :: Ptr EventDataPerfSettingsEXT -> Int -> IO EventDataPerfSettingsEXT

pokeElemOff :: Ptr EventDataPerfSettingsEXT -> Int -> EventDataPerfSettingsEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO EventDataPerfSettingsEXT

pokeByteOff :: Ptr b -> Int -> EventDataPerfSettingsEXT -> IO ()

peek :: Ptr EventDataPerfSettingsEXT -> IO EventDataPerfSettingsEXT

poke :: Ptr EventDataPerfSettingsEXT -> EventDataPerfSettingsEXT -> IO ()

Zero EventDataPerfSettingsEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

zero :: EventDataPerfSettingsEXT

ToCStruct EventDataPerfSettingsEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

withCStruct :: EventDataPerfSettingsEXT -> (Ptr EventDataPerfSettingsEXT -> IO b) -> IO b

pokeCStruct :: Ptr EventDataPerfSettingsEXT -> EventDataPerfSettingsEXT -> IO b -> IO b

withZeroCStruct :: (Ptr EventDataPerfSettingsEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr EventDataPerfSettingsEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct EventDataPerfSettingsEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

peekCStruct :: Ptr EventDataPerfSettingsEXT -> IO EventDataPerfSettingsEXT

IsEventData EventDataPerfSettingsEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

toEventDataBaseHeader :: EventDataPerfSettingsEXT -> EventDataBaseHeader

newtype PerfSettingsLevelEXT

XrPerfSettingsLevelEXT - XrPerfSettingsLevelEXT

See Also

perfSettingsSetPerformanceLevelEXT

Constructors

PerfSettingsLevelEXT Int32

Bundled Patterns

pattern PERF_SETTINGS_LEVEL_POWER_SAVINGS_EXT :: PerfSettingsLevelEXT

pattern PERF_SETTINGS_LEVEL_SUSTAINED_LOW_EXT :: PerfSettingsLevelEXT

pattern PERF_SETTINGS_LEVEL_SUSTAINED_HIGH_EXT :: PerfSettingsLevelEXT

pattern PERF_SETTINGS_LEVEL_BOOST_EXT :: PerfSettingsLevelEXT

Instances

Eq PerfSettingsLevelEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

(==) :: PerfSettingsLevelEXT -> PerfSettingsLevelEXT -> Bool

(/=) :: PerfSettingsLevelEXT -> PerfSettingsLevelEXT -> Bool

Ord PerfSettingsLevelEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

compare :: PerfSettingsLevelEXT -> PerfSettingsLevelEXT -> Ordering

(<) :: PerfSettingsLevelEXT -> PerfSettingsLevelEXT -> Bool

(<=) :: PerfSettingsLevelEXT -> PerfSettingsLevelEXT -> Bool

(>) :: PerfSettingsLevelEXT -> PerfSettingsLevelEXT -> Bool

(>=) :: PerfSettingsLevelEXT -> PerfSettingsLevelEXT -> Bool

max :: PerfSettingsLevelEXT -> PerfSettingsLevelEXT -> PerfSettingsLevelEXT

min :: PerfSettingsLevelEXT -> PerfSettingsLevelEXT -> PerfSettingsLevelEXT

Read PerfSettingsLevelEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

readsPrec :: Int -> ReadS PerfSettingsLevelEXT

readList :: ReadS [PerfSettingsLevelEXT]

readPrec :: ReadPrec PerfSettingsLevelEXT

readListPrec :: ReadPrec [PerfSettingsLevelEXT]

Show PerfSettingsLevelEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

showsPrec :: Int -> PerfSettingsLevelEXT -> ShowS

show :: PerfSettingsLevelEXT -> String

showList :: [PerfSettingsLevelEXT] -> ShowS

Storable PerfSettingsLevelEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

sizeOf :: PerfSettingsLevelEXT -> Int

alignment :: PerfSettingsLevelEXT -> Int

peekElemOff :: Ptr PerfSettingsLevelEXT -> Int -> IO PerfSettingsLevelEXT

pokeElemOff :: Ptr PerfSettingsLevelEXT -> Int -> PerfSettingsLevelEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PerfSettingsLevelEXT

pokeByteOff :: Ptr b -> Int -> PerfSettingsLevelEXT -> IO ()

peek :: Ptr PerfSettingsLevelEXT -> IO PerfSettingsLevelEXT

poke :: Ptr PerfSettingsLevelEXT -> PerfSettingsLevelEXT -> IO ()

Zero PerfSettingsLevelEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

zero :: PerfSettingsLevelEXT

newtype PerfSettingsDomainEXT

XrPerfSettingsDomainEXT - XrPerfSettingsDomainEXT

See Also

EventDataPerfSettingsEXT, perfSettingsSetPerformanceLevelEXT, thermalGetTemperatureTrendEXT

Constructors

PerfSettingsDomainEXT Int32

Bundled Patterns

pattern PERF_SETTINGS_DOMAIN_CPU_EXT :: PerfSettingsDomainEXT

pattern PERF_SETTINGS_DOMAIN_GPU_EXT :: PerfSettingsDomainEXT

Instances

Eq PerfSettingsDomainEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

(==) :: PerfSettingsDomainEXT -> PerfSettingsDomainEXT -> Bool

(/=) :: PerfSettingsDomainEXT -> PerfSettingsDomainEXT -> Bool

Ord PerfSettingsDomainEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

compare :: PerfSettingsDomainEXT -> PerfSettingsDomainEXT -> Ordering

(<) :: PerfSettingsDomainEXT -> PerfSettingsDomainEXT -> Bool

(<=) :: PerfSettingsDomainEXT -> PerfSettingsDomainEXT -> Bool

(>) :: PerfSettingsDomainEXT -> PerfSettingsDomainEXT -> Bool

(>=) :: PerfSettingsDomainEXT -> PerfSettingsDomainEXT -> Bool

max :: PerfSettingsDomainEXT -> PerfSettingsDomainEXT -> PerfSettingsDomainEXT

min :: PerfSettingsDomainEXT -> PerfSettingsDomainEXT -> PerfSettingsDomainEXT

Read PerfSettingsDomainEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

readsPrec :: Int -> ReadS PerfSettingsDomainEXT

readList :: ReadS [PerfSettingsDomainEXT]

readPrec :: ReadPrec PerfSettingsDomainEXT

readListPrec :: ReadPrec [PerfSettingsDomainEXT]

Show PerfSettingsDomainEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

showsPrec :: Int -> PerfSettingsDomainEXT -> ShowS

show :: PerfSettingsDomainEXT -> String

showList :: [PerfSettingsDomainEXT] -> ShowS

Storable PerfSettingsDomainEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

sizeOf :: PerfSettingsDomainEXT -> Int

alignment :: PerfSettingsDomainEXT -> Int

peekElemOff :: Ptr PerfSettingsDomainEXT -> Int -> IO PerfSettingsDomainEXT

pokeElemOff :: Ptr PerfSettingsDomainEXT -> Int -> PerfSettingsDomainEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PerfSettingsDomainEXT

pokeByteOff :: Ptr b -> Int -> PerfSettingsDomainEXT -> IO ()

peek :: Ptr PerfSettingsDomainEXT -> IO PerfSettingsDomainEXT

poke :: Ptr PerfSettingsDomainEXT -> PerfSettingsDomainEXT -> IO ()

Zero PerfSettingsDomainEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

zero :: PerfSettingsDomainEXT

newtype PerfSettingsSubDomainEXT

XrPerfSettingsSubDomainEXT - XrPerfSettingsSubDomainEXT

See Also

EventDataPerfSettingsEXT

Constructors

PerfSettingsSubDomainEXT Int32

Bundled Patterns

pattern PERF_SETTINGS_SUB_DOMAIN_COMPOSITING_EXT :: PerfSettingsSubDomainEXT

pattern PERF_SETTINGS_SUB_DOMAIN_RENDERING_EXT :: PerfSettingsSubDomainEXT

pattern PERF_SETTINGS_SUB_DOMAIN_THERMAL_EXT :: PerfSettingsSubDomainEXT

Instances

Eq PerfSettingsSubDomainEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

(==) :: PerfSettingsSubDomainEXT -> PerfSettingsSubDomainEXT -> Bool

(/=) :: PerfSettingsSubDomainEXT -> PerfSettingsSubDomainEXT -> Bool

Ord PerfSettingsSubDomainEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

compare :: PerfSettingsSubDomainEXT -> PerfSettingsSubDomainEXT -> Ordering

(<) :: PerfSettingsSubDomainEXT -> PerfSettingsSubDomainEXT -> Bool

(<=) :: PerfSettingsSubDomainEXT -> PerfSettingsSubDomainEXT -> Bool

(>) :: PerfSettingsSubDomainEXT -> PerfSettingsSubDomainEXT -> Bool

(>=) :: PerfSettingsSubDomainEXT -> PerfSettingsSubDomainEXT -> Bool

max :: PerfSettingsSubDomainEXT -> PerfSettingsSubDomainEXT -> PerfSettingsSubDomainEXT

min :: PerfSettingsSubDomainEXT -> PerfSettingsSubDomainEXT -> PerfSettingsSubDomainEXT

Read PerfSettingsSubDomainEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

readsPrec :: Int -> ReadS PerfSettingsSubDomainEXT

readList :: ReadS [PerfSettingsSubDomainEXT]

readPrec :: ReadPrec PerfSettingsSubDomainEXT

readListPrec :: ReadPrec [PerfSettingsSubDomainEXT]

Show PerfSettingsSubDomainEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

showsPrec :: Int -> PerfSettingsSubDomainEXT -> ShowS

show :: PerfSettingsSubDomainEXT -> String

showList :: [PerfSettingsSubDomainEXT] -> ShowS

Storable PerfSettingsSubDomainEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

sizeOf :: PerfSettingsSubDomainEXT -> Int

alignment :: PerfSettingsSubDomainEXT -> Int

peekElemOff :: Ptr PerfSettingsSubDomainEXT -> Int -> IO PerfSettingsSubDomainEXT

pokeElemOff :: Ptr PerfSettingsSubDomainEXT -> Int -> PerfSettingsSubDomainEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PerfSettingsSubDomainEXT

pokeByteOff :: Ptr b -> Int -> PerfSettingsSubDomainEXT -> IO ()

peek :: Ptr PerfSettingsSubDomainEXT -> IO PerfSettingsSubDomainEXT

poke :: Ptr PerfSettingsSubDomainEXT -> PerfSettingsSubDomainEXT -> IO ()

Zero PerfSettingsSubDomainEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

zero :: PerfSettingsSubDomainEXT

newtype PerfSettingsNotificationLevelEXT

XrPerfSettingsNotificationLevelEXT - XrPerfSettingsNotificationLevelEXT

See Also

EventDataPerfSettingsEXT, thermalGetTemperatureTrendEXT

Constructors

PerfSettingsNotificationLevelEXT Int32

Bundled Patterns

pattern PERF_SETTINGS_NOTIF_LEVEL_NORMAL_EXT :: PerfSettingsNotificationLevelEXT

pattern PERF_SETTINGS_NOTIF_LEVEL_WARNING_EXT :: PerfSettingsNotificationLevelEXT

pattern PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED_EXT :: PerfSettingsNotificationLevelEXT

Instances

Eq PerfSettingsNotificationLevelEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

(==) :: PerfSettingsNotificationLevelEXT -> PerfSettingsNotificationLevelEXT -> Bool

(/=) :: PerfSettingsNotificationLevelEXT -> PerfSettingsNotificationLevelEXT -> Bool

Ord PerfSettingsNotificationLevelEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

compare :: PerfSettingsNotificationLevelEXT -> PerfSettingsNotificationLevelEXT -> Ordering

(<) :: PerfSettingsNotificationLevelEXT -> PerfSettingsNotificationLevelEXT -> Bool

(<=) :: PerfSettingsNotificationLevelEXT -> PerfSettingsNotificationLevelEXT -> Bool

(>) :: PerfSettingsNotificationLevelEXT -> PerfSettingsNotificationLevelEXT -> Bool

(>=) :: PerfSettingsNotificationLevelEXT -> PerfSettingsNotificationLevelEXT -> Bool

max :: PerfSettingsNotificationLevelEXT -> PerfSettingsNotificationLevelEXT -> PerfSettingsNotificationLevelEXT

min :: PerfSettingsNotificationLevelEXT -> PerfSettingsNotificationLevelEXT -> PerfSettingsNotificationLevelEXT

Read PerfSettingsNotificationLevelEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

readsPrec :: Int -> ReadS PerfSettingsNotificationLevelEXT

readList :: ReadS [PerfSettingsNotificationLevelEXT]

readPrec :: ReadPrec PerfSettingsNotificationLevelEXT

readListPrec :: ReadPrec [PerfSettingsNotificationLevelEXT]

Show PerfSettingsNotificationLevelEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

showsPrec :: Int -> PerfSettingsNotificationLevelEXT -> ShowS

show :: PerfSettingsNotificationLevelEXT -> String

showList :: [PerfSettingsNotificationLevelEXT] -> ShowS

Storable PerfSettingsNotificationLevelEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

sizeOf :: PerfSettingsNotificationLevelEXT -> Int

alignment :: PerfSettingsNotificationLevelEXT -> Int

peekElemOff :: Ptr PerfSettingsNotificationLevelEXT -> Int -> IO PerfSettingsNotificationLevelEXT

pokeElemOff :: Ptr PerfSettingsNotificationLevelEXT -> Int -> PerfSettingsNotificationLevelEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PerfSettingsNotificationLevelEXT

pokeByteOff :: Ptr b -> Int -> PerfSettingsNotificationLevelEXT -> IO ()

peek :: Ptr PerfSettingsNotificationLevelEXT -> IO PerfSettingsNotificationLevelEXT

poke :: Ptr PerfSettingsNotificationLevelEXT -> PerfSettingsNotificationLevelEXT -> IO ()

Zero PerfSettingsNotificationLevelEXT

Defined in OpenXR.Extensions.XR_EXT_performance_settings

Methods

zero :: PerfSettingsNotificationLevelEXT

type EXT_performance_settings_SPEC_VERSION = 1

pattern EXT_performance_settings_SPEC_VERSION :: forall a. Integral a => a

type EXT_PERFORMANCE_SETTINGS_EXTENSION_NAME = "XR_EXT_performance_settings"

pattern EXT_PERFORMANCE_SETTINGS_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a