Colobot
nulldevice.h
1 /*
2  * This file is part of the Colobot: Gold Edition source code
3  * Copyright (C) 2001-2016, Daniel Roux, EPSITEC SA & TerranovaTeam
4  * http://epsitec.ch; http://colobot.info; http://github.com/colobot
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14  * See the GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see http://gnu.org/licenses
18  */
19 
25 #pragma once
26 
27 #include "graphics/core/device.h"
28 
29 #include "graphics/core/light.h"
30 #include "graphics/core/material.h"
31 
32 #include "math/matrix.h"
33 
34 // Graphics module namespace
35 namespace Gfx
36 {
37 
43 class CNullDevice : public CDevice
44 {
45 public:
46  CNullDevice();
47  virtual ~CNullDevice();
48 
49  void DebugHook() override;
50  void DebugLights() override;
51 
52  std::string GetName() override;
53 
54  bool Create() override;
55  void Destroy() override;
56 
57  void ConfigChanged(const DeviceConfig &newConfig) override;
58 
59  void BeginScene() override;
60  void EndScene() override;
61 
62  void Clear() override;
63 
64  void SetRenderMode(RenderMode mode) override;
65 
66  void SetTransform(TransformType type, const Math::Matrix &matrix) override;
67 
68  void SetMaterial(const Material &material) override;
69 
70  int GetMaxLightCount() override;
71  void SetLight(int index, const Light &light) override;
72  void SetLightEnabled(int index, bool enabled) override;
73 
74  Texture CreateTexture(CImage *image, const TextureCreateParams &params) override;
75  Texture CreateTexture(ImageData *data, const TextureCreateParams &params) override;
76  Texture CreateDepthTexture(int width, int height, int depth) override;
77  void UpdateTexture(const Texture& texture, Math::IntPoint offset, ImageData* data, TexImgFormat format) override;
78  void DestroyTexture(const Texture &texture) override;
79  void DestroyAllTextures() override;
80 
81  int GetMaxTextureStageCount() override;
82  void SetTexture(int index, const Texture &texture) override;
83  void SetTexture(int index, unsigned int textureId) override;
84  void SetTextureEnabled(int index, bool enabled) override;
85 
86  void SetTextureStageParams(int index, const TextureStageParams &params) override;
87 
88  void SetTextureStageWrap(int index, Gfx::TexWrapMode wrapS, Gfx::TexWrapMode wrapT) override;
89  void SetTextureCoordGeneration(int index, TextureGenerationParams &params) override;
90 
91  void DrawPrimitive(PrimitiveType type, const Vertex* vertices, int vertexCount, Color color = Color(1.0f, 1.0f, 1.0f, 1.0f)) override;
92  void DrawPrimitive(PrimitiveType type, const VertexTex2* vertices, int vertexCount, Color color = Color(1.0f, 1.0f, 1.0f, 1.0f)) override;
93  void DrawPrimitive(PrimitiveType type, const VertexCol *vertices, int vertexCount) override;
94 
95  void DrawPrimitives(PrimitiveType type, const Vertex *vertices,
96  int first[], int count[], int drawCount,
97  Color color = Color(1.0f, 1.0f, 1.0f, 1.0f)) override;
98  void DrawPrimitives(PrimitiveType type, const VertexTex2 *vertices,
99  int first[], int count[], int drawCount,
100  Color color = Color(1.0f, 1.0f, 1.0f, 1.0f)) override;
101  void DrawPrimitives(PrimitiveType type, const VertexCol *vertices,
102  int first[], int count[], int drawCount) override;
103 
104  unsigned int CreateStaticBuffer(PrimitiveType primitiveType, const Vertex* vertices, int vertexCount) override;
105  unsigned int CreateStaticBuffer(PrimitiveType primitiveType, const VertexTex2* vertices, int vertexCount) override;
106  unsigned int CreateStaticBuffer(PrimitiveType primitiveType, const VertexCol* vertices, int vertexCount) override;
107  void UpdateStaticBuffer(unsigned int bufferId, PrimitiveType primitiveType, const Vertex* vertices, int vertexCount) override;
108  void UpdateStaticBuffer(unsigned int bufferId, PrimitiveType primitiveType, const VertexTex2* vertices, int vertexCount) override;
109  void UpdateStaticBuffer(unsigned int bufferId, PrimitiveType primitiveType, const VertexCol* vertices, int vertexCount) override;
110  void DrawStaticBuffer(unsigned int bufferId) override;
111  void DestroyStaticBuffer(unsigned int bufferId) override;
112 
113  int ComputeSphereVisibility(const Math::Vector &center, float radius) override;
114 
115  void SetViewport(int x, int y, int width, int height) override;
116 
117  void SetRenderState(RenderState state, bool enabled) override;
118 
119  void SetColorMask(bool red, bool green, bool blue, bool alpha) override;
120 
121  void SetDepthTestFunc(CompFunc func) override;
122 
123  void SetDepthBias(float factor, float units) override;
124 
125  void SetAlphaTestFunc(CompFunc func, float refValue) override;
126 
127  void SetBlendFunc(BlendFunc srcBlend, BlendFunc dstBlend) override;
128 
129  void SetClearColor(const Color &color) override;
130 
131  void SetGlobalAmbient(const Color &color) override;
132 
133  void SetFogParams(FogMode mode, const Color &color, float start, float end, float density) override;
134 
135  void SetCullMode(CullMode mode) override;
136 
137  void SetShadeModel(ShadeModel model) override;
138 
139  void SetShadowColor(float value) override;
140 
141  void SetFillMode(FillMode mode) override;
142 
143  void CopyFramebufferToTexture(Texture& texture, int xOffset, int yOffset, int x, int y, int width, int height) override;
144 
145  std::unique_ptr<CFrameBufferPixels> GetFrameBufferPixels() const override;
146 
147  CFramebuffer* GetFramebuffer(std::string name) override;
148 
149  CFramebuffer* CreateFramebuffer(std::string name, const FramebufferParams& params) override;
150 
151  void DeleteFramebuffer(std::string name) override;
152 
153  bool IsAnisotropySupported() override;
154  int GetMaxAnisotropyLevel() override;
155 
156  int GetMaxSamples() override;
157 
158  bool IsShadowMappingSupported() override;
159 
160  int GetMaxTextureSize() override;
161 
162  bool IsFramebufferSupported() override;
163 
164 private:
165  Math::Matrix m_matrix;
166  Material m_material;
167  Light m_light;
168 };
169 
170 
171 } // namespace Gfx
void BeginScene() override
Begins drawing the 3D scene.
Definition: nulldevice.cpp:65
RenderMode
Render modes the graphics device can be in.
Definition: device.h:172
void SetCullMode(CullMode mode) override
Sets the current cull mode.
Definition: nulldevice.cpp:273
void SetColorMask(bool red, bool green, bool blue, bool alpha) override
Sets the color mask.
Definition: nulldevice.cpp:241
void DrawPrimitives(PrimitiveType type, const Vertex *vertices, int first[], int count[], int drawCount, Color color=Color(1.0f, 1.0f, 1.0f, 1.0f)) override
Renders primitives composed of lists of vertices with single texture.
Definition: nulldevice.cpp:178
std::unique_ptr< CFrameBufferPixels > GetFrameBufferPixels() const override
Returns the pixels of the entire screen.
Definition: nulldevice.cpp:293
void SetBlendFunc(BlendFunc srcBlend, BlendFunc dstBlend) override
Sets the blending functions for source and destination operations.
Definition: nulldevice.cpp:257
void DeleteFramebuffer(std::string name) override
Deletes framebuffer.
Definition: nulldevice.cpp:308
Material struct.
void SetFillMode(FillMode mode) override
Sets the current fill mode.
Definition: nulldevice.cpp:285
Vertex of a primitive.
Definition: vertex.h:52
Vertex with secondary texture coordinates.
Definition: vertex.h:113
void SetLightEnabled(int index, bool enabled) override
Enables/disables the light at given index.
Definition: nulldevice.cpp:98
void SetShadeModel(ShadeModel model) override
Sets the shade model.
Definition: nulldevice.cpp:277
bool Create() override
Initializes the device, setting the initial state.
Definition: nulldevice.cpp:52
void UpdateStaticBuffer(unsigned int bufferId, PrimitiveType primitiveType, const Vertex *vertices, int vertexCount) override
Updates the static buffer composed of given primitives with single texture vertices.
Definition: nulldevice.cpp:208
FogMode
Type of fog calculation function.
Definition: device.h:218
void SetShadowColor(float value) override
Sets shadow color.
Definition: nulldevice.cpp:281
int GetMaxLightCount() override
Returns the maximum number of lights available.
Definition: nulldevice.cpp:89
bool IsShadowMappingSupported() override
Checks if shadow mapping is supported.
Definition: nulldevice.cpp:327
int GetMaxTextureSize() override
Returns max texture size supported.
Definition: nulldevice.cpp:332
void SetFogParams(FogMode mode, const Color &color, float start, float end, float density) override
Sets the fog parameters: mode, color, start distance, end distance and density (for exp models) ...
Definition: nulldevice.cpp:269
4x4 matrix
Definition: matrix.h:65
void SetTextureStageWrap(int index, Gfx::TexWrapMode wrapS, Gfx::TexWrapMode wrapT) override
Sets only the texture wrap modes (for faster than thru stage params)
Definition: nulldevice.cpp:156
void SetRenderState(RenderState state, bool enabled) override
Enables/disables the given render state.
Definition: nulldevice.cpp:237
TexWrapMode
Wrapping mode for texture coords.
Definition: texture.h:99
bool IsFramebufferSupported() override
Checks if framebuffers are supported.
Definition: nulldevice.cpp:337
void SetTexture(int index, const Texture &texture) override
Sets the texture at given texture stage.
Definition: nulldevice.cpp:140
void DrawStaticBuffer(unsigned int bufferId) override
Draws a static buffer.
Definition: nulldevice.cpp:220
FillMode
Polygon fill mode.
Definition: device.h:251
std::string GetName() override
Returns a name of this device.
Definition: nulldevice.cpp:47
void DestroyStaticBuffer(unsigned int bufferId) override
Deletes a static buffer.
Definition: nulldevice.cpp:224
CompFunc
Type of function used to compare values.
Definition: device.h:183
Parameters for a texture unit.
Definition: texture.h:180
Light struct and related enums.
Material of a surface.
Definition: material.h:45
void DestroyAllTextures() override
Deletes all textures created so far.
Definition: nulldevice.cpp:131
unsigned int CreateStaticBuffer(PrimitiveType primitiveType, const Vertex *vertices, int vertexCount) override
Creates a static buffer composed of given primitives with single texture vertices.
Definition: nulldevice.cpp:193
void SetRenderMode(RenderMode mode) override
Sets current rendering mode.
Definition: nulldevice.cpp:77
void SetClearColor(const Color &color) override
Sets the clear color.
Definition: nulldevice.cpp:261
int ComputeSphereVisibility(const Math::Vector &center, float radius) override
Definition: nulldevice.cpp:228
Parameters for texture coordinate generation.
Definition: texture.h:234
void DebugHook() override
Provides a hook to debug graphics code (implementation-specific)
Definition: nulldevice.cpp:39
TexImgFormat
Format of image data.
Definition: texture.h:42
General config for graphics device.
Definition: device.h:64
Properties of light in 3D scene.
Definition: light.h:54
Device implementation that doesn&#39;t render anything.
Definition: nulldevice.h:43
void SetMaterial(const Material &material) override
Sets the current material.
Definition: nulldevice.cpp:85
void SetTextureEnabled(int index, bool enabled) override
Enables/disables the given texture stage.
Definition: nulldevice.cpp:148
void SetTextureCoordGeneration(int index, TextureGenerationParams &params) override
Sets the texture coordinate generation mode for given texture unit.
Definition: nulldevice.cpp:160
void DestroyTexture(const Texture &texture) override
Deletes a given texture, freeing it from video memory.
Definition: nulldevice.cpp:127
void ConfigChanged(const DeviceConfig &newConfig) override
Changes configuration.
Definition: nulldevice.cpp:61
void SetGlobalAmbient(const Color &color) override
Sets the global ambient color.
Definition: nulldevice.cpp:265
Parameters for texture creation.
Definition: texture.h:155
Texture CreateDepthTexture(int width, int height, int depth) override
Creates a depth texture with specific dimensions and depth.
Definition: nulldevice.cpp:116
ShadeModel
Shade model used in rendering.
Definition: device.h:241
BlendFunc
Type of blending function.
Definition: device.h:199
Matrix struct and related functions.
void SetDepthTestFunc(CompFunc func) override
Sets the function of depth test.
Definition: nulldevice.cpp:245
void SetViewport(int x, int y, int width, int height) override
Changes rendering viewport.
Definition: nulldevice.cpp:233
Image loaded from file.
Definition: image.h:54
Contains parameters for new framebuffer.
Definition: framebuffer.h:34
void EndScene() override
Ends drawing the 3D scene.
Definition: nulldevice.cpp:69
PrimitiveType
Type of primitive to render.
Definition: device.h:265
CFramebuffer * CreateFramebuffer(std::string name, const FramebufferParams &params) override
Creates new framebuffer with given name or nullptr if it&#39;s not possible.
Definition: nulldevice.cpp:303
CullMode
Culling mode for polygons.
Definition: device.h:229
Colored vertex.
Definition: vertex.h:84
void SetTextureStageParams(int index, const TextureStageParams &params) override
Sets the params for texture stage with given index.
Definition: nulldevice.cpp:152
Namespace for (new) graphics code.
Definition: app.h:49
Implementation-specific image data.
Definition: image.h:41
RenderState
Render states that can be enabled/disabled.
Definition: device.h:155
Texture CreateTexture(CImage *image, const TextureCreateParams &params) override
Creates a texture from image; the image can be safely removed after that.
Definition: nulldevice.cpp:102
Info about a texture.
Definition: texture.h:256
int GetMaxSamples() override
Returns max samples supported.
Definition: nulldevice.cpp:322
void SetLight(int index, const Light &light) override
Sets the light at given index.
Definition: nulldevice.cpp:94
int GetMaxAnisotropyLevel() override
Returns max anisotropy level supported.
Definition: nulldevice.cpp:317
void DrawPrimitive(PrimitiveType type, const Vertex *vertices, int vertexCount, Color color=Color(1.0f, 1.0f, 1.0f, 1.0f)) override
Renders primitive composed of vertices with single texture.
Definition: nulldevice.cpp:164
void Clear() override
Clears the screen to blank.
Definition: nulldevice.cpp:73
3D (3x1) vector
Definition: vector.h:53
Abstract graphics device - CDevice class and related structs/enums.
2D Point with integer coords
Definition: intpoint.h:39
void SetAlphaTestFunc(CompFunc func, float refValue) override
Sets the alpha test function and reference value.
Definition: nulldevice.cpp:253
RGBA color.
Definition: color.h:39
int GetMaxTextureStageCount() override
Returns the maximum number of multitexture stages.
Definition: nulldevice.cpp:135
void SetTransform(TransformType type, const Math::Matrix &matrix) override
Sets the transform matrix of given type.
Definition: nulldevice.cpp:81
void Destroy() override
Destroys the device, releasing every acquired resource.
Definition: nulldevice.cpp:57
bool IsAnisotropySupported() override
Checks if anisotropy is supported.
Definition: nulldevice.cpp:312
void CopyFramebufferToTexture(Texture &texture, int xOffset, int yOffset, int x, int y, int width, int height) override
Copies content of framebuffer to texture.
Definition: nulldevice.cpp:289
CFramebuffer * GetFramebuffer(std::string name) override
Returns framebuffer with given name or nullptr if it doesn&#39;t exist.
Definition: nulldevice.cpp:298
TransformType
Type of transformation in rendering pipeline.
Definition: device.h:143
void UpdateTexture(const Texture &texture, Math::IntPoint offset, ImageData *data, TexImgFormat format) override
Updates a part of texture from raw image data.
Definition: nulldevice.cpp:123
void SetDepthBias(float factor, float units) override
Sets the depth bias (constant value added to Z-coords)
Definition: nulldevice.cpp:249
Abstract interface of graphics device.
Definition: device.h:323
Abstract interface of default framebuffer and offscreen framebuffers.
Definition: framebuffer.h:67
void DebugLights() override
Displays light positions to aid in debuggings.
Definition: nulldevice.cpp:43