mirror of https://github.com/mosra/magnum.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
120 lines
4.2 KiB
120 lines
4.2 KiB
#ifndef Magnum_Trade_TgaImporter_h |
|
#define Magnum_Trade_TgaImporter_h |
|
/* |
|
This file is part of Magnum. |
|
|
|
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 |
|
Vladimír Vondruš <mosra@centrum.cz> |
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a |
|
copy of this software and associated documentation files (the "Software"), |
|
to deal in the Software without restriction, including without limitation |
|
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|
and/or sell copies of the Software, and to permit persons to whom the |
|
Software is furnished to do so, subject to the following conditions: |
|
|
|
The above copyright notice and this permission notice shall be included |
|
in all copies or substantial portions of the Software. |
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
|
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
|
DEALINGS IN THE SOFTWARE. |
|
*/ |
|
|
|
/** @file |
|
* @brief Class @ref Magnum::Trade::TgaImporter |
|
*/ |
|
|
|
#include <Corrade/Containers/Array.h> |
|
#include <Corrade/Utility/VisibilityMacros.h> |
|
|
|
#include "Magnum/Trade/AbstractImporter.h" |
|
|
|
#include "MagnumPlugins/TgaImporter/configure.h" |
|
|
|
#ifndef DOXYGEN_GENERATING_OUTPUT |
|
#ifndef MAGNUM_TGAIMPORTER_BUILD_STATIC |
|
#ifdef TgaImporter_EXPORTS |
|
#define MAGNUM_TGAIMPORTER_EXPORT CORRADE_VISIBILITY_EXPORT |
|
#else |
|
#define MAGNUM_TGAIMPORTER_EXPORT CORRADE_VISIBILITY_IMPORT |
|
#endif |
|
#else |
|
#define MAGNUM_TGAIMPORTER_EXPORT CORRADE_VISIBILITY_STATIC |
|
#endif |
|
#define MAGNUM_TGAIMPORTER_LOCAL CORRADE_VISIBILITY_LOCAL |
|
#else |
|
#define MAGNUM_TGAIMPORTER_EXPORT |
|
#define MAGNUM_TGAIMPORTER_LOCAL |
|
#endif |
|
|
|
namespace Magnum { namespace Trade { |
|
|
|
/** |
|
@brief TGA importer plugin |
|
|
|
Supports Truevision TGA (`*.tga`, `*.vda`, `*.icb`, `*.vst`) uncompressed BGR, |
|
BGRA or grayscale images with 8 bits per channel. |
|
|
|
The images are imported with @ref PixelFormat::RGB8Unorm, |
|
@ref PixelFormat::RGBA8Unorm or @ref PixelFormat::R8Unorm, respectively. Images |
|
are imported with default @ref PixelStorage parameters except for alignment, |
|
which may be changed to `1` if the data require it. |
|
|
|
@section Trade-TgaImporter-usage Usage |
|
|
|
This plugin depends on the @ref Trade library and is built if `WITH_TGAIMPORTER` |
|
is enabled when building Magnum. To use as a dynamic plugin, load |
|
@cpp "TgaImporter" @ce via @ref Corrade::PluginManager::Manager. |
|
|
|
Additionally, if you're using Magnum as a CMake subproject, do the following: |
|
|
|
@code{.cmake} |
|
set(WITH_TGAIMPORTER ON CACHE BOOL "" FORCE) |
|
add_subdirectory(magnum EXCLUDE_FROM_ALL) |
|
|
|
# So the dynamically loaded plugin gets built implicitly |
|
add_dependencies(your-app Magnum::TgaImporter) |
|
@endcode |
|
|
|
To use as a static plugin or use this as a dependency of another plugin with |
|
CMake, you need to request the `TgaImporter` component of the `Magnum` package |
|
and link to the `Magnum::TgaImporter` target: |
|
|
|
@code{.cmake} |
|
find_package(Magnum REQUIRED TgaImporter) |
|
|
|
# ... |
|
target_link_libraries(your-app PRIVATE Magnum::TgaImporter) |
|
@endcode |
|
|
|
See @ref building, @ref cmake and @ref plugins for more information. |
|
*/ |
|
class MAGNUM_TGAIMPORTER_EXPORT TgaImporter: public AbstractImporter { |
|
public: |
|
/** @brief Default constructor */ |
|
explicit TgaImporter(); |
|
|
|
/** @brief Plugin manager constructor */ |
|
explicit TgaImporter(PluginManager::AbstractManager& manager, const std::string& plugin); |
|
|
|
~TgaImporter(); |
|
|
|
private: |
|
ImporterFeatures MAGNUM_TGAIMPORTER_LOCAL doFeatures() const override; |
|
bool MAGNUM_TGAIMPORTER_LOCAL doIsOpened() const override; |
|
void MAGNUM_TGAIMPORTER_LOCAL doOpenData(Containers::ArrayView<const char> data) override; |
|
void MAGNUM_TGAIMPORTER_LOCAL doClose() override; |
|
UnsignedInt MAGNUM_TGAIMPORTER_LOCAL doImage2DCount() const override; |
|
Containers::Optional<ImageData2D> MAGNUM_TGAIMPORTER_LOCAL doImage2D(UnsignedInt id) override; |
|
|
|
Containers::Array<char> _in; |
|
}; |
|
|
|
}} |
|
|
|
#endif
|
|
|