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.
111 lines
3.7 KiB
111 lines
3.7 KiB
#ifndef Magnum_Trade_Data_h |
|
#define Magnum_Trade_Data_h |
|
/* |
|
This file is part of Magnum. |
|
|
|
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, |
|
2020, 2021 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 Enum @ref Magnum::Trade::DataFlag, enum set @ref Magnum::Trade::DataFlags |
|
* @m_since{2020,06} |
|
*/ |
|
|
|
#include <Corrade/Containers/EnumSet.h> |
|
|
|
#include "Magnum/Magnum.h" |
|
#include "Magnum/Trade/visibility.h" |
|
|
|
namespace Magnum { namespace Trade { |
|
|
|
/** |
|
@brief Data flag |
|
@m_since{2020,06} |
|
|
|
Used to describe data contained in various classes returned from |
|
@ref AbstractImporter interfaces and also data passed internally in the |
|
importer itself. |
|
@see @ref DataFlags, @ref AnimationData::dataFlags(), |
|
@ref ImageData::dataFlags(), @ref MaterialData::attributeDataFlags(), |
|
@ref MaterialData::layerDataFlags(), @ref MeshData::indexDataFlags(), |
|
@ref MeshData::vertexDataFlags(), @ref AbstractImporter::doOpenData() |
|
*/ |
|
enum class DataFlag: UnsignedByte { |
|
/** |
|
* Data is owned by the instance, meaning it stays in scope for as long as |
|
* the instance. If neither this flag nor @ref DataFlag::ExternallyOwned is |
|
* set, the data is considered to be just a temporary allocation and no |
|
* assumptions about its lifetime can be made. |
|
*/ |
|
Owned = 1 << 0, |
|
|
|
/** |
|
* Data has an owner external to the instance, for example a memory-mapped |
|
* file or a constant memory. In general the data lifetime exceeds lifetime |
|
* of the instance wrapping it. If neither this flag nor |
|
* @ref DataFlag::ExternallyOwned is set, the data is considered to be just |
|
* a temporary allocation and no assumptions about its lifetime can be |
|
* made. |
|
* @m_since_latest |
|
*/ |
|
ExternallyOwned = 1 << 3, |
|
|
|
/** |
|
* Data is mutable. If this flag is not set, the instance might be for |
|
* example referencing a readonly memory-mapped file or a constant memory. |
|
*/ |
|
Mutable = 1 << 2 |
|
|
|
/** @todo owned by importer, owned by the GPU, ... */ |
|
}; |
|
|
|
/** |
|
@debugoperatorenum{DataFlag} |
|
@m_since{2020,06} |
|
*/ |
|
MAGNUM_TRADE_EXPORT Debug& operator<<(Debug& debug, DataFlag value); |
|
|
|
/** |
|
@brief Data flags |
|
@m_since{2020,06} |
|
|
|
@see @ref AnimationData::dataFlags(), @ref ImageData::dataFlags(), |
|
@ref MeshData::indexDataFlags(), @ref MeshData::vertexDataFlags() |
|
*/ |
|
typedef Containers::EnumSet<DataFlag> DataFlags; |
|
|
|
CORRADE_ENUMSET_OPERATORS(DataFlags) |
|
|
|
/** |
|
@debugoperatorenum{DataFlags} |
|
@m_since{2020,06} |
|
*/ |
|
MAGNUM_TRADE_EXPORT Debug& operator<<(Debug& debug, DataFlags value); |
|
|
|
namespace Implementation { |
|
/* Used internally by MeshData */ |
|
MAGNUM_TRADE_EXPORT void nonOwnedArrayDeleter(char*, std::size_t); |
|
} |
|
|
|
}} |
|
|
|
#endif
|
|
|