.. index:: pair: class; EE::Graphics::ResourceScope
.. _doxid-class_e_e_1_1_graphics_1_1_resource_scope:

class EE::Graphics::ResourceScope
=================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

:ref:`Graphics <doxid-namespace_e_e_1_1_graphics>` resource lookup boundary with local ownership and explicit catalog visibility. :ref:`More...<details-class_e_e_1_1_graphics_1_1_resource_scope>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <resourcescope.hpp>
	
	class ResourceScope {
	public:
		// construction
	
		:target:`~ResourceScope<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1ae08316f5b4035eec8c98a3a356ab0f65>`();

		// methods
	
		static :ref:`ResourceScopePtr<doxid-namespace_e_e_1_1_graphics_1abf95f9d727dbaae1d6660d8b5c1082e7>` :target:`New<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a7ef4dbda61ba1f19d1d724b4efd22792>`();
		:ref:`FontService<doxid-class_e_e_1_1_graphics_1_1_font_service>`& :target:`getFontService<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a80d4a4fe750dfc8e540137da8dd7d963>`();
		const :ref:`FontService<doxid-class_e_e_1_1_graphics_1_1_font_service>`& :target:`getFontService<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a00f393395a29dc653db69dd48345b5f4>`() const;
		:ref:`TexturePtr<doxid-namespace_e_e_1_1_graphics_1a1b0289aa7a715a456098fe54cf5dc391>` :target:`findTexture<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1ac35b8328e9f144703cb1bb787f88c5e4>`(const :ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>`& key) const;
		:ref:`TexturePtr<doxid-namespace_e_e_1_1_graphics_1a1b0289aa7a715a456098fe54cf5dc391>` :target:`findTexture<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1ae02d1dbac807ea381a168e8837c619b2>`(const std::string& key) const;
		:ref:`DrawablePtr<doxid-namespace_e_e_1_1_graphics_1ad265841917d951291169b78d88f1678c>` :target:`findDrawableSource<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a812473d7163bb1a6e3c0e01097d173d7>`(const :ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>`& key) const;
		:ref:`DrawablePtr<doxid-namespace_e_e_1_1_graphics_1ad265841917d951291169b78d88f1678c>` :target:`findDrawableSource<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1aa9ad1ebf37e1c07786136b0d98654a20>`(const std::string& key) const;
		:ref:`DrawablePtr<doxid-namespace_e_e_1_1_graphics_1ad265841917d951291169b78d88f1678c>` :target:`findDrawable<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1ac0d55e58e7280b75e0cf8646fab16ffc>`(const std::string& name, bool firstSearchSprite = false) const;
		:ref:`DrawablePtr<doxid-namespace_e_e_1_1_graphics_1ad265841917d951291169b78d88f1678c>` :target:`findDrawable<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a2ba9dff87610c4ba0ad6d0c0d970cef0>`(:ref:`ResourceNameHash<doxid-class_e_e_1_1_graphics_1_1_resource_name_hash>` hash) const;
		:ref:`DrawablePtr<doxid-namespace_e_e_1_1_graphics_1ad265841917d951291169b78d88f1678c>` :target:`findDrawable<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a0e74764282012c935e44f51775e88844>`(:ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>` legacyHash) const;
		:ref:`TextureAtlasPtr<doxid-namespace_e_e_1_1_graphics_1ab1fe420e56b5b8efb4f71aea6820f473>` :target:`findAtlas<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1af731c4fa8d3676415ae5f5aa6b929dec>`(const :ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>`& key) const;
		:ref:`TextureAtlasPtr<doxid-namespace_e_e_1_1_graphics_1ab1fe420e56b5b8efb4f71aea6820f473>` :target:`findAtlas<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1acd8f4f63a4f44f3fdf62770a7c58ea60>`(const std::string& key) const;
		std::vector<:ref:`TextureAtlasPtr<doxid-namespace_e_e_1_1_graphics_1ab1fe420e56b5b8efb4f71aea6820f473>`> :target:`getAtlases<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1ab9472457073ecd5d47fd6ae6f1ae5e15>`() const;
		:ref:`FontPtr<doxid-namespace_e_e_1_1_graphics_1a204d963a20d37023d8db99da16b2f4f5>` :target:`findFont<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a18bbc5af8e45b7778b79787719eb3ff9>`(const :ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>`& key) const;
		:ref:`FontPtr<doxid-namespace_e_e_1_1_graphics_1a204d963a20d37023d8db99da16b2f4f5>` :target:`findFont<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1ab70c7e4f5bf937d5cf7773c53a71edb0>`(const std::string& key) const;
		:ref:`FontPtr<doxid-namespace_e_e_1_1_graphics_1a204d963a20d37023d8db99da16b2f4f5>` :target:`findFont<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1af1d2d25f2dc45ca48a4872e75c248ee3>`(:ref:`ResourceNameHash<doxid-class_e_e_1_1_graphics_1_1_resource_name_hash>` hash) const;
		std::vector<:ref:`FontPtr<doxid-namespace_e_e_1_1_graphics_1a204d963a20d37023d8db99da16b2f4f5>`> :target:`getFonts<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1aa39b60d68fd716f06db092e9cad112ce>`() const;
		:ref:`ShaderProgramPtr<doxid-namespace_e_e_1_1_graphics_1a974528b0f54def40d3485bad4c32c62c>` :target:`findShaderProgram<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1aabd77fd1104940fcef0b6fba1dd0fcc1>`(const :ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>`& key) const;
		:ref:`ShaderProgramPtr<doxid-namespace_e_e_1_1_graphics_1a974528b0f54def40d3485bad4c32c62c>` :target:`findShaderProgram<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1af4d8171912c8f7c44cafbf15f9636654>`(const std::string& key) const;
		std::vector<:ref:`ShaderProgramPtr<doxid-namespace_e_e_1_1_graphics_1a974528b0f54def40d3485bad4c32c62c>`> :target:`getShaderPrograms<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a4c2be288d2c111d50aa056c48d19c385>`() const;
		std::vector<:ref:`TextureRegionPtr<doxid-namespace_e_e_1_1_graphics_1a7560041bb40bd712e1aa4945787f920e>`> :target:`findTextureRegionsByPattern<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a54eba7a7ad33dcc6b0a5893091f9fb6d>`(const std::string& name, const std::string& extension = "", :ref:`TextureAtlas<doxid-class_e_e_1_1_graphics_1_1_texture_atlas>`* searchInTextureAtlas = nullptr) const;
		std::vector<:ref:`TextureRegionPtr<doxid-namespace_e_e_1_1_graphics_1a7560041bb40bd712e1aa4945787f920e>`> :target:`findTextureRegionsByPatternId<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a90b1db0ea0ca5b4eed084fa32fc33ae4>`(const :ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>`& id, const std::string& extension = "", :ref:`TextureAtlas<doxid-class_e_e_1_1_graphics_1_1_texture_atlas>`* searchInTextureAtlas = nullptr) const;
		void :target:`publishLocal<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1abfe4faccbab53a17d88fd2df7a7b6259>`(:ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>` key, :ref:`TexturePtr<doxid-namespace_e_e_1_1_graphics_1a1b0289aa7a715a456098fe54cf5dc391>` texture);
		void :target:`publishLocal<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a4630613dad6bde7dd647c86df49ffe1f>`(std::string key, :ref:`TexturePtr<doxid-namespace_e_e_1_1_graphics_1a1b0289aa7a715a456098fe54cf5dc391>` texture);
		void :target:`publishLocalDrawable<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1aaaae946c18ee554047bc711b2d138d04>`(:ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>` key, :ref:`DrawablePtr<doxid-namespace_e_e_1_1_graphics_1ad265841917d951291169b78d88f1678c>` drawable);
		void :target:`publishLocalDrawable<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1abd68e905312e727989de9703165f001b>`(std::string key, :ref:`DrawablePtr<doxid-namespace_e_e_1_1_graphics_1ad265841917d951291169b78d88f1678c>` drawable);
		void :target:`publishLocalAtlas<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1ab1040de111030e92766bd6074f4a3a28>`(:ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>` key, :ref:`TextureAtlasPtr<doxid-namespace_e_e_1_1_graphics_1ab1fe420e56b5b8efb4f71aea6820f473>` atlas);
		void :target:`publishLocalAtlas<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a2bd36f8262d8396db6d74bdf4e142a25>`(std::string key, :ref:`TextureAtlasPtr<doxid-namespace_e_e_1_1_graphics_1ab1fe420e56b5b8efb4f71aea6820f473>` atlas);
		void :ref:`publishLocalFont<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a88a889d7e397cfd27c59abe674a59159>`(:ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>` key, :ref:`FontPtr<doxid-namespace_e_e_1_1_graphics_1a204d963a20d37023d8db99da16b2f4f5>` font);
		void :target:`publishLocalFont<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a4ab99e3cffd69d2f4aaa3be3cb878f55>`(std::string key, :ref:`FontPtr<doxid-namespace_e_e_1_1_graphics_1a204d963a20d37023d8db99da16b2f4f5>` font);
		void :target:`publishLocalShaderProgram<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1ad750940ccd2d31e8f34f13528db6bf43>`(:ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>` key, :ref:`ShaderProgramPtr<doxid-namespace_e_e_1_1_graphics_1a974528b0f54def40d3485bad4c32c62c>` program);
		void :target:`publishLocalShaderProgram<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a83e2d4efbba54bca5a68f908478ca738>`(std::string key, :ref:`ShaderProgramPtr<doxid-namespace_e_e_1_1_graphics_1a974528b0f54def40d3485bad4c32c62c>` program);
		bool :target:`eraseLocal<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a785fbaf9f365338c47af7b4181b14f48>`(const :ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>`& key);
		bool :target:`eraseLocal<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1ad48a8274e50fec417843052a0f14cab5>`(const std::string& key);
		bool :target:`eraseLocalDrawable<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a554aad34c47942eb5e1379e35acc4741>`(const :ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>`& key);
		bool :target:`eraseLocalDrawable<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1ac183b90061b92c8cb2e8f96eb0f1c818>`(const std::string& key);
		bool :target:`eraseLocalAtlas<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1ac48dee7fcf5997c339a7ea9ea00b9985>`(const :ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>`& key);
		bool :target:`eraseLocalAtlas<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a59511a1712efec9cc24ee0113c17b3c3>`(const std::string& key);
		bool :target:`eraseLocalFont<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a416553e5140cd007fbe706ea687deb34>`(const :ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>`& key);
		bool :target:`eraseLocalFont<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1ac0613686ed3445cc21d1d3bfee67f33f>`(const std::string& key);
		bool :target:`eraseLocalFont<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a0c77ff30f3904733568cb65133a83cdf>`(:ref:`Font<doxid-class_e_e_1_1_graphics_1_1_font>`* font);
		bool :target:`eraseLocalShaderProgram<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a3bee2cef5d8b753659b06cd92ac52974>`(const :ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>`& key);
		bool :target:`eraseLocalShaderProgram<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1af59e0d6b6e5a324974a61007b95b1e38>`(const std::string& key);
		void :target:`clearLocal<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1aa2f9d711405918a2d63245084ab38ccf>`();
		void :ref:`importCatalog<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a180e46ab540afa317c085533da3d94af>`(:ref:`ResourceCatalogPtr<doxid-namespace_e_e_1_1_graphics_1a4a1051dc628af2db9b11c6d8af189e32>` catalog);
		bool :ref:`removeCatalog<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a5227b428ad747e8e864850bdc4a7af9c>`(const :ref:`ResourceCatalogPtr<doxid-namespace_e_e_1_1_graphics_1a4a1051dc628af2db9b11c6d8af189e32>`& catalog);
		void :ref:`clearImports<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a8f0a3f1de9694104eb5e4192469cd599>`();
		:ref:`ResourceCatalogPtr<doxid-namespace_e_e_1_1_graphics_1a4a1051dc628af2db9b11c6d8af189e32>` :target:`getLocalCatalog<doxid-class_e_e_1_1_graphics_1_1_resource_scope_1ad774715c17d4b4eca282967f0bbc6668>`() const;
	};
.. _details-class_e_e_1_1_graphics_1_1_resource_scope:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

:ref:`Graphics <doxid-namespace_e_e_1_1_graphics>` resource lookup boundary with local ownership and explicit catalog visibility.

A scope owns resources published into its local catalog. Lookups search that local catalog first, followed by imported catalogs in import order. Importing a catalog retains the catalog and makes its resources visible; it does not copy resources and does not transfer them into the local catalog. Consequently, removing an import only removes lookup visibility and releases the scope's catalog reference.

Use :ref:`importCatalog() <doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a180e46ab540afa317c085533da3d94af>` when resources owned by another lifetime boundary must be visible in this scope, such as application assets shared with a scene or a theme catalog used by :ref:`UI <doxid-namespace_e_e_1_1_u_i>` widgets. Avoid importing unrelated scene or document catalogs: keeping imports explicit prevents name collisions and resource leakage between independent documents. UISceneNode imports the default resource catalog automatically unless that behavior is disabled at construction time.

Methods
-------

.. index:: pair: function; publishLocalFont
.. _doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a88a889d7e397cfd27c59abe674a59159:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void publishLocalFont(:ref:`ResourceKey<doxid-class_e_e_1_1_graphics_1_1_resource_key>` key, :ref:`FontPtr<doxid-namespace_e_e_1_1_graphics_1a204d963a20d37023d8db99da16b2f4f5>` font)

