Open 3D Engine AzFramework API Reference 25.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | List of all members
AzFramework::DeviceAttributesSystemComponent Class Referencefinal

System component responsible for managing device attributes. More...

#include <DeviceAttributesSystemComponent.h>

Inherits AZ::Component, and AzFramework::DeviceAttributeRegistrarInterface.

Public Member Functions

 AZ_COMPONENT (DeviceAttributesSystemComponent, "{C5ACED7D-FE7B-43F4-9414-8B2CAB51F229}", AZ::Component)
 
void Activate () override
 
void Deactivate () override
 
DeviceAttribute * FindDeviceAttribute (AZStd::string_view deviceAttribute) const override
 Find a device attribute by name.
 
bool RegisterDeviceAttribute (AZStd::shared_ptr< DeviceAttribute > deviceAttribute) override
 Register a device attribute interface, deviceAttribute must have a unique name, returns true on success.
 
bool UnregisterDeviceAttribute (AZStd::string_view deviceAttribute) override
 Unregister an existing device attribute, returns true on success, false if not found.
 
void VisitDeviceAttributes (const VisitInterfaceCallback &) const override
 
- Public Member Functions inherited from AzFramework::DeviceAttributeRegistrarInterface
 AZ_RTTI (DeviceAttributeRegistrarInterface, "{D6B65DF8-8275-42F8-B84D-4F9ACBECC7C2}")
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &dependent)
 

Additional Inherited Members

- Public Types inherited from AzFramework::DeviceAttributeRegistrarInterface
using VisitInterfaceCallback = AZStd::function< bool(DeviceAttribute &)>
 The callback function should return true to continue enumaration or false to stop.
 

Detailed Description

System component responsible for managing device attributes.

Member Function Documentation

◆ FindDeviceAttribute()

DeviceAttribute * AzFramework::DeviceAttributesSystemComponent::FindDeviceAttribute ( AZStd::string_view  deviceAttribute) const
overridevirtual

Find a device attribute by name.

Implements AzFramework::DeviceAttributeRegistrarInterface.

◆ RegisterDeviceAttribute()

bool AzFramework::DeviceAttributesSystemComponent::RegisterDeviceAttribute ( AZStd::shared_ptr< DeviceAttribute >  deviceAttributeInterface)
overridevirtual

Register a device attribute interface, deviceAttribute must have a unique name, returns true on success.

Implements AzFramework::DeviceAttributeRegistrarInterface.

◆ UnregisterDeviceAttribute()

bool AzFramework::DeviceAttributesSystemComponent::UnregisterDeviceAttribute ( AZStd::string_view  deviceAttribute)
overridevirtual

Unregister an existing device attribute, returns true on success, false if not found.

Implements AzFramework::DeviceAttributeRegistrarInterface.

◆ VisitDeviceAttributes()

void AzFramework::DeviceAttributesSystemComponent::VisitDeviceAttributes ( const VisitInterfaceCallback &  ) const
overridevirtual

Visit device attribute interfaces with a callback function The visiting callback can be useful to enumerate over multiple attributes for display or rule evaluation.

Implements AzFramework::DeviceAttributeRegistrarInterface.

The documentation for this class was generated from the following file: