Overview
Download
Documentation
Contact
Sources
API
Display
Render
render_buffer.h
1
/*
2
** ClanLib SDK
3
** Copyright (c) 1997-2020 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
#pragma once
31
32
#include <memory>
33
#include "texture.h"
34
35
namespace
clan
36
{
39
40
class
RenderBuffer;
41
class
GraphicContext;
42
class
RenderBufferProvider;
43
class
RenderBuffer_Impl;
44
46
class
RenderBuffer
47
{
48
public
:
50
RenderBuffer
();
51
58
RenderBuffer
(
GraphicContext
&context,
int
width,
int
height,
TextureFormat
texture_format =
TextureFormat::rgba8
,
int
multisample_samples = 0);
59
61
bool
is_null
()
const
{
return
!impl; }
62
explicit
operator
bool()
const
{
return
bool(impl); }
63
65
void
throw_if_null
()
const
;
66
68
const
Size
&
get_size
()
const
;
69
73
RenderBufferProvider
*
get_provider
()
const
;
74
76
bool
operator==
(
const
RenderBuffer
&other)
const
;
77
78
private
:
79
std::shared_ptr<RenderBuffer_Impl> impl;
80
};
81
83
}
clan::GraphicContext
Interface to drawing graphics.
Definition:
graphic_context.h:257
clan::RenderBufferProvider
Interface for implementing a RenderBuffer target.
Definition:
render_buffer_provider.h:43
clan::RenderBuffer
Render-buffer object class.
Definition:
render_buffer.h:47
clan::RenderBuffer::is_null
bool is_null() const
Returns true if this object is invalid.
Definition:
render_buffer.h:61
clan::RenderBuffer::operator==
bool operator==(const RenderBuffer &other) const
Equality operator.
clan::RenderBuffer::get_size
const Size & get_size() const
Returns the render buffer size.
clan::RenderBuffer::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::RenderBuffer::get_provider
RenderBufferProvider * get_provider() const
Get Provider.
clan::RenderBuffer::RenderBuffer
RenderBuffer()
Constructs a null instance.
clan::RenderBuffer::RenderBuffer
RenderBuffer(GraphicContext &context, int width, int height, TextureFormat texture_format=TextureFormat::rgba8, int multisample_samples=0)
Constructs a RenderBuffer.
clan::Size
2D (width,height) size structure - Integer
Definition:
size.h:171
clan::TextureFormat
TextureFormat
Texture format.
Definition:
texture_format.h:39
clan::TextureFormat::rgba8
@ rgba8
clan
Definition:
clanapp.h:36