Publishes a font under ``key``, replacing any existing local binding for that key.

The requested semantic key is preserved. Fonts are never renamed to avoid a collision. A :ref:`FontTrueType <doxid-class_e_e_1_1_graphics_1_1_font_true_type>` instance can belong locally to only one :ref:`ResourceScope <doxid-class_e_e_1_1_graphics_1_1_resource_scope>` because it has one :ref:`FontService <doxid-class_e_e_1_1_graphics_1_1_font_service>` association. To expose the same font to another scope, import this scope's local catalog instead of publishing the same handle locally again.

.. index:: pair: function; importCatalog
.. _doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a180e46ab540afa317c085533da3d94af:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void importCatalog(:ref:`ResourceCatalogPtr<doxid-namespace_e_e_1_1_graphics_1a4a1051dc628af2db9b11c6d8af189e32>` catalog)

Makes resources from ``catalog`` visible after this scope's local resources.

Importing the same catalog more than once has no effect. The catalog is retained strongly for as long as it remains imported. Catalog contents stay live: resources published after this call become visible without importing the catalog again.

.. index:: pair: function; removeCatalog
.. _doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a5227b428ad747e8e864850bdc4a7af9c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool removeCatalog(const :ref:`ResourceCatalogPtr<doxid-namespace_e_e_1_1_graphics_1a4a1051dc628af2db9b11c6d8af189e32>`& catalog)

Removes an imported catalog without modifying the catalog or its resources.

.. index:: pair: function; clearImports
.. _doxid-class_e_e_1_1_graphics_1_1_resource_scope_1a8f0a3f1de9694104eb5e4192469cd599:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void clearImports()

Removes every imported catalog while preserving this scope's local resources.