Interface of AuxGeom system, which is used for drawing Auxiliary Geometry, both for debug and things like editor manipulators. More...
#include <AuxGeomFeatureProcessorInterface.h>
Inherits AZ::RPI::FeatureProcessor.
Inherited by AZ::Render::AuxGeomFeatureProcessor.
Public Member Functions | |
| AZ_RTTI (AZ::RPI::AuxGeomFeatureProcessorInterface, "{2750EE44-5AE6-4379-BA3B-EDCD1507C997}", AZ::RPI::FeatureProcessor) | |
| AZ_DISABLE_COPY_MOVE (AuxGeomFeatureProcessorInterface) | |
| virtual AuxGeomDrawPtr | GetDrawQueue ()=0 |
| virtual AuxGeomDrawPtr | GetDrawQueueForView (const View *view)=0 |
| virtual AuxGeomDrawPtr | GetOrCreateDrawQueueForView (const View *view)=0 |
| Get existing or create a new AuxGeomDrawQueue object to store AuxGeom requests for this view. | |
| virtual void | ReleaseDrawQueueForView (const View *view)=0 |
| Feature processor releases the AuxGeomDrawQueue for the supplied view. DrawQueue is deleted when references fall to zero. | |
 Public Member Functions inherited from AZ::RPI::FeatureProcessor | |
| AZ_RTTI (FeatureProcessor, "{B8027170-C65C-4237-964D-B557FC9D7575}") | |
| AZ_CLASS_ALLOCATOR (FeatureProcessor, AZ::SystemAllocator) | |
| Scene * | GetParentScene () const |
| virtual void | Activate () |
| Perform any necessary activation and gives access to owning Scene. | |
| virtual void | Deactivate () |
| Perform any necessary deactivation. | |
| virtual void | ApplyRenderPipelineChange (RenderPipeline *pipeline) |
| virtual void | AddRenderPasses (RenderPipeline *pipeline) |
| virtual void | PrepareViews (const PrepareViewsPacket &, AZStd::vector< AZStd::pair< PipelineViewTag, ViewPtr > > &) |
| virtual void | Simulate (const SimulatePacket &) |
| virtual void | Render (const RenderPacket &) |
| virtual void | OnEndCulling (const RenderPacket &) |
| virtual void | OnRenderEnd () |
Static Public Member Functions | |
| static AuxGeomDrawPtr | GetDrawQueueForScene (const ScenePtr scenePtr) |
| static AuxGeomDrawPtr | GetDrawQueueForScene (const Scene *scene) |
Additional Inherited Members | |
| Protected Member Functions inherited from AZ::RPI::FeatureProcessor | |
| void | EnableSceneNotification () |
| void | DisableSceneNotification () |
Detailed Description
Interface of AuxGeom system, which is used for drawing Auxiliary Geometry, both for debug and things like editor manipulators.
Member Function Documentation
◆ GetDrawQueue()
|
pure virtual |
Get an AuxGeomDraw interface for drawing AuxGeom in the scene the FP is attached to. There is an inline static shortcut GetDrawQueueForScene above that avoids having to do the two steps of first getting the AuxGeomFeatureProcessorInterface pointer and then calling this function.
Implemented in AZ::Render::AuxGeomFeatureProcessor.
◆ GetDrawQueueForScene()
|
static |
Use this static helper to get the AuxGeom immediate draw interface for a given scene. Example usage:
auto defaultScene = AZ::RPI::RPISystemInterface::Get()->GetDefaultScene(); if (auto auxGeom = AuxGeomFeatureProcessorInterface::GetDrawQueueForScene(defaultScene)) { auxGeom->DrawPoint(drawArgs); auxGeom->DrawLine(drawArgs); }
◆ GetDrawQueueForView()
|
pure virtual |
Get the draw interface for drawing AuxGeom in immediate mode for the given view. Per view draw interfaces support 2d drawing.
Implemented in AZ::Render::AuxGeomFeatureProcessor.
◆ GetOrCreateDrawQueueForView()
|
pure virtual |
Get existing or create a new AuxGeomDrawQueue object to store AuxGeom requests for this view.
Implemented in AZ::Render::AuxGeomFeatureProcessor.
◆ ReleaseDrawQueueForView()
|
pure virtual |
Feature processor releases the AuxGeomDrawQueue for the supplied view. DrawQueue is deleted when references fall to zero.
Implemented in AZ::Render::AuxGeomFeatureProcessor.
The documentation for this class was generated from the following file:
- Gems/Atom/RPI/Code/Include/Atom/RPI.Public/AuxGeom/AuxGeomFeatureProcessorInterface.h
