/
Texture.hpp
100 lines (84 loc) · 2.81 KB
/
Texture.hpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/**
* Copyright 2014-2017 Steven T Sell (ssell@vertexfragment.com)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#ifndef __H__OCULAR_GRAPHICS_TEXTURE__H__
#define __H__OCULAR_GRAPHICS_TEXTURE__H__
#include "Resources/Resource.hpp"
#include "TextureDescriptor.hpp"
#define OCULAR_MAX_TEXTURE_WIDTH 16384
#define OCULAR_MAX_TEXTURE_HEIGHT 16384
//------------------------------------------------------------------------------------------
/**
* \addtogroup Ocular
* @{
*/
namespace Ocular
{
/**
* \addtogroup Graphics
* @{
*/
namespace Graphics
{
/**
* \class Texture
* \brief Base class for all texture objects
*/
class Texture : public Core::Resource
{
public:
/**
* \param[in] descriptor
*/
Texture(TextureDescriptor const& descriptor);
virtual ~Texture();
//----------------------------------------
// Inherited
virtual void unload() = 0;
/**
* Applies any manually made pixel changes of the texture to the GPU.
* Textures will not be updated (i.e. changes rendered) until this method is called.
*
* \note Texture CPU access must be set to TextureAccess::WriteOnly or TextureAccess::ReadWrite
* in order to modify a texture at runtime.
*/
virtual void apply() = 0;
/**
* Refreshes the CPU texture data with any data stored on the GPU.
* This action can overwrite pre-existing CPU data.
*
* \note Texture CPU access must be set to TextureAccess::ReadOnly or TextureAccess::ReadWrite
* in order to refresh the CPU data at runtime.
*/
virtual void refresh() = 0;
/**
* Returns a copy of the texture descriptor that defines this texture resource.
*/
TextureDescriptor const& getDescriptor() const;
protected:
TextureDescriptor m_Descriptor;
private:
};
}
/**
* @} End of Doxygen Groups
*/
}
/**
* @} End of Doxygen Groups
*/
//------------------------------------------------------------------------------------------
#endif