BsRendererManager.h 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. #pragma once
  2. #include "BsCorePrerequisites.h"
  3. #include "BsRendererFactory.h"
  4. #include "BsModule.h"
  5. namespace BansheeEngine
  6. {
  7. /**
  8. * @brief Allows you to change and retrieve the active renderer. Active renderer will
  9. * be used for rendering all objects in the following frame.
  10. *
  11. * @note No renderer is active by default. You must make a renderer active before doing any rendering.
  12. */
  13. class BS_CORE_EXPORT RendererManager : public Module<RendererManager>
  14. {
  15. public:
  16. /**
  17. * @brief Attempts to find a renderer with the specified name and makes it active.
  18. * Exception is thrown if renderer with the specified name doesn't exist.
  19. */
  20. void setActive(const String& name);
  21. /**
  22. * @brief Returns the currently active renderer. Null if no renderer is active.
  23. */
  24. RendererPtr getActive() { return mActiveRenderer; }
  25. /**
  26. * @brief Core renderer represents a set of shared features within all renderers.
  27. * Techniques using this renderer name will report as if they are supported regardless
  28. * of the active renderer.
  29. *
  30. * @note Useful when you want to make a technique working on all renderers. (Normally techniques
  31. * need to be different as far as render system is concerned but can often be same from
  32. * renderers perspective).
  33. *
  34. * @see Technique
  35. */
  36. static const String& getCoreRendererName();
  37. /**
  38. * @brief Registers a new renderer factory. Any renderer you try to make active with
  39. * "setActive" you will need to have previously registered here.
  40. *
  41. * @note Internal method.
  42. */
  43. void _registerFactory(RendererFactoryPtr factory);
  44. private:
  45. Vector<RendererFactoryPtr> mAvailableFactories;
  46. RendererPtr mActiveRenderer;
  47. };
  48. }