Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor|Resources: Moved texture resources to libdoomsday (big commit)
This commit splits Texture to the generic res::Texture and client-specific ClientTexture. Other classes moved to libdoomsday include TextureScheme, TextureManifest, PatchName, and CompositeTexture. All the texture-related objects are now owned by the Textures class, which in turn owned by libdoomsday's Resources. Also fixed a couple of errors in the implementation: - Retaining references to TextureVariantSpec without any kind of reference counting, leading to use-after-free errors during engine reset. - Pointers to owning TextureSchemes are now kept as direct pointers, which avoids problems during teardown (trying to iterate partially deleted scheme lists).
- Loading branch information
Showing
77 changed files
with
2,259 additions
and
1,960 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| #include "resource/clienttexture.h" |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,220 @@ | ||
| /** @file texture.h Logical texture resource. | ||
| * | ||
| * @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi> | ||
| * @authors Copyright © 2005-2013 Daniel Swanson <danij@dengine.net> | ||
| * | ||
| * @par License | ||
| * GPL: http://www.gnu.org/licenses/gpl.html | ||
| * | ||
| * <small>This program is free software; you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by the | ||
| * Free Software Foundation; either version 2 of the License, or (at your | ||
| * option) any later version. This program is distributed in the hope that it | ||
| * will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty | ||
| * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General | ||
| * Public License for more details. You should have received a copy of the GNU | ||
| * General Public License along with this program; if not, write to the Free | ||
| * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | ||
| * 02110-1301 USA</small> | ||
| */ | ||
|
|
||
| #ifndef DENG_RESOURCE_CLIENTTEXTURE_H | ||
| #define DENG_RESOURCE_CLIENTTEXTURE_H | ||
|
|
||
| #include "resource/image.h" // res::Source | ||
| #include "TextureVariantSpec" | ||
|
|
||
| #include <doomsday/res/Texture> | ||
|
|
||
| /** | ||
| * Logical texture resource. | ||
| * | ||
| * @ingroup resource | ||
| */ | ||
| class ClientTexture : public res::Texture | ||
| { | ||
| public: | ||
| /** | ||
| * Context-specialized variant. Encapsulates all context variant values | ||
| * and logics pertaining to a specialized version of the @em superior | ||
| * Texture instance. | ||
| * | ||
| * @see TextureVariantSpec | ||
| */ | ||
| class Variant | ||
| { | ||
| public: | ||
| enum Flag | ||
| { | ||
| /// Texture contains alpha. | ||
| /// @todo Does not belong here (is actually a source image analysis). | ||
| Masked = 0x1 | ||
| }; | ||
| Q_DECLARE_FLAGS(Flags, Flag) | ||
|
|
||
| /** | ||
| * @param texture Base Texture from which the draw-context variant is derived. | ||
| * @param spec Draw-context variant specification. | ||
| */ | ||
| Variant(ClientTexture &texture, TextureVariantSpec const &spec); | ||
|
|
||
| public: | ||
| /** | ||
| * Returns the base Texture for the draw-context variant. | ||
| */ | ||
| ClientTexture &base() const; | ||
|
|
||
| /// Returns @c true if the variant is "prepared". | ||
| inline bool isPrepared() const { return glName() != 0; } | ||
|
|
||
| /// Returns @c true if the variant is flagged as "masked". | ||
| inline bool isMasked() const { return isFlagged(Masked); } | ||
|
|
||
| /** | ||
| * Prepare the texture variant for render. | ||
| * | ||
| * @note If a cache miss occurs texture content data may need to be | ||
| * (re-)uploaded to GL. However, the actual upload will be deferred | ||
| * if possible. This has the side effect that although the variant | ||
| * is considered "prepared", attempts to render using the associated | ||
| * GL texture will result in "uninitialized" white texels being used | ||
| * instead. | ||
| * | ||
| * @return GL-name of the uploaded texture. | ||
| */ | ||
| uint prepare(); | ||
|
|
||
| /** | ||
| * Release any uploaded GL-texture and clear the associated GL-name | ||
| * for the variant. | ||
| */ | ||
| void release(); | ||
|
|
||
| /** | ||
| * Returns the specification used to derive the variant. | ||
| */ | ||
| TextureVariantSpec const &spec() const; | ||
|
|
||
| /** | ||
| * Returns the source of the image used to prepare the uploaded GL-texture | ||
| * for the variant. | ||
| */ | ||
| res::Source source() const; | ||
|
|
||
| /** | ||
| * Returns a textual description of the source of the variant. | ||
| * | ||
| * @return Human-friendly description of the source of the variant. | ||
| */ | ||
| de::String sourceDescription() const; | ||
|
|
||
| /** | ||
| * Returns the flags for the variant. | ||
| */ | ||
| Flags flags() const; | ||
|
|
||
| /** | ||
| * Returns @c true if the variant is flagged @a flagsToTest. | ||
| */ | ||
| inline bool isFlagged(Flags flagsToTest) const | ||
| { | ||
| return (flags() & flagsToTest) != 0; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the GL-name of the uploaded texture content for the variant; | ||
| * otherwise @c 0 (not uploaded). | ||
| */ | ||
| uint glName() const; | ||
|
|
||
| /** | ||
| * Returns the prepared GL-texture coordinates for the variant. | ||
| * | ||
| * @param s S axis coordinate. | ||
| * @param t T axis coordinate. | ||
| */ | ||
| void glCoords(float *s, float *t) const; | ||
|
|
||
| private: | ||
| DENG2_PRIVATE(d) | ||
| }; | ||
|
|
||
| /// A list of variants. | ||
| typedef QList<Variant *> Variants; | ||
|
|
||
| /** | ||
| * Logics for selecting a texture variant instance from the candidates. | ||
| * | ||
| * @see chooseVariant() | ||
| */ | ||
| enum ChooseVariantMethod | ||
| { | ||
| /// The variant specification of the candidate must match exactly. | ||
| MatchSpec, | ||
|
|
||
| /// The variant specification of the candidate must match however | ||
| /// certain properties may vary (e.g., quality arguments) if it means | ||
| /// we can avoid creating a new variant. | ||
| //FuzzyMatchSpec | ||
| }; | ||
|
|
||
| public: | ||
| ClientTexture(res::TextureManifest &manifest); | ||
|
|
||
| void release() override; | ||
| de::String description() const override; | ||
|
|
||
| /** | ||
| * Destroys all derived variants for the texture. | ||
| */ | ||
| void clearVariants(); | ||
|
|
||
| /** | ||
| * Choose/create a variant of the texture which fulfills @a spec. | ||
| * | ||
| * @param method Method of selection. | ||
| * @param spec Texture specialization specification. | ||
| * @param canCreate @c true= Create a new variant if no suitable one exists. | ||
| * | ||
| * @return Chosen variant; otherwise @c NULL if none suitable and not creating. | ||
| */ | ||
| Variant *chooseVariant(ChooseVariantMethod method, | ||
| TextureVariantSpec const &spec, | ||
| bool canCreate = false); | ||
|
|
||
| /** | ||
| * Choose/create a variant of the texture which fulfills @a spec and then | ||
| * immediately prepare it for render. | ||
| * | ||
| * @note A convenient shorthand of the call tree: | ||
| * <pre> | ||
| * chooseVariant(MatchSpec, @a spec, true)->prepareVariant(); | ||
| * </pre> | ||
| * | ||
| * @param spec Specification for the derivation of the texture. | ||
| * | ||
| * @return The prepared texture variant if successful; otherwise @c 0. | ||
| * | ||
| * @see chooseVariant() | ||
| */ | ||
| Variant *prepareVariant(TextureVariantSpec const &spec); | ||
|
|
||
| /** | ||
| * Provides access to the list of variant instances for efficent traversal. | ||
| */ | ||
| Variants const &variants() const; | ||
|
|
||
| /** | ||
| * Returns the number of variants for the texture. | ||
| */ | ||
| uint variantCount() const; | ||
|
|
||
| private: | ||
| DENG2_PRIVATE(d) | ||
| }; | ||
|
|
||
| Q_DECLARE_OPERATORS_FOR_FLAGS(ClientTexture::Flags) | ||
|
|
||
| typedef ClientTexture::Variant TextureVariant; | ||
|
|
||
| #endif // DENG_RESOURCE_CLIENTTEXTURE_H |
Oops, something went wrong.