ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
11516 Commits
21 Branches
19 Tags
70 MiB
Tree: b1454b94de
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b1454b94de'
${ noResults }
magnum/src/Magnum/Trade/Data.cpp

73 lines
2.8 KiB
Raw Normal View History Unescape

Trade: new enum for describing data ownership. Will be used for MeshData that don't own the memory.
7 years ago
/*
This file is part of Magnum.
Updated copyright year.
6 years ago
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
Here we go again.
1 year ago
2020, 2021, 2022, 2023, 2024, 2025
It's October already?!
2 years ago
Vladimír Vondruš <mosra@centrum.cz>
Trade: new enum for describing data ownership. Will be used for MeshData that don't own the memory.
7 years ago
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.
*/
#include "Data.h"
#include <Corrade/Containers/EnumSet.hpp>
namespace Magnum { namespace Trade {
Debug& operator<<(Debug& debug, const DataFlag value) {
Packed debug output for enums used by Trade. Again not publicly documented because I don't like the naming and I don't have the full behavior and interactions figured out yet -- i.e., an array of VertexFormats would be printed with Debug::packed as a long string of characters without any whitespace. Not good, thus this feature probably needs to be split in two, with this being named "compact" or something else.
4 years ago
const bool packed = debug.immediateFlags() >= Debug::Flag::Packed;
if(!packed)
debug << "Trade::DataFlag" << Debug::nospace;
Trade: new enum for describing data ownership. Will be used for MeshData that don't own the memory.
7 years ago
switch(value) {
/* LCOV_EXCL_START */
Packed debug output for enums used by Trade. Again not publicly documented because I don't like the naming and I don't have the full behavior and interactions figured out yet -- i.e., an array of VertexFormats would be printed with Debug::packed as a long string of characters without any whitespace. Not good, thus this feature probably needs to be split in two, with this being named "compact" or something else.
4 years ago
#define _c(v) case DataFlag::v: return debug << (packed ? "" : "::") << Debug::nospace << #v;
Trade: new enum for describing data ownership. Will be used for MeshData that don't own the memory.
7 years ago
_c(Owned)
Trade: ability to open non-temporary memory. Using openMemory() instead of openData() allows the implementation to assume the data will stay in scope for as long as needed, which can prevent unnecessary copies in some plugin implementations. It warranted a new flag, DataFlag::ExternallyOwned, to describe this kind of memory. I couldn't reuse Owned as that's used for allocations owned by the instance, which is too little for certain future use cases. For example returning *Data instances referencing an Owned memory would mean the user has to assume the memory is gone when the importer instance is gone, and that's generally not true for memory passed to openMemory(). Originally I thought I would do this later, but then realized the existing plugin implementations would need to get all updated again to be aware of the new flag, with some being forgotten, and it's just easier to do the whole thing in a single step.
5 years ago
_c(ExternallyOwned)
Trade: add DataFlag::Global. For more robust handling of non-owning *Data instanced and refcounting in Python bindings I need to differentiate between, say, a MeshData referencing global memory (such as Primitives::cubeSolid()) and MeshData referencing just some temporary allocation or another MeshData (such as the output of MeshTools::filterOnlyAttributes()).
3 years ago
_c(Global)
Trade: new enum for describing data ownership. Will be used for MeshData that don't own the memory.
7 years ago
_c(Mutable)
#undef _c
/* LCOV_EXCL_STOP */
}
Use the new Debug::hex instead of reinterpret_cast<void*>(). This finally fixes most of those annoying MSVC C4312 warnings about conversion to a type of a greater size.
2 years ago
return debug << (packed ? "" : "(") << Debug::nospace << Debug::hex << UnsignedByte(value) << Debug::nospace << (packed ? "" : ")");
Trade: new enum for describing data ownership. Will be used for MeshData that don't own the memory.
7 years ago
}
Debug& operator<<(Debug& debug, const DataFlags value) {
Packed debug output for enums used by Trade. Again not publicly documented because I don't like the naming and I don't have the full behavior and interactions figured out yet -- i.e., an array of VertexFormats would be printed with Debug::packed as a long string of characters without any whitespace. Not good, thus this feature probably needs to be split in two, with this being named "compact" or something else.
4 years ago
return Containers::enumSetDebugOutput(debug, value, debug.immediateFlags() >= Debug::Flag::Packed ? "{}" : "Trade::DataFlags{}", {
Trade: new enum for describing data ownership. Will be used for MeshData that don't own the memory.
7 years ago
DataFlag::Owned,
Trade: ability to open non-temporary memory. Using openMemory() instead of openData() allows the implementation to assume the data will stay in scope for as long as needed, which can prevent unnecessary copies in some plugin implementations. It warranted a new flag, DataFlag::ExternallyOwned, to describe this kind of memory. I couldn't reuse Owned as that's used for allocations owned by the instance, which is too little for certain future use cases. For example returning *Data instances referencing an Owned memory would mean the user has to assume the memory is gone when the importer instance is gone, and that's generally not true for memory passed to openMemory(). Originally I thought I would do this later, but then realized the existing plugin implementations would need to get all updated again to be aware of the new flag, with some being forgotten, and it's just easier to do the whole thing in a single step.
5 years ago
DataFlag::ExternallyOwned,
Trade: add DataFlag::Global. For more robust handling of non-owning *Data instanced and refcounting in Python bindings I need to differentiate between, say, a MeshData referencing global memory (such as Primitives::cubeSolid()) and MeshData referencing just some temporary allocation or another MeshData (such as the output of MeshTools::filterOnlyAttributes()).
3 years ago
DataFlag::Global,
Trade: new enum for describing data ownership. Will be used for MeshData that don't own the memory.
7 years ago
DataFlag::Mutable});
}
Trade: implement mutable data access in MeshData. Turns out the design wasn't so simple after all. AnimationData and ImageData classes will follow with similar changes.
7 years ago
namespace Implementation {
Trade: don't reinterpret no-op function pointers. It was a clever harmless trick. Well, it was way more harmless than it was clever, but even then it caused UBSan to complain. And that's Not A Good Thing for various reasons, so let's just comply. The main bad effect of this change is a *slightly* larger list of exported symbols but until we actually get rid of the major bloats like <iostream>, <string> and the like, this is not going to have any measurable impact.
4 years ago
void nonOwnedArrayDeleter(char*, std::size_t) {}
void nonOwnedArrayDeleter(AnimationTrackData*, std::size_t) {}
void nonOwnedArrayDeleter(MeshAttributeData*, std::size_t) {}
void nonOwnedArrayDeleter(MaterialAttributeData*, std::size_t) {}
void nonOwnedArrayDeleter(UnsignedInt*, std::size_t) {}
void nonOwnedArrayDeleter(Matrix3*, std::size_t) {}
void nonOwnedArrayDeleter(Matrix4*, std::size_t) {}
void nonOwnedArrayDeleter(SceneFieldData*, std::size_t) {}
Trade: implement mutable data access in MeshData. Turns out the design wasn't so simple after all. AnimationData and ImageData classes will follow with similar changes.
7 years ago
}
Trade: new enum for describing data ownership. Will be used for MeshData that don't own the memory.
7 years ago
}}