Files
OpenSpace/modules/globebrowsing/tile/tileloadjob.h
Emil Axelsson 6b82df68dd Pr/core threadpool (#401)
Move GlobeBrowsing thread pool to OpenSpace core
2017-09-22 13:22:03 +02:00

93 lines
4.5 KiB
C++

/*****************************************************************************************
* *
* OpenSpace *
* *
* Copyright (c) 2014-2017 *
* *
* 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. *
****************************************************************************************/
#ifndef __OPENSPACE_MODULE_GLOBEBROWSING___TILELOADJOB___H__
#define __OPENSPACE_MODULE_GLOBEBROWSING___TILELOADJOB___H__
#include <modules/globebrowsing/tile/tile.h>
#include <openspace/util/concurrentjobmanager.h>
namespace openspace::globebrowsing {
class RawTileDataReader;
struct RawTile;
struct TileLoadJob : public Job<RawTile> {
/**
* Allocates enough data for one tile. When calling <code>product()</code>, the
* ownership of this data will be released. If <code>product()</code> has not been
* called before the TileLoadJob is finished, the data will be deleted as it has not
* been exposed outside of this object.
*/
TileLoadJob(std::shared_ptr<RawTileDataReader> rawTileDataReader,
const TileIndex& tileIndex);
/**
* No data is allocated unless specified so by the TileTextureInitData of
* rawTileDataReader but it is assumed that pboDataPtr is a mapped pointer to a pixel
* buffer object.
*/
TileLoadJob(std::shared_ptr<RawTileDataReader> rawTileDataReader,
const TileIndex& tileIndex, char* pboDataPtr);
/**
* Destroys the allocated data pointer if it has been allocated and the TileLoadJob
* has ownership of it.
*/
~TileLoadJob();
/**
* If the TileLoadJob has been created using PBO, this is the address that the
* RawTileDataReader will read to. In case specified so in the TileTextureInitData
* of RawTileDataReader, the data will also be written to CPU memory.
*/
void execute() override;
/**
* Marks the job as finised and releases ownership of the data.
* Unless the job is marked as finished, the pixel data will be deallocated
* when the job is deleted.
*/
std::shared_ptr<RawTile> product() override;
/**
* Get the data ownership. if any data has been allocated (ie if the job was created
* using the CPU constructor not taking a PBO data pointer) this function is
* equivalent with asking if the job is unfinished. If the job has ownership of data,
* the data will be deleted once the job is deleted.
*/
bool hasOwnershipOfData() const;
protected:
std::shared_ptr<RawTileDataReader> _rawTileDataReader;
std::shared_ptr<RawTile> _rawTile;
TileIndex _chunkIndex;
char* _pboMappedDataDestination;
bool _hasOwnershipOfData;
};
} // namespace openspace::globebrowsing
#endif // __OPENSPACE_MODULE_GLOBEBROWSING___TILELOADJOB___H__