graphic_context_provider.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 ** Harry Storbacka
28 */
29 
30 
31 #pragma once
32 
33 #include <memory>
34 #include "../Render/graphic_context.h"
35 #include "../Render/primitives_array.h"
36 #include "../Render/texture.h"
37 #include "../../Core/Math/mat4.h"
38 #include "../../Core/Signals/signal.h"
39 
40 namespace clan
41 {
44 
45 class Texture;
46 class Stencil;
47 class TextureProvider;
48 class FontProvider;
49 class Font;
50 class OcclusionQueryProvider;
51 class ProgramObjectProvider;
52 class ShaderObjectProvider;
53 class FrameBufferProvider;
54 class RenderBufferProvider;
55 class VertexArrayBufferProvider;
56 class ElementArrayBufferProvider;
57 class TransferBufferProvider;
58 class FontDescription;
59 class PixelBufferProvider;
60 class UniformBufferProvider;
61 class StorageBufferProvider;
62 class PrimitivesArrayProvider;
63 class RasterizerStateDescription;
64 class BlendStateDescription;
65 class DepthStencilStateDescription;
66 
68 {
69 public:
71 };
72 
74 {
75 public:
76  virtual ~BlendStateProvider() { }
77 };
78 
80 {
81 public:
83 };
84 
87 {
90 
91 public:
92  virtual ~GraphicContextProvider() { return; }
93 
97 
98 public:
100  virtual int get_max_attributes() = 0;
101 
103 
105  virtual Size get_max_texture_size() const = 0;
106 
108  virtual Size get_display_window_size() const = 0;
109 
111  virtual float get_pixel_ratio() const = 0;
112 
114  virtual Signal<void(const Size &)> &sig_window_resized() = 0;
115 
117  virtual ProgramObject get_program_object(StandardProgram standard_program) const = 0;
118 
122 
123 public:
124 
126  virtual ClipZRange get_clip_z_range() const = 0;
127 
130 
132  virtual ShaderLanguage get_shader_language() const = 0;
133 
138  virtual int get_major_version() const = 0;
139 
144  virtual int get_minor_version() const = 0;
145 
150  virtual bool has_compute_shader_support() const = 0;
151 
153  virtual PixelBuffer get_pixeldata(const Rect& rect, TextureFormat texture_format, bool clamp) const = 0;
154 
156  virtual TextureProvider *alloc_texture(TextureDimensions texture_dimensions) = 0;
157 
160 
163 
166 
169 
172 
175 
178 
181 
184 
187 
190 
193 
195  virtual std::shared_ptr<RasterizerStateProvider> create_rasterizer_state(const RasterizerStateDescription &desc) = 0;
196 
198  virtual std::shared_ptr<BlendStateProvider> create_blend_state(const BlendStateDescription &desc) = 0;
199 
201  virtual std::shared_ptr<DepthStencilStateProvider> create_depth_stencil_state(const DepthStencilStateDescription &desc) = 0;
202 
205 
207  virtual void set_blend_state(BlendStateProvider *state, const Colorf &blend_color, unsigned int sample_mask) = 0;
208 
210  virtual void set_depth_stencil_state(DepthStencilStateProvider *state, int stencil_ref) = 0;
211 
213  virtual void set_program_object(StandardProgram standard_program) = 0;
214 
218  virtual void set_program_object(const ProgramObject &program) = 0;
219 
221  virtual void reset_program_object() = 0;
222 
224  virtual void set_uniform_buffer(int index, const UniformBuffer &buffer) = 0;
225 
227  virtual void reset_uniform_buffer(int index) = 0;
228 
230  virtual void set_storage_buffer(int index, const StorageBuffer &buffer) = 0;
231 
233  virtual void reset_storage_buffer(int index) = 0;
234 
236  virtual void set_texture(int unit_index, const Texture &texture) = 0;
237 
239  virtual void reset_texture(int unit_index) = 0;
240 
242  virtual void set_image_texture(int unit_index, const Texture &texture) = 0;
243 
245  virtual void reset_image_texture(int unit_index) = 0;
246 
248  virtual bool is_frame_buffer_owner(const FrameBuffer &fb) = 0;
249 
251  virtual void set_frame_buffer(const FrameBuffer &write_buffer, const FrameBuffer &read_buffer) = 0;
252 
254  virtual void reset_frame_buffer() = 0;
255 
256  virtual void set_draw_buffer(DrawBuffer buffer) = 0;
257 
259  virtual bool is_primitives_array_owner(const PrimitivesArray &primitives_array) = 0;
260 
262  virtual void draw_primitives(PrimitivesType type, int num_vertices, const PrimitivesArray &primitives_array) = 0;
263 
265  virtual void set_primitives_array(const PrimitivesArray &primitives_array) = 0;
266 
268  virtual void draw_primitives_array(PrimitivesType type, int offset, int num_vertices) = 0;
269 
271  virtual void draw_primitives_array_instanced(PrimitivesType type, int offset, int num_vertices, int instance_count) = 0;
272 
274  virtual void set_primitives_elements(ElementArrayBufferProvider *array_provider) = 0;
275 
282  virtual void draw_primitives_elements(PrimitivesType type, int count, VertexAttributeDataType indices_type, size_t offset = 0) = 0;
283 
291  virtual void draw_primitives_elements_instanced(PrimitivesType type, int count, VertexAttributeDataType indices_type, size_t offset, int instance_count) = 0;
292 
294  virtual void reset_primitives_elements() = 0;
295 
303  virtual void draw_primitives_elements(PrimitivesType type, int count, ElementArrayBufferProvider *array_provider, VertexAttributeDataType indices_type, void *offset) = 0;
304 
312  virtual void draw_primitives_elements_instanced(PrimitivesType type, int count, ElementArrayBufferProvider *array_provider, VertexAttributeDataType indices_type, void *offset, int instance_count) = 0;
313 
315  virtual void reset_primitives_array() = 0;
316 
318  virtual void set_scissor(const Rect &rect) = 0;
319 
321  virtual void reset_scissor() = 0;
322 
324  virtual void dispatch(int x, int y, int z) = 0;
325 
327  virtual void clear(const Colorf &color) = 0;
328 
332  virtual void clear_depth(float value) = 0;
333 
337  virtual void clear_stencil(int value) = 0;
338 
340  virtual void set_viewport(const Rectf &viewport) = 0;
341 
343  virtual void set_viewport(int index, const Rectf &viewport) = 0;
344 
346  virtual void set_depth_range(float n, float f) = 0;
347 
349  virtual void set_depth_range(int viewport, float n, float f) = 0;
350 
351  virtual void flush() = 0;
352 
356 
357 private:
359 };
360 
361 }
362 
DepthStencil state description.
Definition: depth_stencil_state_description.h:43
C clamp(A val, B minval, C maxval)
Definition: cl_math.h:98
Interface for implementing a RenderBuffer target.
Definition: render_buffer_provider.h:44
virtual void set_uniform_buffer(int index, const UniformBuffer &buffer)=0
Select uniform buffer into index.
ClipZRange
Definition: mat4.h:52
Storage Buffer provider.
Definition: storage_buffer_provider.h:41
virtual ClipZRange get_clip_z_range() const =0
Returns in what range clip space z values are clipped.
virtual void reset_image_texture(int unit_index)=0
Remove texture from image unit.
virtual void set_primitives_elements(ElementArrayBufferProvider *array_provider)=0
Sets current elements array buffer.
Texture object class.
Definition: texture.h:104
virtual ~RasterizerStateProvider()
Definition: graphic_context_provider.h:70
TextureDimensions
Texture dimensions.
Definition: texture.h:92
virtual bool is_frame_buffer_owner(const FrameBuffer &fb)=0
Returns true if this frame buffer object is owned by this graphic context.
Element Array Buffer provider.
Definition: pixel_buffer_provider.h:43
2D (left,top,right,bottom) rectangle structure - Integer
Definition: rect.h:471
virtual float get_pixel_ratio() const =0
Physical pixels/dots per inch.
virtual void set_depth_stencil_state(DepthStencilStateProvider *state, int stencil_ref)=0
Set active depth stencil state.
DrawBuffer
Drawing buffers.
Definition: graphic_context.h:119
virtual void draw_primitives(PrimitivesType type, int num_vertices, const PrimitivesArray &primitives_array)=0
Draw primitives on gc.
virtual ShaderLanguage get_shader_language() const =0
Returns the shader language used.
virtual void set_texture(int unit_index, const Texture &texture)=0
Select texture into unit.
virtual void draw_primitives_elements(PrimitivesType type, int count, VertexAttributeDataType indices_type, size_t offset=0)=0
Draw primitives elements.
ShaderLanguage
Shader language used.
Definition: graphic_context.h:249
Rasterizer state description.
Definition: rasterizer_state_description.h:43
virtual void draw_primitives_array(PrimitivesType type, int offset, int num_vertices)=0
Draws primitives from the current assigned primitives array.
Uniform Buffer provider.
Definition: uniform_buffer_provider.h:41
virtual void reset_storage_buffer(int index)=0
Remove storage buffer from index.
virtual ~BlendStateProvider()
Definition: graphic_context_provider.h:76
virtual void set_viewport(const Rectf &viewport)=0
Set the viewport to be used in user projection map mode.
virtual void set_depth_range(float n, float f)=0
Specifies the depth range for all viewports.
Blend state description.
Definition: blend_state_description.h:43
virtual void reset_scissor()=0
Reset scissor.
2D (left,top,right,bottom) rectangle structure - Float
Definition: rect.h:485
Primitives array description.
Definition: primitives_array.h:69
virtual void clear(const Colorf &color)=0
Clears the whole context using the specified color.
virtual Size get_display_window_size() const =0
Returns the current size of the display window.
Floating point color description class (for float).
Definition: color.h:661
virtual void dispatch(int x, int y, int z)=0
Execute a compute shader.
virtual int get_major_version() const =0
Returns the major version / feature level supported by the hardware.
virtual void draw_primitives_elements_instanced(PrimitivesType type, int count, ElementArrayBufferProvider *array_provider, VertexAttributeDataType indices_type, void *offset, int instance_count)=0
Draw primitives elements instanced.
Definition: graphic_context_provider.h:74
virtual TextureProvider * alloc_texture(TextureDimensions texture_dimensions)=0
Allocate texture provider for this gc.
virtual void set_blend_state(BlendStateProvider *state, const Colorf &blend_color, unsigned int sample_mask)=0
Set active blend state.
Definition: signal.h:105
Transfer Buffer provider.
Definition: transfer_buffer_provider.h:43
virtual RenderBufferProvider * alloc_render_buffer()=0
Allocate render buffer provider for this gc.
virtual void draw_primitives_array_instanced(PrimitivesType type, int offset, int num_vertices, int instance_count)=0
Draws instanced primitives from the current assigned primitives array.
Definition: graphic_context_provider.h:68
Definition: graphic_context_provider.h:80
virtual VertexArrayBufferProvider * alloc_vertex_array_buffer()=0
Allocate vertex array buffer provider for this gc.
virtual void set_program_object(StandardProgram standard_program)=0
Set active program object to the standard program specified.
Program Object provider.
Definition: program_object_provider.h:44
virtual void draw_primitives_elements_instanced(PrimitivesType type, int count, VertexAttributeDataType indices_type, size_t offset, int instance_count)=0
Draw primitives elements instanced.
virtual void set_depth_range(int viewport, float n, float f)=0
Specifies the depth range for the specified viewport.
StandardProgram
Standard Program.
Definition: graphic_context.h:240
virtual void draw_primitives_elements(PrimitivesType type, int count, ElementArrayBufferProvider *array_provider, VertexAttributeDataType indices_type, void *offset)=0
Draw primitives elements.
virtual void set_primitives_array(const PrimitivesArray &primitives_array)=0
Set the primitives array on the gc.
Interface for implementing a Texture target.
Definition: texture_provider.h:51
Vertex Array Buffer provider.
Definition: vertex_array_buffer_provider.h:43
TextureImageYAxis
Y axis direction for viewports, clipping rects, textures and render targets.
Definition: graphic_context.h:233
virtual bool has_compute_shader_support() const =0
Returns true if the hardware supports compute shaders.
virtual PrimitivesArrayProvider * alloc_primitives_array()=0
Allocate primitives array provider for this gc.
virtual std::shared_ptr< DepthStencilStateProvider > create_depth_stencil_state(const DepthStencilStateDescription &desc)=0
Retrieve depth-stencil state object.
virtual FrameBufferProvider * alloc_frame_buffer()=0
Allocate frame buffer provider for this gc.
Uniform Buffer.
Definition: uniform_buffer.h:48
virtual TransferBufferProvider * alloc_transfer_buffer()=0
Allocate transfer buffer provider for this gc.
Interface for implementing a PrimitivesArray target.
Definition: primitives_array_provider.h:41
TextureFormat
Texture format.
Definition: texture_format.h:41
virtual void reset_primitives_array()=0
Reset the primitives arrays.
virtual void reset_primitives_elements()=0
Resets current elements array buffer.
virtual void set_scissor(const Rect &rect)=0
Set scissor.
Interface for implementing a FrameBuffer target.
Definition: frame_buffer_provider.h:46
virtual int get_max_attributes()=0
Returns the maximum amount of attributes available.
virtual PixelBufferProvider * alloc_pixel_buffer()=0
Allocate pixel buffer provider for this gc.
virtual std::shared_ptr< RasterizerStateProvider > create_rasterizer_state(const RasterizerStateDescription &desc)=0
Retrieve rasterizer state object.
virtual TextureImageYAxis get_texture_image_y_axis() const =0
Returns the Y axis direction for viewports, clipping rects, textures and render targets.
virtual Size get_max_texture_size() const =0
Returns the maximum size of a texture this graphic context supports.
Definition: clanapp.h:36
virtual int get_minor_version() const =0
Returns the major version / feature level supported by the hardware.
virtual void set_storage_buffer(int index, const StorageBuffer &buffer)=0
Select storage buffer into index.
Frame-buffer object class.
Definition: frame_buffer.h:73
virtual ~GraphicContextProvider()
Definition: graphic_context_provider.h:92
virtual void clear_stencil(int value)=0
Clear the stencil buffer.
Occlusion query provider.
Definition: occlusion_query_provider.h:41
Pixel data container.
Definition: pixel_buffer.h:69
virtual void set_viewport(int index, const Rectf &viewport)=0
Set the specified viewport to be used in user projection map mode.
VertexAttributeDataType
Primitives array description.
Definition: primitives_array.h:57
virtual void reset_texture(int unit_index)=0
Remove texture from unit.
virtual OcclusionQueryProvider * alloc_occlusion_query()=0
Allocate occlusion query provider of this gc.
virtual void set_frame_buffer(const FrameBuffer &write_buffer, const FrameBuffer &read_buffer)=0
Set a frame buffer for off-screen rendering.
virtual ElementArrayBufferProvider * alloc_element_array_buffer()=0
Allocate element array buffer provider for this gc.
Element Array Buffer provider.
Definition: element_array_buffer_provider.h:41
virtual ShaderObjectProvider * alloc_shader_object()=0
Allocate shader object provider of this gc.
Interface for implementing a GraphicContext target.
Definition: graphic_context_provider.h:87
virtual bool is_primitives_array_owner(const PrimitivesArray &primitives_array)=0
Returns true if this primitives_array is owned by this graphic context.
virtual void reset_frame_buffer()=0
Set the rendering buffer back to the screen.
Storage Buffer.
Definition: storage_buffer.h:48
virtual void set_program_object(const ProgramObject &program)=0
Set active program object.
virtual StorageBufferProvider * alloc_storage_buffer()=0
Allocate storage buffer provider for this gc.
virtual Signal< void(const Size &)> & sig_window_resized()=0
Get the window resized signal.
virtual ProgramObject get_program_object(StandardProgram standard_program) const =0
Get a program object from the standard program specified.
2D (width,height) size structure - Integer
Definition: size.h:157
virtual PixelBuffer get_pixeldata(const Rect &rect, TextureFormat texture_format, bool clamp) const =0
Return the content of the draw buffer into a pixel buffer.
Program Object.
Definition: program_object.h:70
virtual ProgramObjectProvider * alloc_program_object()=0
Allocate program object provider of this gc.
virtual void reset_uniform_buffer(int index)=0
Remove uniform buffer from index.
virtual std::shared_ptr< BlendStateProvider > create_blend_state(const BlendStateDescription &desc)=0
Retrieve blend state object.
virtual void reset_program_object()=0
Remove active program object.
PrimitivesType
Primitive types.
Definition: graphic_context.h:221
Shader Object provider.
Definition: shader_object_provider.h:43
virtual void set_image_texture(int unit_index, const Texture &texture)=0
Select texture into image unit.
virtual void set_draw_buffer(DrawBuffer buffer)=0
virtual ~DepthStencilStateProvider()
Definition: graphic_context_provider.h:82
virtual void clear_depth(float value)=0
Clear the depth buffer.
virtual void set_rasterizer_state(RasterizerStateProvider *state)=0
Set active rasterizer state.
virtual UniformBufferProvider * alloc_uniform_buffer()=0
Allocate uniform buffer provider for this gc.