Classes | Macros | Typedefs | Enumerations | Enumerator | Functions | Variables | Friends
clanDisplay Display

## Classes
class | clan::BlendState
| Blend state setup. More...
class | clan::BlendStateDescription
| Blend state description. More...
class | clan::BlendStateProvider
class | clan::Canvas
| 2D Graphics Canvas More...
class | clan::CursorProvider
| Interface for implementing a Cursor target. More...
class | clan::DepthStencilState
| DepthStencil state setup. More...
class | clan::DepthStencilStateDescription
| DepthStencil state description. More...
class | clan::DepthStencilStateProvider
class | clan::Display
| Top level display class. More...
class | clan::DisplayTarget
| Display target for clanDisplay. More...
class | clan::DisplayTargetProvider
| Interface for implementing a DisplayTarget target. More...
class | clan::DisplayWindowProvider
| Interface for implementing a DisplayWindow target. More...
class | clan::DisplayWindowSite
| Display Window site. More...
class | clan::ElementArrayBuffer
| Element Array Buffer. More...
class | clan::ElementArrayBufferProvider
| Element Array Buffer provider. More...
class | clan::ElementArrayVector< Type >
| Element Array Vector. More...
class | clan::FrameBuffer
| Frame-buffer object class. More...
class | clan::FrameBufferProvider
| Interface for implementing a FrameBuffer target. More...
class | clan::GraphicContext
| Interface to drawing graphics. More...
class | clan::GraphicContextProvider
| Interface for implementing a GraphicContext target. More...
class | clan::IconSet
| Icon set class. More...
class | clan::ImageImportDescription
| Image Import Description Class. More...
class | clan::OcclusionQuery
| Graphics occlusion query class. More...
class | clan::PerlinNoise
| Perlin Noise Generator class. More...
class | clan::PixelBuffer
| Pixel data container. More...
class | clan::PixelBufferHelp
| Pixel data helper class. More...
class | clan::PixelBufferLock< Type >
| PixelBuffer locking helper. More...
class | clan::PixelBufferProvider
| Element Array Buffer provider. More...
class | clan::PixelBufferSet
| Set of images that combined form a complete texture. More...
class | clan::PixelConverter
| Low level pixel format converter class. More...
class | clan::PrimitivesArray
| Primitives array description. More...
class | clan::PrimitivesArrayProvider
| Interface for implementing a PrimitivesArray target. More...
class | clan::ProgramObject
| Program Object. More...
class | clan::ProgramObjectProvider
| Program Object provider. More...
class | clan::RasterizerState
| Rasterizer state setup. More...
class | clan::RasterizerStateDescription
| Rasterizer state description. More...
class | clan::RasterizerStateProvider
class | clan::RenderBatcher
| Render batching abstraction. More...
class | clan::RenderBuffer
| Render-buffer object class. More...
class | clan::RenderBufferProvider
| Interface for implementing a RenderBuffer target. More...
class | clan::ScreenInfo
| Screen Information class. More...
class | clan::ShaderEffect
| Shader Feffect. More...
class | clan::ShaderEffectDescription
| Shader Effect Description. More...
class | clan::ShaderObject
| Shader Object. More...
class | clan::ShaderObjectProvider
| Shader Object provider. More...
class | clan::SharedGCData
| Shared Graphic Context Data. More...
class | clan::StorageBuffer
| Storage Buffer. More...
class | clan::StorageBufferProvider
| Storage Buffer provider. More...
class | clan::StorageVector< Type >
| Storage Buffer Vector. More...
class | clan::Texture
| Texture object class. More...
class | clan::Texture1D
| 1D texture object class. More...
class | clan::Texture1DArray
| 1D texture array object class. More...
class | clan::Texture2D
| 2D texture object class. More...
class | clan::Texture2DArray
| 2D texture array object class. More...
class | clan::Texture3D
| 3D texture object class. More...
class | clan::TextureCube
| 2D texture cube object class. More...
class | clan::TextureCubeArray
| 2D texture cube array object class. More...
class | clan::TextureProvider
| Interface for implementing a Texture target. More...
class | clan::TransferBuffer
| Transfer Buffer. More...
class | clan::TransferBufferProvider
| Transfer Buffer provider. More...
class | clan::TransferTexture
| Texture Transfer class. More...
class | clan::TransferVector< Type >
| Transfer Vector. More...
class | clan::UniformBuffer
| Uniform Buffer. More...
class | clan::UniformBufferProvider
| Uniform Buffer provider. More...
class | clan::UniformVector< Type >
| Uniform Buffer Vector. More...
class | clan::VertexArrayBuffer
| Vertex Array Buffer. More...
class | clan::VertexArrayBufferProvider
| Vertex Array Buffer provider. More...
class | clan::VertexArrayVector< Type >
| Vertex Array Vector. More...
class | clan::PrimitivesArrayProvider::VertexData

## Macros
#define | cl_offsetof(s, m) (&(((s *)0)->m))

## Typedefs
typedef PixelBufferLock< signed char > | clan::PixelBufferLock1b
typedef PixelBufferLock< double > | clan::PixelBufferLock1d
typedef PixelBufferLock< float > | clan::PixelBufferLock1f
typedef PixelBufferLock< HalfFloat > | clan::PixelBufferLock1hf
typedef PixelBufferLock< signed int > | clan::PixelBufferLock1i
typedef PixelBufferLock< signed short > | clan::PixelBufferLock1s
typedef PixelBufferLock< unsigned char > | clan::PixelBufferLock1ub
typedef PixelBufferLock< unsigned int > | clan::PixelBufferLock1ui
typedef PixelBufferLock< unsigned short > | clan::PixelBufferLock1us
typedef PixelBufferLock< Vec2b > | clan::PixelBufferLock2b
typedef PixelBufferLock< Vec2d > | clan::PixelBufferLock2d
typedef PixelBufferLock< Vec2f > | clan::PixelBufferLock2f
typedef PixelBufferLock< Vec2hf > | clan::PixelBufferLock2hf
typedef PixelBufferLock< Vec2i > | clan::PixelBufferLock2i
typedef PixelBufferLock< Vec2s > | clan::PixelBufferLock2s
typedef PixelBufferLock< Vec2ub > | clan::PixelBufferLock2ub
typedef PixelBufferLock< Vec2ui > | clan::PixelBufferLock2ui
typedef PixelBufferLock< Vec2us > | clan::PixelBufferLock2us
typedef PixelBufferLock< Vec3b > | clan::PixelBufferLock3b
typedef PixelBufferLock< Vec3d > | clan::PixelBufferLock3d
typedef PixelBufferLock< Vec3f > | clan::PixelBufferLock3f
typedef PixelBufferLock< Vec3hf > | clan::PixelBufferLock3hf
typedef PixelBufferLock< Vec3i > | clan::PixelBufferLock3i
typedef PixelBufferLock< Vec3s > | clan::PixelBufferLock3s
typedef PixelBufferLock< Vec3ub > | clan::PixelBufferLock3ub
typedef PixelBufferLock< Vec3ui > | clan::PixelBufferLock3ui
typedef PixelBufferLock< Vec3us > | clan::PixelBufferLock3us
typedef PixelBufferLock< Vec4b > | clan::PixelBufferLock4b
typedef PixelBufferLock< Vec4d > | clan::PixelBufferLock4d
typedef PixelBufferLock< Vec4f > | clan::PixelBufferLock4f
typedef PixelBufferLock< Vec4hf > | clan::PixelBufferLock4hf
typedef PixelBufferLock< Vec4i > | clan::PixelBufferLock4i
typedef PixelBufferLock< Vec4s > | clan::PixelBufferLock4s
typedef PixelBufferLock< Vec4ub > | clan::PixelBufferLock4ub
typedef PixelBufferLock< Vec4ui > | clan::PixelBufferLock4ui
typedef PixelBufferLock< Vec4us > | clan::PixelBufferLock4us
typedef PixelBufferLock< unsigned char > | clan::PixelBufferLockAny

## Enumerations
enum | clan::BlendEquation { clan::equation_add, clan::equation_subtract, clan::equation_reverse_subtract, clan::equation_min, clan::equation_max }
| Blending equations. More...
enum | clan::BlendFunc { clan::blend_zero, clan::blend_one, clan::blend_dest_color, clan::blend_src_color, clan::blend_one_minus_dest_color, clan::blend_one_minus_src_color, clan::blend_src_alpha, clan::blend_one_minus_src_alpha, clan::blend_dest_alpha, clan::blend_one_minus_dest_alpha, clan::blend_src_alpha_saturate, clan::blend_constant_color, clan::blend_one_minus_constant_color, clan::blend_constant_alpha, clan::blend_one_minus_constant_alpha }
| Blending functions. More...
enum | clan::BufferAccess { clan::access_read_only, clan::access_write_only, clan::access_read_write, clan::access_write_discard }
| Array Buffer access enum. More...
enum | clan::BufferUsage { clan::usage_stream_draw, clan::usage_stream_read, clan::usage_stream_copy, clan::usage_static_draw, clan::usage_static_read, clan::usage_static_copy, clan::usage_dynamic_draw, clan::usage_dynamic_read, clan::usage_dynamic_copy }
| Array Buffer usage enum. More...
enum | clan::CompareFunction { clan::compare_lequal, clan::compare_gequal, clan::compare_less, clan::compare_greater, clan::compare_equal, clan::compare_notequal, clan::compare_always, clan::compare_never }
| Compare functions. More...
enum | clan::CullMode { clan::cull_front, clan::cull_back, clan::cull_front_and_back }
| Polygon culling modes. More...
enum | clan::DrawBuffer { clan::buffer_none, clan::buffer_front_left, clan::buffer_front_right, clan::buffer_back_left, clan::buffer_back_right, clan::buffer_front, clan::buffer_back, clan::buffer_left, clan::buffer_right, clan::buffer_front_and_back }
| Drawing buffers. More...
enum | clan::FaceSide { clan::face_clockwise, clan::face_counter_clockwise }
| Front face modes. More...
enum | clan::FillMode { clan::fill_point, clan::fill_line, clan::fill_polygon }
| Polygon filling modes. More...
enum | clan::FrameBufferBindTarget { clan::framebuffer_draw, clan::framebuffer_read }
| Framebuffer bind target. More...
enum | clan::LogicOp { clan::logic_clear, clan::logic_and, clan::logic_and_reverse, clan::logic_copy, clan::logic_and_inverted, clan::logic_noop, clan::logic_xor, clan::logic_or, clan::logic_nor, clan::logic_equiv, clan::logic_invert, clan::logic_or_reverse, clan::logic_copy_inverted, clan::logic_or_inverted, clan::logic_nand, clan::logic_set }
| Logic Op. More...
enum | clan::MapMode { clan::map_2d_upper_left, clan::map_2d_lower_left, clan::map_user_projection }
| Mapping modes. More...
enum | clan::PixelBufferDirection { clan::data_to_gpu, clan::data_from_gpu }
| Pixel buffer prefered direction. More...
enum | clan::PointSpriteOrigin { clan::origin_upper_left, clan::origin_lower_left }
| Point Sprite Origin. More...
enum | clan::PrimitivesType { clan::type_points, clan::type_line_strip, clan::type_line_loop, clan::type_lines, clan::type_triangle_strip, clan::type_triangle_fan, clan::type_triangles }
| Primitive types. More...
enum | clan::ShaderLanguage { clan::shader_glsl, clan::shader_hlsl, clan::shader_fixed_function, clan::num_shader_languages }
| Shader language used. More...
enum | clan::ShaderType { clan::shadertype_vertex, clan::shadertype_geometry, clan::shadertype_fragment, clan::shadertype_tess_evaluation, clan::shadertype_tess_control, clan::shadertype_compute, clan::shadertype_num_types }
| Shader Type. More...
enum | clan::StandardProgram { clan::program_color_only, clan::program_single_texture, clan::program_sprite, clan::program_path }
| Standard Program. More...
enum | clan::StencilOp { clan::stencil_keep, clan::stencil_zero, clan::stencil_replace, clan::stencil_incr, clan::stencil_decr, clan::stencil_invert, clan::stencil_incr_wrap, clan::stencil_decr_wrap }
| Stencil operations. More...
enum | clan::TextureCompareMode { clan::comparemode_none, clan::comparemode_compare_r_to_texture }
| Texture compare modes. More...
enum | clan::TextureCubeDirection { clan::cl_cube_positive_x, clan::cl_cube_negative_x, clan::cl_cube_positive_y, clan::cl_cube_negative_y, clan::cl_cube_positive_z, clan::cl_cube_negative_z }
| Texture cube directions. More...
enum | clan::TextureDimensions { clan::texture_1d, clan::texture_1d_array, clan::texture_2d, clan::texture_2d_array, clan::texture_3d, clan::texture_cube, clan::texture_cube_array }
| Texture dimensions. More...
enum | clan::TextureFilter { clan::filter_nearest, clan::filter_linear, clan::filter_nearest_mipmap_nearest, clan::filter_nearest_mipmap_linear, clan::filter_linear_mipmap_nearest, clan::filter_linear_mipmap_linear }
| Texture filters. More...
enum | clan::TextureFormat { clan::tf_rgba8, clan::tf_rgb8, clan::tf_bgra8, clan::tf_bgr8, clan::tf_stencil_index1, clan::tf_stencil_index4, clan::tf_stencil_index8, clan::tf_stencil_index16, clan::tf_r8, clan::tf_r8_snorm, clan::tf_r16, clan::tf_r16_snorm, clan::tf_rg8, clan::tf_rg8_snorm, clan::tf_rg16, clan::tf_rg16_snorm, clan::tf_r3_g3_b2, clan::tf_rgb4, clan::tf_rgb5, clan::tf_rgb8_snorm, clan::tf_rgb10, clan::tf_rgb12, clan::tf_rgb16, clan::tf_rgb16_snorm, clan::tf_rgba2, clan::tf_rgba4, clan::tf_rgb5_a1, clan::tf_rgba8_snorm, clan::tf_rgb10_a2, clan::tf_rgba12, clan::tf_rgba16, clan::tf_rgba16_snorm, clan::tf_srgb8, clan::tf_srgb8_alpha8, clan::tf_r16f, clan::tf_rg16f, clan::tf_rgb16f, clan::tf_rgba16f, clan::tf_r32f, clan::tf_rg32f, clan::tf_rgb32f, clan::tf_rgba32f, clan::tf_r11f_g11f_b10f, clan::tf_rgb9_e5, clan::tf_r8i, clan::tf_r8ui, clan::tf_r16i, clan::tf_r16ui, clan::tf_r32i, clan::tf_r32ui, clan::tf_rg8i, clan::tf_rg8ui, clan::tf_rg16i, clan::tf_rg16ui, clan::tf_rg32i, clan::tf_rg32ui, clan::tf_rgb8i, clan::tf_rgb8ui, clan::tf_rgb16i, clan::tf_rgb16ui, clan::tf_rgb32i, clan::tf_rgb32ui, clan::tf_rgba8i, clan::tf_rgba8ui, clan::tf_rgba16i, clan::tf_rgba16ui, clan::tf_rgba32i, clan::tf_rgba32ui, clan::tf_depth_component16, clan::tf_depth_component24, clan::tf_depth_component32, clan::tf_depth_component32f, clan::tf_depth24_stencil8, clan::tf_depth32f_stencil8, clan::tf_compressed_red, clan::tf_compressed_rg, clan::tf_compressed_rgb, clan::tf_compressed_rgba, clan::tf_compressed_srgb, clan::tf_compressed_srgb_alpha, clan::tf_compressed_red_rgtc1, clan::tf_compressed_signed_red_rgtc1, clan::tf_compressed_rg_rgtc2, clan::tf_compressed_signed_rg_rgtc2, clan::tf_compressed_rgb_s3tc_dxt1, clan::tf_compressed_rgba_s3tc_dxt1, clan::tf_compressed_rgba_s3tc_dxt3, clan::tf_compressed_rgba_s3tc_dxt5, clan::tf_compressed_srgb_s3tc_dxt1, clan::tf_compressed_srgb_alpha_s3tc_dxt1, clan::tf_compressed_srgb_alpha_s3tc_dxt3, clan::tf_compressed_srgb_alpha_s3tc_dxt5 }
| Texture format. More...
enum | clan::TextureImageYAxis { clan::y_axis_bottom_up, clan::y_axis_top_down }
| Y axis direction for viewports, clipping rects, textures and render targets. More...
enum | clan::TextureSubtype { clan::subtype_cube_map_positive_x, clan::subtype_cube_map_negative_x, clan::subtype_cube_map_positive_y, clan::subtype_cube_map_negative_y, clan::subtype_cube_map_positive_z, clan::subtype_cube_map_negative_z }
| Texture Subtype. More...
enum | clan::TextureWrapMode { clan::wrap_clamp_to_edge, clan::wrap_repeat, clan::wrap_mirrored_repeat }
| Texture coordinate wrapping modes. More...
enum | clan::VertexAttributeDataType { clan::type_unsigned_byte, clan::type_unsigned_short, clan::type_unsigned_int, clan::type_byte, clan::type_short, clan::type_int, clan::type_float }
| Primitives array description. More...

## Functions
virtual | clan::BlendStateProvider::~BlendStateProvider ()
virtual | clan::DepthStencilStateProvider::~DepthStencilStateProvider ()
virtual | clan::RasterizerStateProvider::~RasterizerStateProvider ()
static void | clan::SharedGCData::add_disposable (DisposableObject *disposable)
| Add disposable. More...
static void | clan::SharedGCData::add_provider (GraphicContextProvider *provider)
| Add a provider. More...
static void | clan::SharedGCData::add_ref ()
| Add ref. More...
static std::vector< GraphicContextProvider * > & | clan::SharedGCData::get_gc_providers (std::unique_ptr< std::unique_lock< std::recursive_mutex >> &mutex_section)
| Get the providers. More...
static GraphicContextProvider * | clan::SharedGCData::get_provider (std::unique_ptr< std::unique_lock< std::recursive_mutex >> &mutex_section)
| Get a provider. More...
bool | clan::BlendStateDescription::operator< (const BlendStateDescription &other) const
bool | clan::DepthStencilStateDescription::operator< (const DepthStencilStateDescription &other) const
bool | clan::RasterizerStateDescription::operator< (const RasterizerStateDescription &other) const
bool | clan::BlendStateDescription::operator== (const BlendStateDescription &other) const
bool | clan::DepthStencilStateDescription::operator== (const DepthStencilStateDescription &other) const
bool | clan::RasterizerStateDescription::operator== (const RasterizerStateDescription &other) const
static void | clan::SharedGCData::release_ref ()
| Release ref. More...
static void | clan::SharedGCData::remove_disposable (DisposableObject *disposable)
| Remove disposable. More...
static void | clan::SharedGCData::remove_provider (GraphicContextProvider *provider)
| Remove a provider. More...

## Variables
const float | clan::pixelcenter_constant = 0.375f

## Friends
class | clan::ShaderEffectDescription::ShaderEffect

## Construction
| clan::Canvas::Canvas ()
| Constructs a null instance. More...
| clan::Canvas::Canvas (Canvas &canvas, FrameBuffer &framebuffer)
| Constructs a Canvas based on a framebuffer. (based on the copy of the canvas) More...
| clan::Canvas::Canvas (DisplayWindow &window)
| Constructs a Canvas. More...
| clan::Canvas::~Canvas ()

## Attributes
Canvas | clan::Canvas::create ()
| Create a copy of a canvas. More...
bool | clan::Canvas::is_null () const
| Returns true if this object is invalid. More...
void | clan::Canvas::throw_if_null () const
| Throw an exception if this object is invalid. More...
GraphicContext & | clan::Canvas::get_gc () const
| Get gc. More...
const Mat4f & | clan::Canvas::get_transform () const
| Returns the current effective transform matrix. More...
Mat4f & | clan::Canvas::get_inverse_transform ()
| Returns the inverse of the current effective transform matrix. More...
const Mat4f & | clan::Canvas::get_projection () const
| Returns the current effective projection matrix. More...
| clan::Canvas::operator GraphicContext & () const
float | clan::Canvas::get_width () const
| Returns the current width of the context. More...
float | clan::Canvas::get_height () const
| Returns the current height of the context. More...
Sizef | clan::Canvas::get_size () const
| Returns the current size of the context. More...
Rectf | clan::Canvas::get_cliprect () const
| Returns the current clipping rectangle. More...
PixelBuffer | clan::Canvas::get_pixeldata (const Rect &rect, TextureFormat texture_format=tf_rgba8, bool clamp=true)
| Return the content of the read buffer into a pixel buffer. More...
PixelBuffer | clan::Canvas::get_pixeldata (TextureFormat texture_format=tf_rgba8, bool clamp=true)
| Return the content of the read buffer into a pixel buffer. More...
float | clan::Canvas::get_pixel_ratio () const

## Operations
void | clan::Canvas::set_rasterizer_state (const RasterizerState &state)
| Set active rasterizer state. More...
void | clan::Canvas::set_blend_state (const BlendState &state, const Colorf &blend_color=Colorf::white, unsigned int sample_mask=0xffffffff)
| Set active blend state. More...
void | clan::Canvas::set_depth_stencil_state (const DepthStencilState &state, int stencil_ref=0)
| Set active depth stencil state. More...
void | clan::Canvas::reset_rasterizer_state ()
| Set active rasterizer state. More...
void | clan::Canvas::reset_blend_state ()
| Set active blend state. More...
void | clan::Canvas::reset_depth_stencil_state ()
| Set active depth stencil state. More...
void | clan::Canvas::set_cliprect (const Rectf &rect)
| Set the current clipping rectangle. More...
void | clan::Canvas::push_cliprect (const Rectf &rect)
| Push current clipping rectangle to stack. More...
void | clan::Canvas::push_cliprect ()
| Push cliprect. More...
void | clan::Canvas::pop_cliprect ()
| Pop current clipping rectangle from the stack. More...
void | clan::Canvas::reset_cliprect ()
| Removes the set clipping rectangle and empties the cliprect stack. More...
void | clan::Canvas::clear (const Colorf &color=Colorf::black)
| Clears the whole context using the specified color. More...
void | clan::Canvas::clear_stencil (int value=0)
| Clear the stencil buffer. More...
void | clan::Canvas::clear_depth (float value=0)
| Clear the depth buffer. More...
void | clan::Canvas::set_program_object (StandardProgram standard_program)
| Set active program object to the standard program specified. More...
void | clan::Canvas::set_map_mode (MapMode mode)
| Set the projection mapping mode. More...
void | clan::Canvas::set_projection (const Mat4f &matrix)
| Set the projection matrix to be used in user projection map mode. More...
void | clan::Canvas::set_batcher (RenderBatcher *batcher)
| Specifies which render batcher is to be currently active. More...
void | clan::Canvas::set_transform (const Mat4f &matrix)
| Sets the transform matrix to a new matrix. More...
void | clan::Canvas::mult_transform (const Mat4f &matrix)
| Multiplies the passed matrix onto the transform matrix. More...
void | clan::Canvas::flush ()
| Flushes the render batcher currently active. More...
void | clan::Canvas::draw_point (float x1, float y1, const Colorf &color)
| Draw a point. More...
void | clan::Canvas::draw_point (const Pointf &point, const Colorf &color)
| Point. More...
void | clan::Canvas::draw_line (float x1, float y1, float x2, float y2, const Colorf &color=Colorf::white)
| Draw a line. More...
void | clan::Canvas::draw_line (const Pointf &start, const Pointf &end, const Colorf &color=Colorf::white)
| Line. More...
void | clan::Canvas::draw_line (const LineSegment2f &line_segment, const Colorf &color=Colorf::white)
| Line. More...
void | clan::Canvas::draw_lines (const Vec2f *positions, int num_vertices, const Colorf &color=Colorf::white)
| Lines. More...
void | clan::Canvas::draw_lines (const Vec2f *line_positions, const Vec2f *texture_positions, int num_vertices, const Texture2D &texture, const Colorf &line_color=Colorf::white)
| Lines. More...
void | clan::Canvas::draw_line_strip (const Vec2f *positions, int num_vertices, const Colorf &color=Colorf::white)
| Line Strip. More...
void | clan::Canvas::draw_box (float x1, float y1, float x2, float y2, const Colorf &color=Colorf::white)
| Draw a box / rectangle. More...
void | clan::Canvas::draw_box (const Pointf &start, const Pointf &end, const Colorf &color=Colorf::white)
| Box. More...
void | clan::Canvas::draw_box (const Rectf &rect, const Colorf &color)
| Box. More...
void | clan::Canvas::fill_rect (float x1, float y1, float x2, float y2, const Colorf &color=Colorf::white)
| Draw a filled box / rectangle. More...
void | clan::Canvas::fill_rect (const Pointf &start, const Pointf &end, const Colorf &color=Colorf::white)
| Fill. More...
void | clan::Canvas::fill_rect (const Rectf &rect, const Colorf &color)
| Fill. More...
void | clan::Canvas::fill_rect (float x1, float y1, float x2, float y2, const Gradient &color)
| Gradient fill. More...
void | clan::Canvas::fill_rect (const Pointf &start, const Pointf &end, const Gradient &gradient)
| Gradient fill. More...
void | clan::Canvas::fill_rect (const Rectf &rect, const Gradient &gradient)
| Gradient fill. More...
void | clan::Canvas::fill_circle (float center_x, float center_y, float radius, const Colorf &color=Colorf::white)
| Draw a circle. More...
void | clan::Canvas::fill_circle (const Pointf &center, float radius, const Colorf &color=Colorf::white)
| Circle. More...
void | clan::Canvas::fill_circle (const Pointf &center, float radius, const Gradient &gradient)
| Gradient circle. More...
void | clan::Canvas::fill_circle (const Pointf &center, const Pointf &centergradient, float radius, const Gradient &gradient)
| Gradient circle. More...
void | clan::Canvas::fill_triangle (const Pointf &a, const Pointf &b, const Pointf &c, const Colorf &color=Colorf::white)
| Draw a triangle. More...
void | clan::Canvas::fill_triangle (const Trianglef &dest_triangle, const Colorf &color=Colorf::white)
| Draw a triangle. More...
void | clan::Canvas::fill_triangles (const Vec2f *triangle_positions, int num_vertices, const Colorf &color=Colorf::white)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const Vec2f *triangle_positions, int num_vertices, const Gradient &gradient)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const Vec2f *triangle_positions, const Colorf *colors, int num_vertices)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const std::vector< Vec2f > &triangles, const Colorf *colors)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const std::vector< Vec2f > &triangles, const Colorf &color=Colorf::white)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const std::vector< Vec2f > &triangles, const Gradient &gradient)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const Vec2f *positions, const Vec2f *texture_positions, int num_vertices, const Texture2D &texture, const Colorf &color=Colorf::white)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const Vec2f *positions, const Vec2f *texture_positions, int num_vertices, const Texture2D &texture, const Colorf *colors)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const std::vector< Vec2f > &positions, const std::vector< Vec2f > &texture_positions, const Texture2D &texture, const Colorf &color=Colorf::white)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const std::vector< Vec2f > &positions, const std::vector< Vec2f > &texture_positions, const Texture2D &texture, const std::vector< Colorf > &colors)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const std::vector< Vec2f > &positions, const Texture2D &texture, const Colorf &color=Colorf::white)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const std::vector< Vec2f > &positions, const Texture2D &texture, const Rect &texture_rect, const Colorf &color=Colorf::white)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const Vec2f *triangle_positions, int num_vertices, const Texture2D &texture, const Colorf &color=Colorf::white)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const Vec2f *triangle_positions, int num_vertices, const Texture2D &texture, const Rect &texture_rect, const Colorf &color=Colorf::white)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const std::vector< Vec2f > &positions, const Texture2D &texture, const Gradient &gradient)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const std::vector< Vec2f > &positions, const Texture2D &texture, const Rect &texture_rect, const Gradient &gradient)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const Vec2f *triangle_positions, int num_vertices, const Texture2D &texture, const Gradient &gradient)
| Draw triangles. More...
void | clan::Canvas::fill_triangles (const Vec2f *triangle_positions, int num_vertices, const Texture2D &texture, const Rect &texture_rect, const Gradient &gradient)
| Draw triangles. More...
void | clan::Canvas::fill_ellipse (const Pointf &center, float radius_x, float radius_y, const Colorf &color=Colorf::white)
| Draw a filled ellipse. More...
void | clan::Canvas::fill_ellipse (const Pointf &center, float radius_x, float radius_y, const Gradient &gradient)
| Draw a gradient filled ellipse. More...
Pointf | clan::Canvas::grid_fit (const Pointf &pos)
| Snaps the point to the nearest pixel corner. More...

## Implementation
class | clan::Canvas::Sprite_Impl
class | clan::Canvas::Image
class | clan::Canvas::Font_Impl
class | clan::Canvas::Font_DrawSubPixel
class | clan::Canvas::Font_DrawFlat
class | clan::Canvas::Font_DrawScaled
class | clan::Canvas::Path

## Attributes
static DisplayTarget | clan::Display::get_current_target ()
| Returns the currently selected display target. More...

## Operations
static void | clan::Display::set_current_target (const DisplayTarget &target)
| Sets the currently selected display target. More...
static void | clan::Display::remove_target (const DisplayTarget &target)
| Remove the target from the target list. More...

## Construction
| clan::DisplayTarget::DisplayTarget (DisplayTargetProvider *provider)
| Constructs a DisplayTarget. More...
virtual | clan::DisplayTarget::~DisplayTarget ()

## Attributes
DisplayTargetProvider * | clan::DisplayTarget::get_provider ()
| Returns the provider for the display target. More...
bool | clan::DisplayTarget::is_null () const
| Returns true if this object is invalid. More...
void | clan::DisplayTarget::throw_if_null () const
| Throw an exception if this object is invalid. More...

## Operations
void | clan::DisplayTarget::set_current ()
| Set this display target to be the current target. More...

## Implementation
class | clan::DisplayTarget::DisplayTarget_Impl

## Construction
| clan::IconSet::IconSet ()
| Constructs an icon set. More...

## Attributes
std::vector< PixelBuffer > | clan::IconSet::get_images () const
| Returns all the images in the icon set. More...

## Operations
void | clan::IconSet::add_image (const PixelBuffer &image)
| Adds an image to the icon set. More...
DataBuffer | clan::IconSet::create_win32_icon ()
| Generates a Windows .ICO format icon from the set. More...

## Construction
| clan::ImageImportDescription::ImageImportDescription ()
| Constructs a image import description with default values. More...
| clan::ImageImportDescription::~ImageImportDescription ()

## Attributes
bool | clan::ImageImportDescription::get_premultiply_alpha () const
| Returns the premultiply alpha setting. More...
bool | clan::ImageImportDescription::flip_vertical () const
| Returns the flip vertical setting. More...
bool | clan::ImageImportDescription::is_srgb () const
| Returns the sRGB setting. More...
bool | clan::ImageImportDescription::is_cached () const
| Returns if this image should be cached. More...

## Operations
PixelBuffer | clan::ImageImportDescription::process (PixelBuffer &image) const
| Process the pixel buffers depending of the chosen settings. More...
void | clan::ImageImportDescription::set_premultiply_alpha (bool enable)
| Set the premultiply alpha setting. More...
void | clan::ImageImportDescription::set_flip_vertical (bool enable)
| Set the flip vertical setting. More...
void | clan::ImageImportDescription::set_srgb (bool enable)
| Controls if the image is uploaded as a sRGB texture or not. More...
void | clan::ImageImportDescription::set_cached (bool enable)
| Controls if this image can be cached. More...

## Callbacks
std::function< PixelBuffer(PixelBuffer &)> & | clan::ImageImportDescription::func_process ()
| User defined fine control of the pixel buffer. More...

## Construction
| clan::PerlinNoise::PerlinNoise ()
| Constructor. More...
virtual | clan::PerlinNoise::~PerlinNoise ()
| Destructor. More...

## Attributes
PixelBuffer | clan::PerlinNoise::create_noise1d (float start_x, float end_x)
| Create the perlin noise. More...
PixelBuffer | clan::PerlinNoise::create_noise2d (float start_x, float end_x, float start_y, float end_y)
| Create the perlin noise. More...
PixelBuffer | clan::PerlinNoise::create_noise3d (float start_x, float end_x, float start_y, float end_y, float z_position)
| Create the perlin noise. More...
PixelBuffer | clan::PerlinNoise::create_noise4d (float start_x, float end_x, float start_y, float end_y, float z_position, float w_position)
| Create the perlin noise. More...
Size | clan::PerlinNoise::get_size () const
| Get the size of the output pixelbuffer. More...
TextureFormat | clan::PerlinNoise::get_format () const
| Get the format of the output pixelbuffer. More...
float | clan::PerlinNoise::get_amplitude () const
| Get the amplitude of the perlin noise. More...
int | clan::PerlinNoise::get_octaves () const
| Get the number of octaves of the perlin noise. More...

## Operations
void | clan::PerlinNoise::set_permutations (const unsigned char *table, unsigned int size=256)
| Set the permutation table. More...
void | clan::PerlinNoise::set_size (int width=256, int height=256)
| Set the size of the output pixelbuffer. More...
void | clan::PerlinNoise::set_size (const Size &size)
| Set the size of the output pixelbuffer. More...
void | clan::PerlinNoise::set_format (TextureFormat texture_format=tf_rgb8)
| Set the format of the output pixelbuffer. More...
void | clan::PerlinNoise::set_amplitude (float amplitude=1.0f)
| Set the amplitude of the perlin noise. More...
void | clan::PerlinNoise::set_octaves (int octaves=1)
| Set the number of octaves of the perlin noise. More...

## Construction
| clan::PixelBuffer::PixelBuffer ()
| Constructs a null instance. More...
| clan::PixelBuffer::PixelBuffer (int width, int height, TextureFormat texture_format, const void *data=nullptr, bool only_reference_data=false)
| Constructs a PixelBuffer. More...
| clan::PixelBuffer::PixelBuffer (const std::string &fullname, bool srgb=false)
| Constructs a PixelBuffer. More...
| clan::PixelBuffer::PixelBuffer (const std::string &filename, const FileSystem &file_system, bool srgb=false)
| Constructs a PixelBuffer. More...
| clan::PixelBuffer::PixelBuffer (IODevice &file, const std::string &image_type, bool srgb=false)
| Constructs a PixelBuffer. More...
| clan::PixelBuffer::PixelBuffer (PixelBufferProvider *provider)
| Constructs a PixelBuffer. More...
virtual | clan::PixelBuffer::~PixelBuffer ()

## Attributes
bool | clan::PixelBuffer::is_null () const
| Returns true if this object is invalid. More...
void | clan::PixelBuffer::throw_if_null () const
| Throw an exception if this object is invalid. More...
PixelBuffer | clan::PixelBuffer::copy () const
| Create a copy of the pixelbuffer that doesn't share data with the original pixel buffer. More...
PixelBuffer | clan::PixelBuffer::copy (const Rect &rect) const
| Create a copy of the pixelbuffer that doesn't share data with the original pixel buffer. More...
int | clan::PixelBuffer::get_width () const
| Retrieves the actual width of the buffer. More...
int | clan::PixelBuffer::get_height () const
| Retrieves the actual height of the buffer. More...
Size | clan::PixelBuffer::get_size () const
| Retrieves the actual size of the buffer. More...
int | clan::PixelBuffer::get_pitch () const
| Returns the pitch (in bytes per scanline). More...
float | clan::PixelBuffer::get_pixel_ratio () const
float | clan::PixelBuffer::get_dip_width () const
| Returns the device independent width of this texture. More...
float | clan::PixelBuffer::get_dip_height () const
| Returns the device independent height of this texture. More...
Sizef | clan::PixelBuffer::get_dip_size () const
| Returns the device independent size of this texture. More...
void * | clan::PixelBuffer::get_data ()
| Returns a pointer to the beginning of the pixel buffer. More...
const void * | clan::PixelBuffer::get_data () const
bool | clan::PixelBuffer::is_gpu () const
| Returns true if this pixel buffer is a GPU based one. More...
template<typename Type >
Type * | clan::PixelBuffer::get_data ()
template<typename Type >
const Type * | clan::PixelBuffer::get_data () const
unsigned char * | clan::PixelBuffer::get_data_uint8 ()
| Returns a pointer to the beginning of the pixel buffer as 8 bit data. More...
const unsigned char * | clan::PixelBuffer::get_data_uint8 () const
unsigned short * | clan::PixelBuffer::get_data_uint16 ()
| Returns a pointer to the beginning of the pixel buffer as 16 bit data. More...
const unsigned short * | clan::PixelBuffer::get_data_uint16 () const
unsigned int * | clan::PixelBuffer::get_data_uint32 ()
| Returns a pointer to the beginning of the pixel buffer as 32 bit data. More...
const unsigned int * | clan::PixelBuffer::get_data_uint32 () const
void * | clan::PixelBuffer::get_line (int line)
| Returns a pointer to the beginning of a specific line. More...
const void * | clan::PixelBuffer::get_line (int line) const
unsigned char * | clan::PixelBuffer::get_line_uint8 (int line)
| Returns a pointer to the beginning of a specific line as 8 bit data. More...
const unsigned char * | clan::PixelBuffer::get_line_uint8 (int line) const
unsigned short * | clan::PixelBuffer::get_line_uint16 (int line)
| Returns a pointer to the beginning of a specific line as 16 bit data. More...
const unsigned short * | clan::PixelBuffer::get_line_uint16 (int line) const
unsigned int * | clan::PixelBuffer::get_line_uint32 (int line)
| Returns a pointer to the beginning of a specific line as 32 bit data. More...
const unsigned int * | clan::PixelBuffer::get_line_uint32 (int line) const
bool | clan::PixelBuffer::has_transparency () const
| Returns true if format has an alpha channel. More...
unsigned int | clan::PixelBuffer::get_bytes_per_pixel () const
| Returns the number of bytes per pixel. More...
unsigned int | clan::PixelBuffer::get_bytes_per_block () const
| Returns the number of bytes per compression block. More...
unsigned int | clan::PixelBuffer::get_data_size () const
| Returns the size in bytes of the image data. More...
static unsigned int | clan::PixelBuffer::get_data_size (const Size &size, TextureFormat texture_format)
| Returns the size in bytes of the image data. More...
static unsigned int | clan::PixelBuffer::get_bytes_per_pixel (TextureFormat texture_format)
| Returns the number of bytes per pixel. More...
static unsigned int | clan::PixelBuffer::get_bytes_per_block (TextureFormat texture_format)
| Returns the number of bytes per compression block. More...
bool | clan::PixelBuffer::is_compressed () const
| Returns true if compressed. More...
static bool | clan::PixelBuffer::is_compressed (TextureFormat texture_format)
| Returns true if compressed. More...
TextureFormat | clan::PixelBuffer::get_format () const
| Returns the pixel format. More...
PixelBufferProvider * | clan::PixelBuffer::get_provider () const
| Get Provider. More...
Colorf | clan::PixelBuffer::get_pixel (int x, int y)
| Return color of pixel at the specified coordinates. More...

## Operations
void | clan::PixelBuffer::lock (GraphicContext &gc, BufferAccess access)
| Maps buffer into system memory. More...
void | clan::PixelBuffer::unlock ()
| Unmaps element buffer. More...
void | clan::PixelBuffer::upload_data (GraphicContext &gc, const Rect &dest_rect, const void *data)
| Uploads data to buffer. More...
void | clan::PixelBuffer::set_image (const PixelBuffer &source)
| Copy source pixel buffer into this buffer, doing a format conversion if needed. More...
void | clan::PixelBuffer::set_image (const PixelBuffer &source, PixelConverter &converter)
| Copy source pixel buffer into this buffer, doing a format conversion if needed. More...
void | clan::PixelBuffer::set_subimage (const PixelBuffer &source, const Point &dest_pos, const Rect &src_rect)
| Copy source pixel buffer into this buffer, doing a format conversion if needed. More...
void | clan::PixelBuffer::set_subimage (const PixelBuffer &source, const Point &dest_pos, const Rect &src_rect, PixelConverter &converter)
| Copy source pixel buffer into this buffer, doing a format conversion if needed. More...
PixelBuffer | clan::PixelBuffer::to_cpu (GraphicContext &gc)
| Downloads the pixel buffer to CPU memory. More...
PixelBuffer | clan::PixelBuffer::to_gpu (GraphicContext &gc)
| Uploads the pixel buffer to GPU memory. More...
PixelBuffer | clan::PixelBuffer::to_format (TextureFormat texture_format) const
| Converts current buffer to a new pixel format and returns the result. More...
PixelBuffer | clan::PixelBuffer::to_format (TextureFormat texture_format, PixelConverter &converter) const
| Converts current buffer to a new pixel format and returns the result. More...
void | clan::PixelBuffer::flip_vertical ()
| Flip the entire image vertically (turn it upside down) More...
void | clan::PixelBuffer::premultiply_alpha ()
| Multiply the RGB components by the Alpha component. More...
void | clan::PixelBuffer::premultiply_gamma (float gamma)
| Multiply the RGB components by gamma value. More...
void | clan::PixelBuffer::set_pixel_ratio (float ratio)
| Sets the display pixel ratio for this texture. More...

## Implementation
class | clan::PixelBuffer::PixelBuffer_Impl

## Operations
static PixelBuffer | clan::PixelBufferHelp::add_border (const PixelBuffer &pb, int border_size, const Rect &rect)
| Add a border around a pixelbuffer, duplicating the edge pixels. More...

## Construction
| clan::PixelBufferLock< Type >::PixelBufferLock (GraphicContext &gc, PixelBuffer &pixel_buffer, BufferAccess access, bool lock_pixelbuffer=true)
| Constructs a gpu pixel buffer lock. More...
| clan::PixelBufferLock< Type >::PixelBufferLock (PixelBuffer &pixel_buffer, bool lock_pixelbuffer=true)
| Constructs a system pixel buffer lock. More...
| clan::PixelBufferLock< Type >::~PixelBufferLock ()

## Attributes
int | clan::PixelBufferLock< Type >::get_lock_count () const
| Returns the amounts of recursive pixel_buffer locks performed by this section. More...
Type * | clan::PixelBufferLock< Type >::get_data ()
Type * | clan::PixelBufferLock< Type >::get_row (int y)
Type & | clan::PixelBufferLock< Type >::get_pixel (int x, int y)
int | clan::PixelBufferLock< Type >::get_width () const
int | clan::PixelBufferLock< Type >::get_height () const
int | clan::PixelBufferLock< Type >::get_pitch () const

## Operations
void | clan::PixelBufferLock< Type >::lock (GraphicContext &gc, BufferAccess access)
| Lock the gpu pixel_buffer. More...
void | clan::PixelBufferLock< Type >::lock ()
| Lock the system pixel_buffer. More...
void | clan::PixelBufferLock< Type >::unlock ()
| Unlock pixel_buffer. More...

## Construction
| clan::PixelBufferSet::PixelBufferSet ()
| Constructs a null instance. More...
| clan::PixelBufferSet::PixelBufferSet (TextureDimensions dimensions, TextureFormat format, int width, int height=1, int slices=1)
| Constructs an image set of the specified dimensions type and internal format. More...
| clan::PixelBufferSet::PixelBufferSet (const PixelBuffer &image)
| Constructs an image set with a single image using the dimensions and internal format of the pixel buffer. More...

## Attributes
bool | clan::PixelBufferSet::is_null () const
| Returns true if this object is invalid. More...
void | clan::PixelBufferSet::throw_if_null () const
| Throw an exception if this object is invalid. More...
TextureDimensions | clan::PixelBufferSet::get_dimensions () const
| Returns the texture dimensions used by the image set. More...
TextureFormat | clan::PixelBufferSet::get_format () const
| Returns the internal texture format used by the image. More...
int | clan::PixelBufferSet::get_width () const
| Returns the width of the image. More...
int | clan::PixelBufferSet::get_height () const
| Returns the height of the image. More...
int | clan::PixelBufferSet::get_slice_count () const
| Returns the number of depth/array/cube slices in the set. More...
int | clan::PixelBufferSet::get_base_level () const
| Returns the lowest mip level specified in the set. More...
int | clan::PixelBufferSet::get_max_level () const
| Returns the highest mip level specified in the set. More...
PixelBuffer | clan::PixelBufferSet::get_image (int slice, int level)
| Returns the pixel buffer for a specific slice and level. More...

## Operations
void | clan::PixelBufferSet::set_image (int slice, int level, const PixelBuffer &image)
| Set the pixel buffer to be used for the specified slice and level. More...

## Construction
| clan::PixelConverter::PixelConverter ()
| Constructs a pixel format converter. More...
| clan::PixelConverter::~PixelConverter ()

## Attributes
bool | clan::PixelConverter::get_premultiply_alpha () const
| Returns the premultiply alpha setting. More...
bool | clan::PixelConverter::flip_vertical () const
| Returns the flip vertical setting. More...
float | clan::PixelConverter::get_gamma () const
| Returns the gamma setting. More...
Vec4i | clan::PixelConverter::get_swizzle () const
| Returns the input channel used for each output channel. More...
bool | clan::PixelConverter::get_input_is_ycrcb () const
| Returns the JPEG JFIF YCrCb input setting. More...
bool | clan::PixelConverter::get_output_is_ycrcb () const
| Returns the JPEG JFIF YCrCb output setting. More...

## Operations
void | clan::PixelConverter::set_premultiply_alpha (bool enable)
| Set the premultiply alpha setting. More...
void | clan::PixelConverter::set_flip_vertical (bool enable)
| Set the flip vertical setting. More...
void | clan::PixelConverter::set_gamma (float gamma)
| Set the gamma applied when converting. More...
void | clan::PixelConverter::set_swizzle (int red_source, int green_source, int blue_source, int alpha_source)
| Set the input channel used for each output channel. More...
void | clan::PixelConverter::set_swizzle (const Vec4i &swizzle)
void | clan::PixelConverter::set_input_is_ycrcb (bool enable)
| Converts from JPEG JFIF YCrCb. More...
void | clan::PixelConverter::set_output_is_ycrcb (bool enable)
| Converts to JPEG JFIF YCrCb. More...
void | clan::PixelConverter::convert (void *output, int output_pitch, TextureFormat output_format, const void *input, int input_pitch, TextureFormat input_format, int width, int height)
| Convert some pixel data. More...

## Construction
| clan::BlendState::BlendState ()
| Constructs a null instance. More...
| clan::BlendState::BlendState (GraphicContext &context, const BlendStateDescription &desc)
| Constructs a Texture. More...

## Attributes
bool | clan::BlendState::is_null () const
| Returns true if this object is invalid. More...
BlendStateProvider * | clan::BlendState::get_provider () const

## Construction
| clan::BlendStateDescription::BlendStateDescription ()
BlendStateDescription | clan::BlendStateDescription::clone () const
static BlendStateDescription | clan::BlendStateDescription::blend (bool src_premultiplied, bool dest_premultiplied=true)
static BlendStateDescription | clan::BlendStateDescription::opaque ()

## Attributes
bool | clan::BlendStateDescription::is_blending_enabled () const
void | clan::BlendStateDescription::get_blend_equation (BlendEquation &out_color, BlendEquation &out_alpha) const
void | clan::BlendStateDescription::get_blend_function (BlendFunc &out_src, BlendFunc &out_dest, BlendFunc &out_src_alpha, BlendFunc &out_dest_alpha) const
void | clan::BlendStateDescription::get_color_write (bool &out_red, bool &out_green, bool &out_blue, bool &out_alpha) const
bool | clan::BlendStateDescription::is_logic_op_enabled () const
LogicOp | clan::BlendStateDescription::get_logic_op () const

## Operations
void | clan::BlendStateDescription::enable_blending (bool value)
| Enable/Disable blending. More...
void | clan::BlendStateDescription::set_blend_equation (BlendEquation color, BlendEquation alpha)
| Set the constant color used in the blend equations. More...
void | clan::BlendStateDescription::set_blend_function (BlendFunc src, BlendFunc dest, BlendFunc src_alpha, BlendFunc dest_alpha)
| Set the blend functions. More...
void | clan::BlendStateDescription::enable_color_write (bool red, bool green, bool blue, bool alpha)
| Enable/disable writing to the color buffer. More...
void | clan::BlendStateDescription::enable_logic_op (bool enabled)
| Enable/disable logic op. (clanGL only) More...
void | clan::BlendStateDescription::set_logic_op (LogicOp op)
| Set logic operation. (clanGL only) More...

## Construction
| clan::DepthStencilState::DepthStencilState ()
| Constructs a null instance. More...
| clan::DepthStencilState::DepthStencilState (GraphicContext &context, const DepthStencilStateDescription &desc)
| Constructs a Texture. More...

## Attributes
bool | clan::DepthStencilState::is_null () const
| Returns true if this object is invalid. More...
DepthStencilStateProvider * | clan::DepthStencilState::get_provider () const

## Construction
| clan::DepthStencilStateDescription::DepthStencilStateDescription ()
DepthStencilStateDescription | clan::DepthStencilStateDescription::clone () const

## Attributes
bool | clan::DepthStencilStateDescription::is_stencil_test_enabled () const
void | clan::DepthStencilStateDescription::get_stencil_compare_front (CompareFunction &out_front, int &out_front_ref, int &out_front_mask) const
void | clan::DepthStencilStateDescription::get_stencil_compare_back (CompareFunction &out_back, int &out_back_ref, int &out_back_mask) const
void | clan::DepthStencilStateDescription::get_stencil_write_mask (unsigned char &out_front_facing_mask, unsigned char &out_back_facing_mask) const
void | clan::DepthStencilStateDescription::get_stencil_op_front (StencilOp &out_fail_front, StencilOp &out_pass_depth_fail_front, StencilOp &out_pass_depth_pass_front) const
void | clan::DepthStencilStateDescription::get_stencil_op_back (StencilOp &out_fail_back, StencilOp &out_pass_depth_fail_back, StencilOp &out_pass_depth_pass_back) const
bool | clan::DepthStencilStateDescription::is_depth_test_enabled () const
bool | clan::DepthStencilStateDescription::is_depth_write_enabled () const
CompareFunction | clan::DepthStencilStateDescription::get_depth_compare_function () const

## Operations
void | clan::DepthStencilStateDescription::enable_stencil_test (bool enabled)
| Enables/disables stencil testing. More...
void | clan::DepthStencilStateDescription::set_stencil_compare_front (CompareFunction front, int front_ref, int front_mask)
| Set stencil compare function. More...
void | clan::DepthStencilStateDescription::set_stencil_compare_back (CompareFunction back, int back_ref, int back_mask)
| Set stencil compare function. More...
void | clan::DepthStencilStateDescription::set_stencil_write_mask (unsigned char front_facing_mask, unsigned char back_facing_mask)
| Set stencil write masks. More...
void | clan::DepthStencilStateDescription::set_stencil_op_front (StencilOp fail_front, StencilOp pass_depth_fail_front, StencilOp pass_depth_pass_front)
| Set stencil operations. More...
void | clan::DepthStencilStateDescription::set_stencil_op_back (StencilOp fail_back, StencilOp pass_depth_fail_back, StencilOp pass_depth_pass_back)
| Set stencil operations. More...
void | clan::DepthStencilStateDescription::enable_depth_test (bool enabled)
| Enables/disables depth testing. More...
void | clan::DepthStencilStateDescription::enable_depth_write (bool enabled)
| Enables/disables depth writing. More...
void | clan::DepthStencilStateDescription::set_depth_compare_function (CompareFunction func)
| Set depth test function. More...

## Construction
| clan::ElementArrayBuffer::ElementArrayBuffer ()
| Constructs a null instance. More...
| clan::ElementArrayBuffer::ElementArrayBuffer (GraphicContext &gc, int size, BufferUsage usage=usage_static_draw)
| Constructs a ElementArrayBuffer. More...
| clan::ElementArrayBuffer::ElementArrayBuffer (GraphicContext &gc, const void *data, int size, BufferUsage usage=usage_static_draw)
| Constructs a ElementArrayBuffer. More...
virtual | clan::ElementArrayBuffer::~ElementArrayBuffer ()

## Attributes
bool | clan::ElementArrayBuffer::is_null () const
| Returns true if this object is invalid. More...
void | clan::ElementArrayBuffer::throw_if_null () const
| Throw an exception if this object is invalid. More...
ElementArrayBufferProvider * | clan::ElementArrayBuffer::get_provider () const
| Get Provider. More...

## Operations
bool | clan::ElementArrayBuffer::operator== (const ElementArrayBuffer &other) const
| Handle comparison operator. More...
void | clan::ElementArrayBuffer::upload_data (GraphicContext &gc, const void *data, int size)
| Uploads data to element array buffer. More...
void | clan::ElementArrayBuffer::copy_from (GraphicContext &gc, TransferBuffer &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data from transfer buffer. More...
void | clan::ElementArrayBuffer::copy_to (GraphicContext &gc, TransferBuffer &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data to transfer buffer. More...

## Construction
| clan::ElementArrayVector< Type >::ElementArrayVector ()
| Constructs a null instance. More...
| clan::ElementArrayVector< Type >::ElementArrayVector (GraphicContext &gc, int size, BufferUsage usage=usage_static_draw)
| Constructs a ElementArrayBuffer. More...
| clan::ElementArrayVector< Type >::ElementArrayVector (GraphicContext &gc, Type *data, int size, BufferUsage usage=usage_static_draw)
| Constructs a ElementArrayBuffer. More...
| clan::ElementArrayVector< Type >::ElementArrayVector (GraphicContext &gc, const std::vector< Type > &data, BufferUsage usage=usage_static_draw)

## Operations
void | clan::ElementArrayVector< Type >::upload_data (GraphicContext &gc, const Type *data, int size)
| Uploads data to element array buffer. More...
void | clan::ElementArrayVector< Type >::upload_data (GraphicContext &gc, const std::vector< Type > &data)
| Uploads data to element array buffer. More...
void | clan::ElementArrayVector< Type >::copy_from (GraphicContext &gc, TransferVector< Type > &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data from transfer buffer. More...
void | clan::ElementArrayVector< Type >::copy_to (GraphicContext &gc, TransferVector< Type > &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data to transfer buffer. More...

## Construction
| clan::FrameBuffer::FrameBuffer ()
| Constructs a null instance. More...
| clan::FrameBuffer::FrameBuffer (GraphicContext &context)
| Constructs a FrameBuffer. More...

## Attributes
bool | clan::FrameBuffer::is_null () const
| Returns true if this object is invalid. More...
void | clan::FrameBuffer::throw_if_null () const
| Throw an exception if this object is invalid. More...
FrameBufferProvider * | clan::FrameBuffer::get_provider () const
| Get Provider. More...
Size | clan::FrameBuffer::get_size () const
| Get the minumum size of all the frame buffer attachments. More...
FrameBufferBindTarget | clan::FrameBuffer::get_bind_target () const
| Get the bind target of the framebuffer. More...

## Operations
bool | clan::FrameBuffer::operator== (const FrameBuffer &other) const
| Equality operator. More...
void | clan::FrameBuffer::attach_color (int attachment_index, const RenderBuffer &render_buffer)
| Attach color buffer. More...
void | clan::FrameBuffer::attach_color (int attachment_index, const Texture1D &texture, int level=0)
| Attach color buffer. More...
void | clan::FrameBuffer::attach_color (int attachment_index, const Texture1DArray &texture, int array_index=-1, int level=0)
| Attach color buffer. More...
void | clan::FrameBuffer::attach_color (int attachment_index, const Texture2D &texture, int level=0)
| Attach color buffer. More...
void | clan::FrameBuffer::attach_color (int attachment_index, const Texture2DArray &texture, int array_index=-1, int level=0)
| Attach color buffer. More...
void | clan::FrameBuffer::attach_color (int attachment_index, const Texture3D &texture, int depth, int level=0)
| Attach color buffer. More...
void | clan::FrameBuffer::attach_color (int attachment_index, const TextureCube &texture, TextureSubtype subtype, int level=0)
| Attach color buffer. More...
void | clan::FrameBuffer::detach_color (int attachment_index)
| Detach color buffer. More...
void | clan::FrameBuffer::attach_stencil (const RenderBuffer &render_buffer)
void | clan::FrameBuffer::attach_stencil (const Texture2D &texture, int level=0)
void | clan::FrameBuffer::attach_stencil (const TextureCube &texture, TextureSubtype subtype, int level=0)
void | clan::FrameBuffer::detach_stencil ()
void | clan::FrameBuffer::attach_depth (const RenderBuffer &render_buffer)
void | clan::FrameBuffer::attach_depth (const Texture2D &texture, int level=0)
void | clan::FrameBuffer::attach_depth (const TextureCube &texture, TextureSubtype subtype, int level=0)
void | clan::FrameBuffer::detach_depth ()
void | clan::FrameBuffer::attach_depth_stencil (const RenderBuffer &render_buffer)
void | clan::FrameBuffer::attach_depth_stencil (const Texture2D &texture, int level=0)
void | clan::FrameBuffer::attach_depth_stencil (const TextureCube &texture, TextureSubtype subtype, int level=0)
void | clan::FrameBuffer::detach_depth_stencil ()
void | clan::FrameBuffer::set_bind_target (FrameBufferBindTarget target)
| Set the bind target of the framebuffer to either drawn to or read from. More...
float | clan::FrameBuffer::get_pixel_ratio () const

## Construction
| clan::GraphicContext::GraphicContext ()
| Constructs a null instance. More...
| clan::GraphicContext::GraphicContext (GraphicContextProvider *provider)
| clan::GraphicContext::~GraphicContext ()

## Attributes
bool | clan::GraphicContext::is_null () const
| Returns true if this object is invalid. More...
void | clan::GraphicContext::throw_if_null () const
| Throw an exception if this object is invalid. More...
ClipZRange | clan::GraphicContext::get_clip_z_range () const
| Returns in what range clip space z values are clipped. More...
TextureImageYAxis | clan::GraphicContext::get_texture_image_y_axis () const
| Returns the Y axis direction for viewports, clipping rects, textures and render targets. More...
ShaderLanguage | clan::GraphicContext::get_shader_language () const
| Returns the shader language used. More...
int | clan::GraphicContext::get_major_version () const
int | clan::GraphicContext::get_minor_version () const
bool | clan::GraphicContext::has_compute_shader_support () const
Texture | clan::GraphicContext::get_texture (int index) const
std::vector< Texture > | clan::GraphicContext::get_textures () const
FrameBuffer | clan::GraphicContext::get_write_frame_buffer () const
FrameBuffer | clan::GraphicContext::get_read_frame_buffer () const
ProgramObject | clan::GraphicContext::get_program_object () const
| Returns the currently selected program object. More...
int | clan::GraphicContext::get_width () const
| Returns the current actual width of the context. More...
int | clan::GraphicContext::get_height () const
| Returns the current actual height of the context. More...
Size | clan::GraphicContext::get_size () const
| Returns the current actual size of the context. More...
float | clan::GraphicContext::get_pixel_ratio () const
float | clan::GraphicContext::get_dip_width () const
float | clan::GraphicContext::get_dip_height () const
Sizef | clan::GraphicContext::get_dip_size () const
Size | clan::GraphicContext::get_max_texture_size () const
GraphicContextProvider * | clan::GraphicContext::get_provider ()
| Returns the provider for this graphic context. More...
const GraphicContextProvider * | clan::GraphicContext::get_provider () const

## Operations
GraphicContext | clan::GraphicContext::create () const
| Create a new default graphic context compatible with this one. More...
GraphicContext | clan::GraphicContext::create (FrameBuffer &buffer) const
| Create a new default graphic context with a frame buffer selected. More...
GraphicContext | clan::GraphicContext::clone () const
| Create a new default graphic context cloned with this one. More...
PixelBuffer | clan::GraphicContext::get_pixeldata (const Rect &rect, TextureFormat texture_format=tf_rgba8, bool clamp=true)
| Return the content of the read buffer into a pixel buffer. More...
PixelBuffer | clan::GraphicContext::get_pixeldata (TextureFormat texture_format=tf_rgba8, bool clamp=true)
| Return the content of the read buffer into a pixel buffer. More...
bool | clan::GraphicContext::is_frame_buffer_owner (const FrameBuffer &fb)
void | clan::GraphicContext::set_frame_buffer (const FrameBuffer &write_buffer)
| Sets the current frame buffer. More...
void | clan::GraphicContext::set_frame_buffer (const FrameBuffer &write_buffer, const FrameBuffer &read_buffer)
void | clan::GraphicContext::reset_frame_buffer ()
| Resets the current frame buffer to be the initial frame buffer. More...
void | clan::GraphicContext::set_uniform_buffer (int index, const UniformBuffer &buffer)
| Select uniform buffer into index. More...
void | clan::GraphicContext::reset_uniform_buffer (int index)
| Remove uniform buffer from index. More...
void | clan::GraphicContext::set_storage_buffer (int index, const StorageBuffer &buffer)
| Select storage buffer into index. More...
void | clan::GraphicContext::reset_storage_buffer (int index)
| Remove storage buffer from index. More...
void | clan::GraphicContext::set_texture (int unit_index, const Texture &texture)
void | clan::GraphicContext::set_textures (std::vector< Texture > &textures)
void | clan::GraphicContext::reset_texture (int unit_index)
void | clan::GraphicContext::reset_textures ()
| Remove all selected textures. More...
void | clan::GraphicContext::set_image_texture (int unit_index, const Texture &texture)
void | clan::GraphicContext::set_image_texture (std::vector< Texture > &textures)
void | clan::GraphicContext::reset_image_texture (int unit_index)
void | clan::GraphicContext::reset_image_textures ()
| Remove all selected textures. More...
void | clan::GraphicContext::set_rasterizer_state (const RasterizerState &state)
| Set active rasterizer state. More...
void | clan::GraphicContext::set_blend_state (const BlendState &state, const Colorf &blend_color=Colorf::white, unsigned int sample_mask=0xffffffff)
| Set active blend state. More...
void | clan::GraphicContext::set_depth_stencil_state (const DepthStencilState &state, int stencil_ref=0)
| Set active depth stencil state. More...
void | clan::GraphicContext::reset_rasterizer_state ()
| Set active rasterizer state. More...
void | clan::GraphicContext::reset_blend_state ()
| Set active blend state. More...
void | clan::GraphicContext::reset_depth_stencil_state ()
| Set active depth stencil state. More...
void | clan::GraphicContext::set_program_object (StandardProgram standard_program)
| Set active program object to the standard program specified. More...
void | clan::GraphicContext::set_program_object (const ProgramObject &program)
void | clan::GraphicContext::reset_program_object ()
| Remove active program object. More...
bool | clan::GraphicContext::is_primitives_array_owner (const PrimitivesArray &primitives_array)
void | clan::GraphicContext::draw_primitives (PrimitivesType type, int num_vertices, const PrimitivesArray &array)
| Draw primitives on gc. More...
void | clan::GraphicContext::set_primitives_array (const PrimitivesArray &array)
| Set the primitives array on the gc. More...
void | clan::GraphicContext::draw_primitives_array (PrimitivesType type, int num_vertices)
| Draws primitives from the current assigned primitives array. More...
void | clan::GraphicContext::draw_primitives_array (PrimitivesType type, int offset, int num_vertices)
void | clan::GraphicContext::draw_primitives_array_instanced (PrimitivesType type, int offset, int num_vertices, int instance_count)
void | clan::GraphicContext::set_primitives_elements (ElementArrayBuffer &element_array)
| Sets current elements array buffer. More...
template<typename Type >
void | clan::GraphicContext::set_primitives_elements (ElementArrayVector< Type > &element_array)
| Sets current elements array buffer. More...
void | clan::GraphicContext::draw_primitives_elements (PrimitivesType type, int count, VertexAttributeDataType indices_type, size_t offset=0)
void | clan::GraphicContext::draw_primitives_elements_instanced (PrimitivesType type, int count, VertexAttributeDataType indices_type, size_t offset, int instance_count)
void | clan::GraphicContext::reset_primitives_elements ()
| Resets current elements array buffer. More...
void | clan::GraphicContext::draw_primitives_elements (PrimitivesType type, int count, ElementArrayBuffer &element_array, VertexAttributeDataType indices_type, size_t offset=0)
void | clan::GraphicContext::draw_primitives_elements (PrimitivesType type, int count, ElementArrayVector< unsigned int > &element_array, size_t offset=0)
void | clan::GraphicContext::draw_primitives_elements (PrimitivesType type, int count, ElementArrayVector< unsigned short > &element_array, size_t offset=0)
void | clan::GraphicContext::draw_primitives_elements (PrimitivesType type, int count, ElementArrayVector< unsigned char > &element_array, size_t offset=0)
void | clan::GraphicContext::draw_primitives_elements_instanced (PrimitivesType type, int count, ElementArrayBuffer &element_array, VertexAttributeDataType indices_type, size_t offset, int instance_count)
void | clan::GraphicContext::draw_primitives_elements_instanced (PrimitivesType type, int count, ElementArrayVector< unsigned int > &element_array, size_t offset, int instance_count)
void | clan::GraphicContext::draw_primitives_elements_instanced (PrimitivesType type, int count, ElementArrayVector< unsigned short > &element_array, size_t offset, int instance_count)
void | clan::GraphicContext::draw_primitives_elements_instanced (PrimitivesType type, int count, ElementArrayVector< unsigned char > &element_array, size_t offset, int instance_count)
void | clan::GraphicContext::reset_primitives_array ()
| Reset the primitives arrays. More...
void | clan::GraphicContext::dispatch (int x=1, int y=1, int z=1)
| Execute a compute shader. More...
void | clan::GraphicContext::clear (const Colorf &color=Colorf::black)
| Clears the whole context using the specified color. More...
void | clan::GraphicContext::clear_stencil (int value=0)
void | clan::GraphicContext::clear_depth (float value=0)
void | clan::GraphicContext::set_scissor (const Rect &rect, TextureImageYAxis y_axis)
| Set the current clipping rectangle. More...
void | clan::GraphicContext::reset_scissor ()
| Removes the set clipping rectangle. More...
void | clan::GraphicContext::set_viewport (const Rectf &viewport)
void | clan::GraphicContext::set_viewport (int index, const Rectf &viewport)
void | clan::GraphicContext::set_depth_range (float n, float f)
| Specifies the depth range for all viewports. More...
void | clan::GraphicContext::set_depth_range (int viewport, float n, float f)
| Specifies the depth range for the specified viewport. More...
void | clan::GraphicContext::set_draw_buffer (DrawBuffer buffer)
| Set used draw buffer. More...
void | clan::GraphicContext::flush ()
| Flush the command buffer. More...

## Operators
bool | clan::GraphicContext::operator== (const GraphicContext &other) const
bool | clan::GraphicContext::operator!= (const GraphicContext &other) const

## Implementation
class | clan::GraphicContext::OpenGL

## Construction
| clan::OcclusionQuery::OcclusionQuery ()
| Constructs a null instance. More...
| clan::OcclusionQuery::OcclusionQuery (GraphicContext &context)
| Constructs an occlusion query object. More...
virtual | clan::OcclusionQuery::~OcclusionQuery ()

## Attributes
bool | clan::OcclusionQuery::is_null () const
| Returns true if this object is invalid. More...
void | clan::OcclusionQuery::throw_if_null () const
| Throw an exception if this object is invalid. More...
int | clan::OcclusionQuery::get_result ()
| Returns the result of the occlusion query. More...
bool | clan::OcclusionQuery::is_result_ready ()
| Returns true if the GPU is ready to return the result. More...
OcclusionQueryProvider * | clan::OcclusionQuery::get_provider () const
| Get Provider. More...

## Operations
void | clan::OcclusionQuery::begin ()
| Start occlusion query. More...
void | clan::OcclusionQuery::end ()
| Finish occlusion query. More...

## Construction
| clan::PrimitivesArray::PrimitivesArray ()
| Construct a null instance. More...
| clan::PrimitivesArray::PrimitivesArray (GraphicContext &gc)
| Constructs a PrimitivesArray. More...
| clan::PrimitivesArray::~PrimitivesArray ()

## Attributes
bool | clan::PrimitivesArray::is_null () const
| Returns true if this object is invalid. More...
void | clan::PrimitivesArray::throw_if_null () const
| Throw an exception if this object is invalid. More...
PrimitivesArrayProvider * | clan::PrimitivesArray::get_provider () const
| Returns the target provider for the primitives array. More...

## Operations
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayBuffer &buffer, int size, VertexAttributeDataType type, size_t offset=0, int stride=0, bool normalize=false)
| Set attributes. More...
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< unsigned char > &buffer, int size, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< char > &buffer, int size, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< unsigned short > &buffer, int size, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< short > &buffer, int size, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< unsigned int > &buffer, int size, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< int > &buffer, int size, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< float > &buffer, int size, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< unsigned char > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< signed char > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< unsigned short > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< signed short > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< unsigned int > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< signed int > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< float > &buffer)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec2ub > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec2b > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec2us > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec2s > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec2ui > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec2i > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec2f > &buffer)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec3ub > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec3b > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec3us > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec3s > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec3ui > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec3i > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec3f > &buffer)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec4ub > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec4b > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec4us > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec4s > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec4ui > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec4i > &buffer, bool normalize=false)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Vec4f > &buffer)
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Colorf > &buffer)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, unsigned char *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, signed char *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, unsigned short *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, signed short *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, unsigned int *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, signed int *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, float *member_offset)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec2ub *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec2b *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec2us *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec2s *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec2ui *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec2i *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec2f *member_offset)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec3ub *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec3b *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec3us *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec3s *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec3ui *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec3i *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec3f *member_offset)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec4ub *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec4b *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec4us *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec4s *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec4ui *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec4i *member_offset, bool normalize=false)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Vec4f *member_offset)
template<typename Type >
void | clan::PrimitivesArray::set_attributes (int index, VertexArrayVector< Type > &buffer, Colorf *member_offset)

## Construction
| clan::ProgramObject::ProgramObject ()
| Construct a null instance. More...
| clan::ProgramObject::ProgramObject (GraphicContext &gc)
| Constructs a ProgramObject. More...
| clan::ProgramObject::ProgramObject (GraphicContextProvider *gc_provider)
| Constructs a ProgramObject. More...
| clan::ProgramObject::ProgramObject (ProgramObjectProvider *provider)
| Constructs a ProgramObject. More...
static ProgramObject | clan::ProgramObject::load (GraphicContext &gc, const std::string &resource_id, const XMLResourceDocument &resman)
| Load. More...
static ProgramObject | clan::ProgramObject::load (GraphicContext &gc, const std::string &vertex_fullname, const std::string &fragment_fullname)
| Load. More...
static ProgramObject | clan::ProgramObject::load (GraphicContext &gc, const std::string &vertex_fullname, const std::string &geometry_fullname, const std::string &fragment_fullname)
| Load. More...
static ProgramObject | clan::ProgramObject::load (GraphicContext &gc, const std::string &vertex_filename, const std::string &fragment_filename, const FileSystem &fs)
| Load. More...
static ProgramObject | clan::ProgramObject::load (GraphicContext &gc, const std::string &vertex_filename, const std::string &geometry_filename, const std::string &fragment_filename, const FileSystem &fs)
| Load. More...
static ProgramObject | clan::ProgramObject::load (GraphicContext &gc, IODevice &vertex_file, IODevice &fragment_file)
| Load. More...
static ProgramObject | clan::ProgramObject::load (GraphicContext &gc, IODevice &vertex_file, IODevice &geometry_file, IODevice &fragment_file)
| Load. More...
static ProgramObject | clan::ProgramObject::load_and_link (GraphicContext &gc, const std::string &vertex_fullname, const std::string &fragment_fullname)
| Load and link. More...
static ProgramObject | clan::ProgramObject::load_and_link (GraphicContext &gc, const std::string &vertex_fullname, const std::string &geometry_fullname, const std::string &fragment_fullname)
| Load and link. More...
static ProgramObject | clan::ProgramObject::load_and_link (GraphicContext &gc, const std::string &vertex_filename, const std::string &fragment_filename, const FileSystem &fs)
| Load and link. More...
static ProgramObject | clan::ProgramObject::load_and_link (GraphicContext &gc, const std::string &vertex_filename, const std::string &geometry_filename, const std::string &fragment_filename, const FileSystem &fs)
| Load and link. More...
static ProgramObject | clan::ProgramObject::load_and_link (GraphicContext &gc, IODevice &vertex_file, IODevice &fragment_file)
| Load and link. More...
static ProgramObject | clan::ProgramObject::load_and_link (GraphicContext &gc, IODevice &vertex_file, IODevice &geometry_file, IODevice &fragment_file)
| Load and link. More...
virtual | clan::ProgramObject::~ProgramObject ()

## Attributes
bool | clan::ProgramObject::is_null () const
| Returns true if this object is invalid. More...
void | clan::ProgramObject::throw_if_null () const
| Throw an exception if this object is invalid. More...
ProgramObjectProvider * | clan::ProgramObject::get_provider () const
| Retrieves the provider. More...
unsigned int | clan::ProgramObject::get_handle () const
| Returns the OpenGL program object handle. More...
std::vector< ShaderObject > | clan::ProgramObject::get_shaders () const
| Returns the shaders attached to the program object. More...
std::string | clan::ProgramObject::get_info_log () const
| Returns the current info log for the program object. More...
int | clan::ProgramObject::get_attribute_location (const std::string &name) const
| Returns the location of a named active attribute. More...
int | clan::ProgramObject::get_uniform_location (const std::string &name) const
| Returns the location of a named uniform variable. More...
int | clan::ProgramObject::get_uniform_buffer_size (const std::string &block_name) const
| Get the uniform block size. More...
int | clan::ProgramObject::get_uniform_buffer_size (int block_index) const
| Get the uniform block size. More...
int | clan::ProgramObject::get_uniform_buffer_index (const std::string &block_name) const
| Get the uniform block index. More...
int | clan::ProgramObject::get_storage_buffer_index (const std::string &name) const
| Get the storage buffer index. More...

## Operations
bool | clan::ProgramObject::operator== (const ProgramObject &other) const
| Equality operator. More...
void | clan::ProgramObject::attach (const ShaderObject &obj)
| Add shader to program object. More...
void | clan::ProgramObject::detach (const ShaderObject &obj)
| Remove shader from program object. More...
void | clan::ProgramObject::bind_attribute_location (int index, const std::string &name)
| Bind attribute to specific location. More...
void | clan::ProgramObject::bind_frag_data_location (int color_number, const std::string &name)
| Bind shader out variable a specific color buffer location. More...
bool | clan::ProgramObject::link ()
| Link program. More...
bool | clan::ProgramObject::validate ()
| Validate program. More...
void | clan::ProgramObject::set_uniform1i (int location, int value_a)
void | clan::ProgramObject::set_uniform2i (int location, int value_a, int value_b)
void | clan::ProgramObject::set_uniform3i (int location, int value_a, int value_b, int value_c)
void | clan::ProgramObject::set_uniform4i (int location, int value_a, int value_b, int value_c, int value_d)
void | clan::ProgramObject::set_uniformiv (int location, int size, int count, const int *data)
void | clan::ProgramObject::set_uniform2i (int location, const Vec2i &vec)
void | clan::ProgramObject::set_uniform3i (int location, const Vec3i &vec)
void | clan::ProgramObject::set_uniform4i (int location, const Vec4i &vec)
void | clan::ProgramObject::set_uniform2s (int location, const Vec2s &vec)
void | clan::ProgramObject::set_uniform3s (int location, const Vec3s &vec)
void | clan::ProgramObject::set_uniform4s (int location, const Vec4s &vec)
void | clan::ProgramObject::set_uniform2b (int location, const Vec2b &vec)
void | clan::ProgramObject::set_uniform3b (int location, const Vec3b &vec)
void | clan::ProgramObject::set_uniform4b (int location, const Vec4b &vec)
void | clan::ProgramObject::set_uniformiv (int location, int count, const Vec2i *data)
void | clan::ProgramObject::set_uniformiv (int location, int count, const Vec3i *data)
void | clan::ProgramObject::set_uniformiv (int location, int count, const Vec4i *data)
void | clan::ProgramObject::set_uniform1f (int location, float value_a)
void | clan::ProgramObject::set_uniform2f (int location, float value_a, float value_b)
void | clan::ProgramObject::set_uniform3f (int location, float value_a, float value_b, float value_c)
void | clan::ProgramObject::set_uniform4f (int location, float value_a, float value_b, float value_c, float value_d)
void | clan::ProgramObject::set_uniformfv (int location, int size, int count, const float *data)
void | clan::ProgramObject::set_uniform2f (int location, const Vec2f &vec)
void | clan::ProgramObject::set_uniform3f (int location, const Vec3f &vec)
void | clan::ProgramObject::set_uniform4f (int location, const Vec4f &vec)
void | clan::ProgramObject::set_uniformfv (int location, int count, const Vec2f *data)
void | clan::ProgramObject::set_uniformfv (int location, int count, const Vec3f *data)
void | clan::ProgramObject::set_uniformfv (int location, int count, const Vec4f *data)
void | clan::ProgramObject::set_uniform_matrix (int location, int size, int count, bool transpose, const float *data)
void | clan::ProgramObject::set_uniform_matrix (int location, const Mat2f &matrix)
void | clan::ProgramObject::set_uniform_matrix (int location, const Mat3f &matrix)
void | clan::ProgramObject::set_uniform_matrix (int location, const Mat4f &matrix)
void | clan::ProgramObject::set_uniform_matrix (int location, int count, const Mat2f *matrix)
void | clan::ProgramObject::set_uniform_matrix (int location, int count, const Mat3f *matrix)
void | clan::ProgramObject::set_uniform_matrix (int location, int count, const Mat4f *matrix)
void | clan::ProgramObject::set_uniform1i (const std::string &name, int value_a)
void | clan::ProgramObject::set_uniform2i (const std::string &name, int value_a, int value_b)
void | clan::ProgramObject::set_uniform3i (const std::string &name, int value_a, int value_b, int value_c)
void | clan::ProgramObject::set_uniform4i (const std::string &name, int value_a, int value_b, int value_c, int value_d)
void | clan::ProgramObject::set_uniformiv (const std::string &name, int size, int count, const int *data)
void | clan::ProgramObject::set_uniform2i (const std::string &name, const Vec2i &vec)
void | clan::ProgramObject::set_uniform3i (const std::string &name, const Vec3i &vec)
void | clan::ProgramObject::set_uniform4i (const std::string &name, const Vec4i &vec)
void | clan::ProgramObject::set_uniform2s (const std::string &name, const Vec2s &vec)
void | clan::ProgramObject::set_uniform3s (const std::string &name, const Vec3s &vec)
void | clan::ProgramObject::set_uniform4s (const std::string &name, const Vec4s &vec)
void | clan::ProgramObject::set_uniform2b (const std::string &name, const Vec2b &vec)
void | clan::ProgramObject::set_uniform3b (const std::string &name, const Vec3b &vec)
void | clan::ProgramObject::set_uniform4b (const std::string &name, const Vec4b &vec)
void | clan::ProgramObject::set_uniformiv (const std::string &name, int count, const Vec2i *data)
void | clan::ProgramObject::set_uniformiv (const std::string &name, int count, const Vec3i *data)
void | clan::ProgramObject::set_uniformiv (const std::string &name, int count, const Vec4i *data)
void | clan::ProgramObject::set_uniform1f (const std::string &name, float value_a)
void | clan::ProgramObject::set_uniform2f (const std::string &name, float value_a, float value_b)
void | clan::ProgramObject::set_uniform3f (const std::string &name, float value_a, float value_b, float value_c)
void | clan::ProgramObject::set_uniform4f (const std::string &name, float value_a, float value_b, float value_c, float value_d)
void | clan::ProgramObject::set_uniformfv (const std::string &name, int size, int count, const float *data)
void | clan::ProgramObject::set_uniform2f (const std::string &name, const Vec2f &vec)
void | clan::ProgramObject::set_uniform3f (const std::string &name, const Vec3f &vec)
void | clan::ProgramObject::set_uniform4f (const std::string &name, const Vec4f &vec)
void | clan::ProgramObject::set_uniformfv (const std::string &name, int count, const Vec2f *data)
void | clan::ProgramObject::set_uniformfv (const std::string &name, int count, const Vec3f *data)
void | clan::ProgramObject::set_uniformfv (const std::string &name, int count, const Vec4f *data)
void | clan::ProgramObject::set_uniform_matrix (const std::string &name, int size, int count, bool transpose, const float *data)
void | clan::ProgramObject::set_uniform_matrix (const std::string &name, const Mat2f &matrix)
void | clan::ProgramObject::set_uniform_matrix (const std::string &name, const Mat3f &matrix)
void | clan::ProgramObject::set_uniform_matrix (const std::string &name, const Mat4f &matrix)
void | clan::ProgramObject::set_uniform_matrix (const std::string &name, int count, const Mat2f *matrix)
void | clan::ProgramObject::set_uniform_matrix (const std::string &name, int count, const Mat3f *matrix)
void | clan::ProgramObject::set_uniform_matrix (const std::string &name, int count, const Mat4f *matrix)
void | clan::ProgramObject::set_uniform_buffer_index (const std::string &block_name, int bind_index)
| Sets the UniformBuffer. More...
void | clan::ProgramObject::set_uniform_buffer_index (int block_index, int bind_index)
| Sets the UniformBuffer. More...
void | clan::ProgramObject::set_storage_buffer_index (const std::string &block_name, int bind_index)
| Sets the UniformBuffer. More...
void | clan::ProgramObject::set_storage_buffer_index (int block_index, int bind_index)
| Sets the UniformBuffer. More...

## Construction
| clan::RasterizerState::RasterizerState ()
| Constructs a null instance. More...
| clan::RasterizerState::RasterizerState (GraphicContext &context, const RasterizerStateDescription &desc)
| Constructs a Texture. More...

## Attributes
bool | clan::RasterizerState::is_null () const
| Returns true if this object is invalid. More...
RasterizerStateProvider * | clan::RasterizerState::get_provider () const

## Construction
| clan::RasterizerStateDescription::RasterizerStateDescription ()
RasterizerStateDescription | clan::RasterizerStateDescription::clone () const

## Attributes
bool | clan::RasterizerStateDescription::get_culled () const
bool | clan::RasterizerStateDescription::get_enable_line_antialiasing () const
CullMode | clan::RasterizerStateDescription::get_face_cull_mode () const
FillMode | clan::RasterizerStateDescription::get_face_fill_mode () const
FaceSide | clan::RasterizerStateDescription::get_front_face () const
bool | clan::RasterizerStateDescription::get_enable_scissor () const
bool | clan::RasterizerStateDescription::get_antialiased () const
bool | clan::RasterizerStateDescription::get_offset_point () const
bool | clan::RasterizerStateDescription::get_offset_line () const
bool | clan::RasterizerStateDescription::get_offset_fill () const
void | clan::RasterizerStateDescription::get_polygon_offset (float &out_factor, float &out_units) const
float | clan::RasterizerStateDescription::get_point_size () const
float | clan::RasterizerStateDescription::get_point_fade_treshold_size () const
bool | clan::RasterizerStateDescription::is_point_size () const
PointSpriteOrigin | clan::RasterizerStateDescription::get_point_sprite_origin () const

## Operations
void | clan::RasterizerStateDescription::set_culled (bool value)
| Enables/disables polygon cull clipping. More...
void | clan::RasterizerStateDescription::enable_line_antialiasing (bool enabled)
| Setting to true enables line antialiasing. More...
void | clan::RasterizerStateDescription::set_face_cull_mode (CullMode value)
| Sets the polygon cull clipping mode. More...
void | clan::RasterizerStateDescription::set_face_fill_mode (FillMode value)
| Sets the filling mode for polygons. More...
void | clan::RasterizerStateDescription::set_front_face (FaceSide value)
| Sets which side is the front side of a face. More...
void | clan::RasterizerStateDescription::enable_scissor (bool enabled)
| Enables/disables if clipping rects are used. More...
void | clan::RasterizerStateDescription::enable_antialiased (bool value)
| Enables/disables anti-aliasing. (clanGL only) More...
void | clan::RasterizerStateDescription::enable_offset_point (bool value)
| Enables/disables point offsetting. More...
void | clan::RasterizerStateDescription::enable_offset_line (bool value)
| Enables/disables line offsetting. More...
void | clan::RasterizerStateDescription::enable_offset_fill (bool value)
| Enables/disables polygon offsetting. More...
void | clan::RasterizerStateDescription::set_polygon_offset (float factor, float units)
| Sets the offset factor. More...
void | clan::RasterizerStateDescription::set_point_size (float)
| The default value is 1.0 (clanGL only) More...
void | clan::RasterizerStateDescription::set_point_fade_treshold_size (float)
| Alpha fade point once minimum size treshold reached. Requires multisampling to be enabled. (clanGL only) More...
void | clan::RasterizerStateDescription::enable_point_size (bool enable)
| Enables if points sizes is set by the vertex shader. (clanGL only) More...
void | clan::RasterizerStateDescription::set_point_sprite_origin (PointSpriteOrigin origin)
| Sets the origin of texture point sprites. (clanGL only) More...

## Operations
virtual | clan::RenderBatcher::~RenderBatcher ()
virtual void | clan::RenderBatcher::flush (GraphicContext &gc)=0
virtual void | clan::RenderBatcher::matrix_changed (const Mat4f &modelview, const Mat4f &projection, TextureImageYAxis image_yaxis, float pixel_ratio)=0

## Construction
| clan::RenderBuffer::RenderBuffer ()
| Constructs a null instance. More...
| clan::RenderBuffer::RenderBuffer (GraphicContext &context, int width, int height, TextureFormat texture_format=tf_rgba8, int multisample_samples=0)
| Constructs a RenderBuffer. More...

## Attributes
bool | clan::RenderBuffer::is_null () const
| Returns true if this object is invalid. More...
void | clan::RenderBuffer::throw_if_null () const
| Throw an exception if this object is invalid. More...
const Size & | clan::RenderBuffer::get_size () const
| Returns the render buffer size. More...
RenderBufferProvider * | clan::RenderBuffer::get_provider () const
| Get Provider. More...

## Operations
bool | clan::RenderBuffer::operator== (const RenderBuffer &other) const
| Equality operator. More...

## Construction
| clan::ShaderObject::ShaderObject ()
| Constructs a null instance. More...
| clan::ShaderObject::ShaderObject (GraphicContext &gc, ShaderType type, const std::string &source)
| Constructs an OpenGL shader. More...
| clan::ShaderObject::ShaderObject (GraphicContext &gc, ShaderType type, const void *source, int source_size)
| Constructs a ShaderObject. More...
| clan::ShaderObject::ShaderObject (GraphicContext &gc, ShaderType type, const std::vector< std::string > &sources)
| Constructs a ShaderObject. More...
| clan::ShaderObject::ShaderObject (GraphicContextProvider *gc_provider, ShaderType type, const std::string &source)
| Constructs a ShaderObject. More...
| clan::ShaderObject::ShaderObject (GraphicContextProvider *gc_provider, ShaderType type, const std::vector< std::string > &sources)
| Constructs a ShaderObject. More...
static ShaderObject | clan::ShaderObject::load (GraphicContext &gc, const std::string &resource_id, const XMLResourceDocument &resources)
| Load. More...
static ShaderObject | clan::ShaderObject::load (GraphicContext &gc, ShaderType type, const std::string &filename, const FileSystem &fs)
| Load. More...
static ShaderObject | clan::ShaderObject::load (GraphicContext &gc, ShaderType type, const std::string &fullname)
| Load. More...
static ShaderObject | clan::ShaderObject::load (GraphicContext &gc, ShaderType type, IODevice &file)
| Load. More...
static ShaderObject | clan::ShaderObject::load_and_compile (GraphicContext &gc, ShaderType type, const std::string &filename, const FileSystem &fs)
| Load and compile. More...
static ShaderObject | clan::ShaderObject::load_and_compile (GraphicContext &gc, ShaderType type, const std::string &filename)
| Load and compile. More...
static ShaderObject | clan::ShaderObject::load_and_compile (GraphicContext &gc, ShaderType type, IODevice &file)
| Load and compile. More...
virtual | clan::ShaderObject::~ShaderObject ()

## Attributes
unsigned int | clan::ShaderObject::get_handle () const
| Returns the OpenGL shader handle. More...
ShaderType | clan::ShaderObject::get_shader_type () const
| Gets the shader type. More...
std::string | clan::ShaderObject::get_info_log () const
| Get shader object's info log. More...
std::string | clan::ShaderObject::get_shader_source () const
| Get shader source code. More...
bool | clan::ShaderObject::is_null () const
| Returns true if this object is invalid. More...
void | clan::ShaderObject::throw_if_null () const
| Throw an exception if this object is invalid. More...
ShaderObjectProvider * | clan::ShaderObject::get_provider () const
| Get Provider. More...

## Operations
bool | clan::ShaderObject::operator== (const ShaderObject &other) const
| Handle comparison operator. More...
bool | clan::ShaderObject::compile ()
| Compile program. More...

## Construction
| clan::StorageBuffer::StorageBuffer ()
| Constructs a null instance. More...
| clan::StorageBuffer::StorageBuffer (GraphicContext &gc, int size, int stride, BufferUsage usage=usage_dynamic_draw)
| Constructs a buffer. More...
| clan::StorageBuffer::StorageBuffer (GraphicContext &gc, const void *data, int size, int stride, BufferUsage usage=usage_dynamic_draw)
| Constructs a buffer. More...

## Attributes
bool | clan::StorageBuffer::is_null () const
| Returns true if this object is invalid. More...
void | clan::StorageBuffer::throw_if_null () const
| Throw an exception if this object is invalid. More...
StorageBufferProvider * | clan::StorageBuffer::get_provider () const
| Get Provider. More...

## Operations
bool | clan::StorageBuffer::operator== (const StorageBuffer &other) const
| Handle comparison operator. More...
void | clan::StorageBuffer::upload_data (GraphicContext &gc, const void *data, int size)
| Uploads data to storage buffer. More...
void | clan::StorageBuffer::copy_from (GraphicContext &gc, TransferBuffer &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data from transfer buffer. More...
void | clan::StorageBuffer::copy_to (GraphicContext &gc, TransferBuffer &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data to transfer buffer. More...

## Construction
| clan::StorageVector< Type >::StorageVector ()
| Constructs a null instance. More...
| clan::StorageVector< Type >::StorageVector (GraphicContext &gc, int size, BufferUsage usage=usage_static_draw)
| Constructs a ElementArrayBuffer. More...
| clan::StorageVector< Type >::StorageVector (GraphicContext &gc, Type *data, int size, BufferUsage usage=usage_static_draw)
| Constructs a ElementArrayBuffer. More...
| clan::StorageVector< Type >::StorageVector (GraphicContext &gc, const std::vector< Type > &data, BufferUsage usage=usage_static_draw)

## Operations
void | clan::StorageVector< Type >::upload_data (GraphicContext &gc, const Type *data, int size)
| Uploads data to storage buffer. More...
void | clan::StorageVector< Type >::upload_data (GraphicContext &gc, const std::vector< Type > &data)
| Uploads data to storage buffer. More...
void | clan::StorageVector< Type >::copy_from (GraphicContext &gc, TransferVector< Type > &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data from transfer buffer. More...
void | clan::StorageVector< Type >::copy_to (GraphicContext &gc, TransferVector< Type > &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data to transfer buffer. More...

## Construction
| clan::Texture::Texture ()
| Constructs a null instance. More...
| clan::Texture::Texture (GraphicContext &gc, PixelBufferSet pixelbuffer_set)
| Constructs a texture as described in a pixelbuffer set. More...
| clan::Texture::Texture (const std::shared_ptr< Texture_Impl > &impl)
| Constructs a texture from an implementation. More...
| clan::Texture::Texture (TextureProvider *provider)
| Constructs a texture from a texture provider. More...
virtual | clan::Texture::~Texture ()

## Resources
static Resource< Texture > | clan::Texture::resource (GraphicContext &gc, const std::string &id, const ResourceManager &resources)
| Retrieves a Texture resource from the resource manager. More...
static Texture | clan::Texture::load (GraphicContext &gc, const std::string &id, const XMLResourceDocument &doc, const ImageImportDescription &import_desc=ImageImportDescription())
| Loads a Texture from a XML resource definition. More...

## Operators
bool | clan::Texture::operator== (const Texture &other) const
| Equality operator. More...
bool | clan::Texture::operator!= (const Texture &other) const
| Inequality operator. More...
bool | clan::Texture::operator< (const Texture &other) const
| Less than operator. More...

## Attributes
bool | clan::Texture::is_null () const
| Returns true if this object is invalid. More...
void | clan::Texture::throw_if_null () const
| Throw an exception if this object is invalid. More...
float | clan::Texture::get_min_lod () const
| Get the minimum level of detail. More...
float | clan::Texture::get_max_lod () const
| Get the maximum level of detail. More...
float | clan::Texture::get_lod_bias () const
| Get the level of detail bias constant. More...
int | clan::Texture::get_base_level () const
| Get the texture base level. More...
int | clan::Texture::get_max_level () const
| Get the texture max level. More...
TextureFilter | clan::Texture::get_min_filter () const
| Get the texture minification filter. More...
TextureFilter | clan::Texture::get_mag_filter () const
| Get the texture magnification filter. More...
bool | clan::Texture::is_resident () const
| Returns true if texture is resident in texture memory. More...
TextureCompareMode | clan::Texture::get_compare_mode () const
| Get the texture compare mode. More...
CompareFunction | clan::Texture::get_compare_function () const
| Get the texture compare function. More...
TextureProvider * | clan::Texture::get_provider () const
| Get Provider. More...
std::weak_ptr< Texture_Impl > | clan::Texture::get_impl () const
| Get the implementation weakptr. More...

## Operations
void | clan::Texture::generate_mipmap ()
| Generate the mipmap. More...
void | clan::Texture::set_min_lod (float min_lod)
| Set the minimum level of detail texture parameter. More...
void | clan::Texture::set_max_lod (float max_lod)
| Set the maximum level of detail texture parameter. More...
void | clan::Texture::set_lod_bias (float lod_bias)
| Sets the level of detail bias constant. More...
void | clan::Texture::set_base_level (int base_level)
| Sets the texture base level texture parameter. More...
void | clan::Texture::set_max_level (int max_level)
| Sets the texture max level texture parameter. More...
void | clan::Texture::set_min_filter (TextureFilter filter)
| Set the minification filter. More...
void | clan::Texture::set_mag_filter (TextureFilter filter)
| Set the magnification filter. More...
void | clan::Texture::set_max_anisotropy (float max_anisotropy)
| Set the maximum degree of anisotropy. More...
void | clan::Texture::set_texture_compare (TextureCompareMode mode, CompareFunction func)
| Sets the texture compare mode and compare function texture parameters. More...
Texture1D | clan::Texture::to_texture_1d () const
| Dynamic cast to Texture1D. More...
Texture1DArray | clan::Texture::to_texture_1d_array () const
| Dynamic cast to Texture1DArray. More...
Texture2D | clan::Texture::to_texture_2d () const
| Dynamic cast to Texture2D. More...
Texture2DArray | clan::Texture::to_texture_2d_array () const
| Dynamic cast to Texture2DArray. More...
Texture3D | clan::Texture::to_texture_3d () const
| Dynamic cast to Texture3D. More...
TextureCube | clan::Texture::to_texture_cube () const
| Dynamic cast to TextureCube. More...
TextureCubeArray | clan::Texture::to_texture_cube_array () const
| Dynamic cast to TextureCubeArray. More...

## Implementation
std::shared_ptr< Texture_Impl > | clan::Texture::impl
class | clan::Texture::Texture2DArray

## Construction
| clan::Texture1D::Texture1D ()
| Constructs a null instance. More...
| clan::Texture1D::Texture1D (const std::shared_ptr< Texture_Impl > &impl)
| Constructs a texture from an implementation. More...
| clan::Texture1D::Texture1D (GraphicContext &context, int size, TextureFormat texture_format=tf_rgba8, int levels=1)
| Constructs a Texture. More...
| clan::Texture1D::Texture1D (GraphicContext &context, const PixelBuffer &image, bool is_srgb=false)
| clan::Texture1D::Texture1D (GraphicContext &context, const PixelBuffer &image, int src_x, int width, bool is_srgb=false)

## Attributes
int | clan::Texture1D::get_size () const
| Get the texture width. More...
TextureWrapMode | clan::Texture1D::get_wrap_mode_s () const
| Get the texture wrap mode for the s coordinate. More...

## Operations
void | clan::Texture1D::set_image (GraphicContext &context, PixelBuffer &image, int level=0)
| Upload image to texture. More...
void | clan::Texture1D::set_subimage (GraphicContext &context, int x, const PixelBuffer &image, const int src_x, const int src_width, int level=0)
| Upload image to sub texture. More...
void | clan::Texture1D::set_wrap_mode (TextureWrapMode wrap_s)

## Construction
| clan::Texture1DArray::Texture1DArray ()
| Constructs a null instance. More...
| clan::Texture1DArray::Texture1DArray (const std::shared_ptr< Texture_Impl > &impl)
| Constructs a texture from an implementation. More...
| clan::Texture1DArray::Texture1DArray (GraphicContext &context, int size, int array_size, TextureFormat texture_format=tf_rgba8, int levels=1)
| Constructs a Texture. More...

## Attributes
int | clan::Texture1DArray::get_size () const
| Get the texture width. More...
int | clan::Texture1DArray::get_array_size () const
| Get the texture array size. More...
TextureWrapMode | clan::Texture1DArray::get_wrap_mode_s () const
| Get the texture wrap mode for the s coordinate. More...

## Operations
void | clan::Texture1DArray::set_image (GraphicContext &context, int array_index, PixelBuffer &image, int level=0)
| Upload image to texture. More...
void | clan::Texture1DArray::set_subimage (GraphicContext &context, int array_index, int x, const PixelBuffer &image, const int src_x, const int src_width, int level=0)
| Upload image to sub texture. More...
void | clan::Texture1DArray::set_wrap_mode (TextureWrapMode wrap_s)

## Construction
| clan::Texture2D::Texture2D ()
| Constructs a null instance. More...
| clan::Texture2D::Texture2D (const std::shared_ptr< Texture_Impl > &impl)
| clan::Texture2D::Texture2D (GraphicContext &context, int width, int height, TextureFormat format=tf_rgba8, int levels=1)
| clan::Texture2D::Texture2D (GraphicContext &context, const Size &size, TextureFormat texture_format=tf_rgba8, int levels=1)
| clan::Texture2D::Texture2D (GraphicContext &context, const std::string &fullname, const ImageImportDescription &import_desc={})
| clan::Texture2D::Texture2D (GraphicContext &context, const std::string &filename, const FileSystem &fs, const ImageImportDescription &import_desc={})
| clan::Texture2D::Texture2D (GraphicContext &context, IODevice &file, const std::string &image_type, const ImageImportDescription &import_desc={})
| clan::Texture2D::Texture2D (GraphicContext &context, const PixelBuffer &image, bool is_srgb=false)
| clan::Texture2D::Texture2D (GraphicContext &context, const PixelBuffer &image, const Rect &src_rect, bool is_srgb=false)

## Attributes
int | clan::Texture2D::get_width () const
| Retrieves the actual width of the texture in the display. More...
int | clan::Texture2D::get_height () const
| Retrieves the actual height of the texture in the display. More...
Size | clan::Texture2D::get_size () const
| Retrieves the actual size of the texture. More...
float | clan::Texture2D::get_pixel_ratio () const
float | clan::Texture2D::get_dip_width () const
| Returns the device independent width of this texture. More...
float | clan::Texture2D::get_dip_height () const
| Returns the device independent height of this texture. More...
Sizef | clan::Texture2D::get_dip_size () const
| Returns the device independent size of this texture. More...
PixelBuffer | clan::Texture2D::get_pixeldata (GraphicContext &gc, int level=0) const
| Retrieve image data from texture. More...
PixelBuffer | clan::Texture2D::get_pixeldata (GraphicContext &gc, TextureFormat texture_format, int level=0) const
TextureWrapMode | clan::Texture2D::get_wrap_mode_s () const
| Get the texture wrap mode for the s coordinate. More...
TextureWrapMode | clan::Texture2D::get_wrap_mode_t () const
| Get the texture wrap mode for the t coordinate. More...

## Operations
void | clan::Texture2D::set_image (GraphicContext &context, const PixelBuffer &image, int level=0)
void | clan::Texture2D::set_subimage (GraphicContext &context, int x, int y, const PixelBuffer &image, const Rect &src_rect, int level=0)
void | clan::Texture2D::set_subimage (GraphicContext &context, const Point &point, const PixelBuffer &image, const Rect &src_rect, int level=0)
void | clan::Texture2D::copy_image_from (GraphicContext &context, int level, TextureFormat texture_format=tf_rgba8)
| Copy image data from a graphic context. More...
void | clan::Texture2D::copy_image_from (GraphicContext &context, int x, int y, int width, int height, int level=0, TextureFormat texture_format=tf_rgba8)
void | clan::Texture2D::copy_image_from (GraphicContext &context, const Rect &pos, int level=0, TextureFormat texture_format=tf_rgba8)
void | clan::Texture2D::copy_subimage_from (GraphicContext &context, int offset_x, int offset_y, int x, int y, int width, int height, int level=0)
| Copy sub image data from a graphic context. More...
void | clan::Texture2D::copy_subimage_from (GraphicContext &context, const Point &offset, const Rect &pos, int level=0)
void | clan::Texture2D::set_wrap_mode (TextureWrapMode wrap_s, TextureWrapMode wrap_t)
void | clan::Texture2D::set_pixel_ratio (float ratio)
| Sets the display pixel ratio for this texture. More...

## Construction
| clan::Texture2DArray::Texture2DArray ()
| Constructs a null instance. More...
| clan::Texture2DArray::Texture2DArray (const std::shared_ptr< Texture_Impl > &impl)
| clan::Texture2DArray::Texture2DArray (GraphicContext &context, int width, int height, int array_size, TextureFormat texture_format=tf_rgba8, int levels=1)
| clan::Texture2DArray::Texture2DArray (GraphicContext &context, const Size &size, int array_size, TextureFormat texture_format=tf_rgba8, int levels=1)

## Attributes
int | clan::Texture2DArray::get_width () const
| Retrieves the actual width of the texture in the display. More...
int | clan::Texture2DArray::get_height () const
| Retrieves the actual height of the texture in the display. More...
Size | clan::Texture2DArray::get_size () const
| Retrieves the actual size of the texture. More...
float | clan::Texture2DArray::get_pixel_ratio () const
float | clan::Texture2DArray::get_dip_width () const
| Returns the device independent width of this texture. More...
float | clan::Texture2DArray::get_dip_height () const
| Returns the device independent height of this texture. More...
Sizef | clan::Texture2DArray::get_dip_size () const
| Returns the device independent size of this texture. More...
int | clan::Texture2DArray::get_array_size () const
| Returns the number of textures in the array. More...
TextureWrapMode | clan::Texture2DArray::get_wrap_mode_s () const
| Get the texture wrap mode for the s coordinate. More...
TextureWrapMode | clan::Texture2DArray::get_wrap_mode_t () const
| Get the texture wrap mode for the t coordinate. More...

## Operations
void | clan::Texture2DArray::set_image (GraphicContext &context, int array_index, const PixelBuffer &image, int level=0)
void | clan::Texture2DArray::set_subimage (GraphicContext &context, int array_index, int x, int y, const PixelBuffer &image, const Rect &src_rect, int level=0)
void | clan::Texture2DArray::set_subimage (GraphicContext &context, int array_index, const Point &point, const PixelBuffer &image, const Rect &src_rect, int level=0)
void | clan::Texture2DArray::set_wrap_mode (TextureWrapMode wrap_s, TextureWrapMode wrap_t)
Texture2D | clan::Texture2DArray::create_2d_view (int array_index, TextureFormat texture_format, int min_level, int num_levels)
| Creates a 2D texture view. More...
void | clan::Texture2DArray::set_pixel_ratio (float ratio)
| Sets the display pixel ratio for this texture. More...

## Construction
| clan::Texture3D::Texture3D ()
| Constructs a null instance. More...
| clan::Texture3D::Texture3D (const std::shared_ptr< Texture_Impl > &impl)
| Constructs a texture from an implementation. More...
| clan::Texture3D::Texture3D (GraphicContext &context, int width, int height, int depth, TextureFormat texture_format=tf_rgba8, int levels=1)
| Constructs a 3D Texture. More...
| clan::Texture3D::Texture3D (GraphicContext &context, const Vec3i &size, TextureFormat texture_format=tf_rgba8, int levels=1)
| Constructs a Texture. More...

## Attributes
int | clan::Texture3D::get_width () const
| Get the texture width. More...
int | clan::Texture3D::get_height () const
| Get the texture height. More...
int | clan::Texture3D::get_depth () const
| Get the texture depth. More...
Vec3i | clan::Texture3D::get_size () const
| Get the texture size. More...
TextureWrapMode | clan::Texture3D::get_wrap_mode_s () const
| Get the texture wrap mode for the s coordinate. More...
TextureWrapMode | clan::Texture3D::get_wrap_mode_t () const
| Get the texture wrap mode for the t coordinate. More...
TextureWrapMode | clan::Texture3D::get_wrap_mode_r () const
| Get the texture wrap mode for the r coordinate. More...

## Operations
void | clan::Texture3D::set_image (GraphicContext &context, PixelBuffer &image, int depth, int level=0)
| Upload image to texture. More...
void | clan::Texture3D::set_subimage (GraphicContext &context, int x, int y, int z, const PixelBuffer &image, const Rect &src_rect, int level=0)
| Upload image to sub texture. More...
void | clan::Texture3D::set_wrap_mode (TextureWrapMode wrap_s, TextureWrapMode wrap_t, TextureWrapMode wrap_r)
| Set the texture wrapping mode. More...

## Construction
| clan::TextureCube::TextureCube ()
| Constructs a null instance. More...
| clan::TextureCube::TextureCube (const std::shared_ptr< Texture_Impl > &impl)
| Constructs a texture from an implementation. More...
| clan::TextureCube::TextureCube (GraphicContext &context, int width, int height, TextureFormat texture_format=tf_rgba8, int levels=1)
| Constructs a Texture. More...
| clan::TextureCube::TextureCube (GraphicContext &context, const Size &size, TextureFormat texture_format=tf_rgba8, int levels=1)
| Constructs a Texture. More...

## Attributes
int | clan::TextureCube::get_width () const
| Get the texture width. More...
int | clan::TextureCube::get_height () const
| Get the texture height. More...
Size | clan::TextureCube::get_size () const
| Get the texture size. More...

## Operations
void | clan::TextureCube::set_image (GraphicContext &context, TextureCubeDirection cube_direction, PixelBuffer &image, int level=0)
| Upload image to texture. More...
void | clan::TextureCube::set_subimage (GraphicContext &context, TextureCubeDirection cube_direction, int x, int y, const PixelBuffer &image, const Rect &src_rect, int level=0)
| Upload image to sub texture. More...
void | clan::TextureCube::set_subimage (GraphicContext &context, TextureCubeDirection cube_direction, const Point &point, const PixelBuffer &image, const Rect &src_rect, int level=0)

## Construction
| clan::TextureCubeArray::TextureCubeArray ()
| Constructs a null instance. More...
| clan::TextureCubeArray::TextureCubeArray (const std::shared_ptr< Texture_Impl > &impl)
| Constructs a texture from an implementation. More...
| clan::TextureCubeArray::TextureCubeArray (GraphicContext &context, int width, int height, int array_size, TextureFormat texture_format=tf_rgba8, int levels=1)
| Constructs a Texture. More...
| clan::TextureCubeArray::TextureCubeArray (GraphicContext &context, const Size &size, int array_size, TextureFormat texture_format=tf_rgba8, int levels=1)
| Constructs a Texture. More...

## Attributes
int | clan::TextureCubeArray::get_width () const
| Get the texture width. More...
int | clan::TextureCubeArray::get_height () const
| Get the texture height. More...
Size | clan::TextureCubeArray::get_size () const
| Get the texture size. More...
int | clan::TextureCubeArray::get_array_size () const
| Get the texture array size. More...

## Operations
void | clan::TextureCubeArray::set_image (GraphicContext &context, int array_index, TextureCubeDirection cube_direction, PixelBuffer &image, int level=0)
| Upload image to texture. More...
void | clan::TextureCubeArray::set_subimage (GraphicContext &context, int array_index, TextureCubeDirection cube_direction, int x, int y, const PixelBuffer &image, const Rect &src_rect, int level=0)
| Upload image to sub texture. More...
void | clan::TextureCubeArray::set_subimage (GraphicContext &context, int array_index, TextureCubeDirection cube_direction, const Point &point, const PixelBuffer &image, const Rect &src_rect, int level=0)

## Construction
| clan::TransferBuffer::TransferBuffer ()
| Constructs a null instance. More...
| clan::TransferBuffer::TransferBuffer (GraphicContext &gc, int size, BufferUsage usage=usage_dynamic_copy)
| Constructs a transfer buffer. More...
| clan::TransferBuffer::TransferBuffer (GraphicContext &gc, const void *data, int size, BufferUsage usage=usage_dynamic_copy)
| Constructs a transfer buffer. More...
virtual | clan::TransferBuffer::~TransferBuffer ()

## Attributes
bool | clan::TransferBuffer::is_null () const
| Returns true if this object is invalid. More...
void | clan::TransferBuffer::throw_if_null () const
| Throw an exception if this object is invalid. More...
void * | clan::TransferBuffer::get_data ()
| Retrieves a pointer to the mapped buffer. More...
TransferBufferProvider * | clan::TransferBuffer::get_provider () const
| Get Provider. More...

## Operations
bool | clan::TransferBuffer::operator== (const TransferBuffer &other) const
| Handle comparison operator. More...
void | clan::TransferBuffer::lock (GraphicContext &gc, BufferAccess access)
| Maps buffer into system memory. More...
void | clan::TransferBuffer::unlock ()
| Unmaps buffer. More...
void | clan::TransferBuffer::upload_data (GraphicContext &gc, int offset, const void *data, int size)
| Uploads data to transfer buffer. More...

## Construction
| clan::TransferTexture::TransferTexture ()
| Constructs a null instance. More...
| clan::TransferTexture::TransferTexture (PixelBufferProvider *provider)
| Constructs a GPU Transfer Buffer. More...
| clan::TransferTexture::TransferTexture (GraphicContext &gc, int width, int height, PixelBufferDirection direction=data_to_gpu, TextureFormat texture_format=tf_rgba8, const void *data=nullptr, BufferUsage usage=usage_stream_draw)
| Constructs a GPU Transfer Buffer. More...
| clan::TransferTexture::TransferTexture (GraphicContext &gc, const PixelBuffer &pbuff, PixelBufferDirection direction=data_to_gpu, BufferUsage usage=usage_stream_draw)
| Constructs a GPU Transfer Buffer from an existing pixelbuffer. More...
| clan::TransferTexture::~TransferTexture ()

## Construction
| clan::TransferVector< Type >::TransferVector ()
| Constructs a null instance. More...
| clan::TransferVector< Type >::TransferVector (GraphicContext &gc, int size, BufferUsage usage=usage_dynamic_copy)
| Constructs a TransferVector. More...
| clan::TransferVector< Type >::TransferVector (GraphicContext &gc, Type *data, int size, BufferUsage usage=usage_dynamic_copy)
| Constructs a TransferVector. More...
| clan::TransferVector< Type >::TransferVector (GraphicContext &gc, const std::vector< Type > &data, BufferUsage usage=usage_dynamic_copy)
| clan::TransferVector< Type >::TransferVector (const TransferBuffer &transfer_buffer)
| Constructs a TransferVector from an existing buffer. More...

## Attributes
Type * | clan::TransferVector< Type >::get_data ()
| Retrieves a pointer to the mapped buffer. More...
Type & | clan::TransferVector< Type >::operator[] (int index)
Type & | clan::TransferVector< Type >::operator[] (unsigned int index)

## Operations
void | clan::TransferVector< Type >::upload_data (GraphicContext &gc, int offset, const Type *data, int size)
| Uploads data to transfer buffer. More...
void | clan::TransferVector< Type >::upload_data (GraphicContext &gc, int offset, const std::vector< Type > &data)
| Uploads data to transfer buffer. More...

## Construction
| clan::UniformBuffer::UniformBuffer ()
| Constructs a null instance. More...
| clan::UniformBuffer::UniformBuffer (GraphicContext &gc, int block_size, BufferUsage usage=usage_dynamic_draw)
| Constructs a ProgramUniformBlock. More...
| clan::UniformBuffer::UniformBuffer (GraphicContext &gc, const void *data, int size, BufferUsage usage=usage_dynamic_draw)
| Constructs a VertexArrayBuffer. More...
| clan::UniformBuffer::UniformBuffer (GraphicContext &gc, ProgramObject &program, const std::string &name, int num_blocks=1, BufferUsage usage=usage_dynamic_draw)
| Constructs a ProgramUniformBlock - convenience function. More...

## Attributes
bool | clan::UniformBuffer::is_null () const
| Returns true if this object is invalid. More...
void | clan::UniformBuffer::throw_if_null () const
| Throw an exception if this object is invalid. More...
UniformBufferProvider * | clan::UniformBuffer::get_provider () const
| Get Provider. More...

## Operations
bool | clan::UniformBuffer::operator== (const UniformBuffer &other) const
| Handle comparison operator. More...
void | clan::UniformBuffer::upload_data (GraphicContext &gc, const void *data, int size)
| Uploads data to uniforms buffer. More...
void | clan::UniformBuffer::copy_from (GraphicContext &gc, TransferBuffer &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data from transfer buffer. More...
void | clan::UniformBuffer::copy_to (GraphicContext &gc, TransferBuffer &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data to transfer buffer. More...

## Construction
| clan::UniformVector< Type >::UniformVector ()
| Constructs a null instance. More...
| clan::UniformVector< Type >::UniformVector (GraphicContext &gc, int size, BufferUsage usage=usage_static_draw)
| Constructs a ElementArrayBuffer. More...
| clan::UniformVector< Type >::UniformVector (GraphicContext &gc, Type *data, int size, BufferUsage usage=usage_static_draw)
| Constructs a ElementArrayBuffer. More...
| clan::UniformVector< Type >::UniformVector (GraphicContext &gc, const std::vector< Type > &data, BufferUsage usage=usage_static_draw)

## Operations
void | clan::UniformVector< Type >::upload_data (GraphicContext &gc, const Type *data, int size)
| Uploads data to uniforms buffer. More...
void | clan::UniformVector< Type >::upload_data (GraphicContext &gc, const std::vector< Type > &data)
| Uploads data to uniforms buffer. More...
void | clan::UniformVector< Type >::copy_from (GraphicContext &gc, TransferVector< Type > &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data from transfer buffer. More...
void | clan::UniformVector< Type >::copy_to (GraphicContext &gc, TransferVector< Type > &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data to transfer buffer. More...

## Construction
| clan::VertexArrayBuffer::VertexArrayBuffer ()
| Constructs a null instance. More...
| clan::VertexArrayBuffer::VertexArrayBuffer (GraphicContext &gc, int size, BufferUsage usage=usage_static_draw)
| Constructs a VertexArrayBuffer. More...
| clan::VertexArrayBuffer::VertexArrayBuffer (GraphicContext &gc, const void *data, int size, BufferUsage usage=usage_static_draw)
| Constructs a VertexArrayBuffer. More...
virtual | clan::VertexArrayBuffer::~VertexArrayBuffer ()

## Attributes
bool | clan::VertexArrayBuffer::is_null () const
| Returns true if this object is invalid. More...
void | clan::VertexArrayBuffer::throw_if_null () const
| Throw an exception if this object is invalid. More...
VertexArrayBufferProvider * | clan::VertexArrayBuffer::get_provider () const
| Get Provider. More...

## Operations
bool | clan::VertexArrayBuffer::operator== (const VertexArrayBuffer &other) const
| Handle comparison operator. More...
void | clan::VertexArrayBuffer::upload_data (GraphicContext &gc, int offset, const void *data, int size)
| Uploads data to vertex array buffer. More...
void | clan::VertexArrayBuffer::copy_from (GraphicContext &gc, TransferBuffer &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data from transfer buffer. More...
void | clan::VertexArrayBuffer::copy_to (GraphicContext &gc, TransferBuffer &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data to transfer buffer. More...

## Construction
| clan::VertexArrayVector< Type >::VertexArrayVector ()
| Constructs a null instance. More...
| clan::VertexArrayVector< Type >::VertexArrayVector (const VertexArrayBuffer &buffer)
| Constructs a VertexArrayBuffer using an existing VertexArrayBuffer. More...
| clan::VertexArrayVector< Type >::VertexArrayVector (GraphicContext &gc, int size, BufferUsage usage=usage_static_draw)
| Constructs a VertexArrayBuffer. More...
| clan::VertexArrayVector< Type >::VertexArrayVector (GraphicContext &gc, Type *data, int size, BufferUsage usage=usage_static_draw)
| Constructs a VertexArrayBuffer. More...
| clan::VertexArrayVector< Type >::VertexArrayVector (GraphicContext &gc, const std::vector< Type > &data, BufferUsage usage=usage_static_draw)

## Operations
void | clan::VertexArrayVector< Type >::upload_data (GraphicContext &gc, int offset, const Type *data, int size)
| Uploads data to vertex array buffer. More...
void | clan::VertexArrayVector< Type >::upload_data (GraphicContext &gc, int offset, const std::vector< Type > &data)
| Uploads data to vertex array buffer. More...
void | clan::VertexArrayVector< Type >::copy_from (GraphicContext &gc, TransferVector< Type > &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data from transfer buffer. More...
void | clan::VertexArrayVector< Type >::copy_to (GraphicContext &gc, TransferVector< Type > &buffer, int dest_pos=0, int src_pos=0, int size=-1)
| Copies data to transfer buffer. More...

## Construction
| clan::ScreenInfo::ScreenInfo ()
| Constructs a ScreenInfo object. More...

## Attributes
std::vector< Rectf > | clan::ScreenInfo::get_screen_geometries (int &primary_screen_index) const
| Returns the geometries of the attached screens and the index of the primary screen in the returned array. More...

## Construction
| clan::ShaderEffect::ShaderEffect ()
| Constructs a null instance. More...
| clan::ShaderEffect::ShaderEffect (GraphicContext &gc, const ShaderEffectDescription &description)
| Constructs a shader effect. More...

## Attributes
bool | clan::ShaderEffect::is_null () const

## Operations
void | clan::ShaderEffect::dispatch (GraphicContext &gc, int x, int y=1, int z=1)
void | clan::ShaderEffect::draw (GraphicContext &gc)

## Construction
| clan::ShaderEffectDescription::ShaderEffectDescription ()

## Operations
void | clan::ShaderEffectDescription::set_glsl_version (int version=330)
void | clan::ShaderEffectDescription::set_define (std::string name, std::string value="1")
void | clan::ShaderEffectDescription::set_vertex_shader (std::string code, ShaderLanguage language=shader_glsl)
void | clan::ShaderEffectDescription::set_fragment_shader (std::string code, ShaderLanguage language=shader_glsl)
void | clan::ShaderEffectDescription::set_compute_shader (std::string code, ShaderLanguage language=shader_glsl)
RasterizerStateDescription & | clan::ShaderEffectDescription::rasterizer ()
BlendStateDescription & | clan::ShaderEffectDescription::blend ()
DepthStencilStateDescription & | clan::ShaderEffectDescription::depth_stencil ()
void | clan::ShaderEffectDescription::set_frag_data (std::string name, RenderBuffer buffer)
void | clan::ShaderEffectDescription::set_frag_data (std::string name, Texture texture)
void | clan::ShaderEffectDescription::set_frag_data_to_back_buffer (std::string name)
void | clan::ShaderEffectDescription::set_depth_data (RenderBuffer buffer)
void | clan::ShaderEffectDescription::set_depth_data (Texture texture)
void | clan::ShaderEffectDescription::set_stencil_data (RenderBuffer buffer)
void | clan::ShaderEffectDescription::set_stencil_data (Texture texture)
void | clan::ShaderEffectDescription::set_texture (std::string name, Resource< Texture > texture)
void | clan::ShaderEffectDescription::set_image (std::string name, Resource< Texture > texture)
void | clan::ShaderEffectDescription::set_storage (std::string name, Resource< StorageBuffer > values)
void | clan::ShaderEffectDescription::set_uniform_block (std::string name, Resource< UniformBuffer > values)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayBuffer &buffer, int size, VertexAttributeDataType type, size_t offset=0, int stride=0, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< unsigned char > &buffer, int size, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< char > &buffer, int size, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< unsigned short > &buffer, int size, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< short > &buffer, int size, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< unsigned int > &buffer, int size, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< int > &buffer, int size, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< float > &buffer, int size, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< unsigned char > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< signed char > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< unsigned short > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< signed short > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< unsigned int > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< signed int > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< float > &buffer)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec2ub > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec2b > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec2us > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec2s > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec2ui > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec2i > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec2f > &buffer)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec3ub > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec3b > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec3us > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec3s > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec3ui > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec3i > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec3f > &buffer)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec4ub > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec4b > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec4us > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec4s > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec4ui > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec4i > &buffer, bool normalize=false)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Vec4f > &buffer)
void | clan::ShaderEffectDescription::set_attribute (std::string name, VertexArrayVector< Colorf > &buffer)
void | clan::ShaderEffectDescription::set_attribute_screen_quad (std::string name)
void | clan::ShaderEffectDescription::set_attribute_uv_quad (std::string name)
void | clan::ShaderEffectDescription::set_elements (ElementArrayBuffer &element_array, VertexAttributeDataType indices_type)
void | clan::ShaderEffectDescription::set_elements (ElementArrayVector< unsigned int > &element_array)
void | clan::ShaderEffectDescription::set_elements (ElementArrayVector< unsigned short > &element_array)
void | clan::ShaderEffectDescription::set_elements (ElementArrayVector< unsigned char > &element_array)
void | clan::ShaderEffectDescription::set_draw_count (int count)

## Construction
virtual | clan::CursorProvider::~CursorProvider ()

## Construction
virtual | clan::DisplayTargetProvider::~DisplayTargetProvider ()

## Operations
virtual DisplayWindowProvider * | clan::DisplayTargetProvider::alloc_display_window ()=0
| Allocates a display window provider. More...

## Attributes
Signal< void()> | clan::DisplayWindowSite::sig_lost_focus
| Lost focus signal. More...
Signal< void()> | clan::DisplayWindowSite::sig_got_focus
| Obtained focus signal. More...
Signal< void(float, float)> | clan::DisplayWindowSite::sig_resize
| Resize signal. More...
Signal< void(const Rectf &)> | clan::DisplayWindowSite::sig_paint
| Paint signal. More...
Signal< void()> | clan::DisplayWindowSite::sig_window_close
| Window close signal. More...
Signal< void()> | clan::DisplayWindowSite::sig_window_destroy
| Window destroy signal. More...
Signal< void()> | clan::DisplayWindowSite::sig_window_minimized
| Window minimized signal. More...
Signal< void()> | clan::DisplayWindowSite::sig_window_maximized
| Window maximized signal. More...
Signal< void()> | clan::DisplayWindowSite::sig_window_restored
| Window restored signal. More...
std::function< void(Rectf &)> | clan::DisplayWindowSite::func_window_resize
| Window resize callback function. More...
std::function< bool()> | clan::DisplayWindowSite::func_minimize_clicked
| Minimize button is clicked callback function. More...
Signal< void()> | clan::DisplayWindowSite::sig_window_moved
| Window moved signal. More...

## Construction
virtual | clan::DisplayWindowProvider::~DisplayWindowProvider ()

## Attributes
virtual Rect | clan::DisplayWindowProvider::get_geometry () const =0
| Returns the position and size of the window frame. More...
virtual Rect | clan::DisplayWindowProvider::get_viewport () const =0
| Returns the drawable area of the window. More...
virtual float | clan::DisplayWindowProvider::get_pixel_ratio () const =0
virtual bool | clan::DisplayWindowProvider::has_focus () const =0
| Returns true if window has focus. More...
virtual bool | clan::DisplayWindowProvider::is_minimized () const =0
| Returns true if the window is minimized. More...
virtual bool | clan::DisplayWindowProvider::is_maximized () const =0
| Returns true if the window is maximized. More...
virtual bool | clan::DisplayWindowProvider::is_visible () const =0
| Returns true if the window is visible. More...
virtual bool | clan::DisplayWindowProvider::is_fullscreen () const =0
| Returns true if the window is fullscreen. More...
virtual Size | clan::DisplayWindowProvider::get_minimum_size (bool client_area) const =0
| Returns the minimum size of the window. More...
virtual Size | clan::DisplayWindowProvider::get_maximum_size (bool client_area) const =0
| Returns the maximum size of the window. More...
virtual std::string | clan::DisplayWindowProvider::get_title () const =0
| Returns the maximum size of the window. More...
virtual GraphicContext & | clan::DisplayWindowProvider::get_gc ()=0
| Returns the graphic context for the window. More...
virtual InputContext | clan::DisplayWindowProvider::get_ic ()=0
| Returns the input context for the window. More...
virtual DisplayWindowHandle | clan::DisplayWindowProvider::get_handle () const =0
virtual bool | clan::DisplayWindowProvider::is_clipboard_text_available () const =0
| Returns true if text is available in the clipboard. More...
virtual bool | clan::DisplayWindowProvider::is_clipboard_image_available () const =0
| Returns true if an image is available in the clipboard. More...
virtual std::string | clan::DisplayWindowProvider::get_clipboard_text () const =0
| Returns the text stored in the clipboard. More...
virtual PixelBuffer | clan::DisplayWindowProvider::get_clipboard_image () const =0
| Returns the image stored in the clipboard. More...

## Operations
virtual Point | clan::DisplayWindowProvider::client_to_screen (const Point &client)=0
| Convert from window client coordinates to screen coordinates. More...
virtual Point | clan::DisplayWindowProvider::screen_to_client (const Point &screen)=0
| Convert from screen coordinates to client coordinates. More...
virtual void | clan::DisplayWindowProvider::capture_mouse (bool capture)=0
| Capture/Release the mouse. More...
virtual void | clan::DisplayWindowProvider::request_repaint (const Rect &rect)=0
| Invalidates a region of a screen, causing a repaint. More...
virtual void | clan::DisplayWindowProvider::create (DisplayWindowSite *site, const DisplayWindowDescription &description)=0
| Creates window, assigning site and description to provider. More...
virtual void | clan::DisplayWindowProvider::show_system_cursor ()=0
| Shows the mouse cursor. More...
virtual void | clan::DisplayWindowProvider::hide_system_cursor ()=0
| Hides the mouse cursor. More...
virtual CursorProvider * | clan::DisplayWindowProvider::create_cursor (const CursorDescription &cursor_description)=0
| Creates a new custom cursor. More...
virtual void | clan::DisplayWindowProvider::set_cursor (CursorProvider *cursor)=0
| Sets the current cursor icon. More...
virtual void | clan::DisplayWindowProvider::set_cursor (StandardCursor type)=0
| Sets the current cursor icon. More...
virtual void | clan::DisplayWindowProvider::set_title (const std::string &new_title)=0
| Change window title. More...
virtual void | clan::DisplayWindowProvider::set_position (const Rect &pos, bool client_area)=0
| Sets the position and size of this window on the screen. More...
virtual void | clan::DisplayWindowProvider::set_size (int width, int height, bool client_area)=0
virtual void | clan::DisplayWindowProvider::set_minimum_size (int width, int height, bool client_area)=0
virtual void | clan::DisplayWindowProvider::set_maximum_size (int width, int height, bool client_area)=0
virtual void | clan::DisplayWindowProvider::set_pixel_ratio (float ratio)=0
virtual void | clan::DisplayWindowProvider::set_enabled (bool enable)=0
| Enables or disables input into this window. More...
virtual void | clan::DisplayWindowProvider::minimize ()=0
| Minimizes the window. More...
virtual void | clan::DisplayWindowProvider::restore ()=0
| Restores the window. More...
virtual void | clan::DisplayWindowProvider::maximize ()=0
| Maximizes the window. More...
virtual void | clan::DisplayWindowProvider::show (bool activate)=0
| Displays the window in its current size and position. More...
virtual void | clan::DisplayWindowProvider::hide ()=0
| Hides the window. More...
virtual void | clan::DisplayWindowProvider::bring_to_front ()=0
| Raise window on top of other windows. More...
virtual void | clan::DisplayWindowProvider::flip (int interval)=0
| Flip the window display buffers. More...
virtual void | clan::DisplayWindowProvider::update (const Rect &rect)=0
| Copy a region of the backbuffer to the frontbuffer. More...
virtual void | clan::DisplayWindowProvider::set_clipboard_text (const std::string &text)=0
| Stores text in the clipboard. More...
virtual void | clan::DisplayWindowProvider::set_clipboard_image (const PixelBuffer &buf)=0
| Stores an image in the clipboard. More...
virtual void | clan::DisplayWindowProvider::set_large_icon (const PixelBuffer &image)=0
| Sets the large icon used for this window. More...
virtual void | clan::DisplayWindowProvider::set_small_icon (const PixelBuffer &image)=0
| Sets the small icon used for this window. More...
virtual void | clan::DisplayWindowProvider::enable_alpha_channel (const Rect &blur_rect)=0
virtual void | clan::DisplayWindowProvider::extend_frame_into_client_area (int left, int top, int right, int bottom)=0

## Construction
virtual | clan::ElementArrayBufferProvider::~ElementArrayBufferProvider ()
virtual void | clan::ElementArrayBufferProvider::create (int size, BufferUsage usage)=0
| Constructs a element array buffer. More...
virtual void | clan::ElementArrayBufferProvider::create (void *data, int size, BufferUsage usage)=0
| Create. More...

## Operations
virtual void | clan::ElementArrayBufferProvider::upload_data (GraphicContext &gc, const void *data, int size)=0
| Uploads data to element array buffer. More...
virtual void | clan::ElementArrayBufferProvider::copy_from (GraphicContext &gc, TransferBuffer &buffer, int dest_pos, int src_pos, int size)=0
| Copies data from transfer buffer. More...
virtual void | clan::ElementArrayBufferProvider::copy_to (GraphicContext &gc, TransferBuffer &buffer, int dest_pos, int src_pos, int size)=0
| Copies data to transfer buffer. More...

## Construction
virtual | clan::FrameBufferProvider::~FrameBufferProvider ()

## Attributes
virtual Size | clan::FrameBufferProvider::get_size () const =0
virtual FrameBufferBindTarget | clan::FrameBufferProvider::get_bind_target () const =0

## Operations
virtual void | clan::FrameBufferProvider::attach_color (int attachment_index, const RenderBuffer &render_buffer)=0
| Attach color buffer. More...
virtual void | clan::FrameBufferProvider::attach_color (int attachment_index, const Texture1D &texture, int level)=0
| Attach color buffer. More...
virtual void | clan::FrameBufferProvider::attach_color (int attachment_index, const Texture1DArray &texture, int array_index, int level)=0
| Attach color buffer. More...
virtual void | clan::FrameBufferProvider::attach_color (int attachment_index, const Texture2D &texture, int level)=0
| Attach color buffer. More...
virtual void | clan::FrameBufferProvider::attach_color (int attachment_index, const Texture2DArray &texture, int array_index, int level)=0
| Attach color buffer. More...
virtual void | clan::FrameBufferProvider::attach_color (int attachment_index, const Texture3D &texture, int depth, int level)=0
| Attach color buffer. More...
virtual void | clan::FrameBufferProvider::attach_color (int attachment_index, const TextureCube &texture, TextureSubtype subtype, int level)=0
| Attach color buffer. More...
virtual void | clan::FrameBufferProvider::detach_color (int attachment_index)=0
| Detach color buffer. More...
virtual void | clan::FrameBufferProvider::attach_stencil (const RenderBuffer &render_buffer)=0
virtual void | clan::FrameBufferProvider::attach_stencil (const Texture2D &texture, int level)=0
virtual void | clan::FrameBufferProvider::attach_stencil (const TextureCube &texture, TextureSubtype subtype, int level)=0
virtual void | clan::FrameBufferProvider::detach_stencil ()=0
virtual void | clan::FrameBufferProvider::attach_depth (const RenderBuffer &render_buffer)=0
virtual void | clan::FrameBufferProvider::attach_depth (const Texture2D &texture, int level)=0
virtual void | clan::FrameBufferProvider::attach_depth (const TextureCube &texture, TextureSubtype subtype, int level)=0
virtual void | clan::FrameBufferProvider::detach_depth ()=0
virtual void | clan::FrameBufferProvider::attach_depth_stencil (const RenderBuffer &render_buffer)=0
virtual void | clan::FrameBufferProvider::attach_depth_stencil (const Texture2D &texture, int level)=0
virtual void | clan::FrameBufferProvider::attach_depth_stencil (const TextureCube &texture, TextureSubtype subtype, int level)=0
virtual void | clan::FrameBufferProvider::detach_depth_stencil ()=0
virtual void | clan::FrameBufferProvider::set_bind_target (FrameBufferBindTarget target)=0

## Construction
virtual | clan::GraphicContextProvider::~GraphicContextProvider ()

## Attributes
virtual int | clan::GraphicContextProvider::get_max_attributes ()=0
| Returns the maximum amount of attributes available. More...
virtual Size | clan::GraphicContextProvider::get_max_texture_size () const =0
| Returns the maximum size of a texture this graphic context supports. More...
virtual Size | clan::GraphicContextProvider::get_display_window_size () const =0
| Returns the current size of the display window. More...
virtual float | clan::GraphicContextProvider::get_pixel_ratio () const =0
| Physical pixels/dots per inch. More...
virtual Signal< void(const Size &)> & | clan::GraphicContextProvider::sig_window_resized ()=0
| Get the window resized signal. More...
virtual ProgramObject | clan::GraphicContextProvider::get_program_object (StandardProgram standard_program) const =0
| Get a program object from the standard program specified. More...

## Operations
virtual ClipZRange | clan::GraphicContextProvider::get_clip_z_range () const =0
| Returns in what range clip space z values are clipped. More...
virtual TextureImageYAxis | clan::GraphicContextProvider::get_texture_image_y_axis () const =0
| Returns the Y axis direction for viewports, clipping rects, textures and render targets. More...
virtual ShaderLanguage | clan::GraphicContextProvider::get_shader_language () const =0
| Returns the shader language used. More...
virtual int | clan::GraphicContextProvider::get_major_version () const =0
| Returns the major version / feature level supported by the hardware. More...
virtual int | clan::GraphicContextProvider::get_minor_version () const =0
| Returns the major version / feature level supported by the hardware. More...
virtual bool | clan::GraphicContextProvider::has_compute_shader_support () const =0
| Returns true if the hardware supports compute shaders. More...
virtual PixelBuffer | clan::GraphicContextProvider::get_pixeldata (const Rect &rect, TextureFormat texture_format, bool clamp) const =0
| Return the content of the draw buffer into a pixel buffer. More...
virtual TextureProvider * | clan::GraphicContextProvider::alloc_texture (TextureDimensions texture_dimensions)=0
| Allocate texture provider for this gc. More...
virtual OcclusionQueryProvider * | clan::GraphicContextProvider::alloc_occlusion_query ()=0
| Allocate occlusion query provider of this gc. More...
virtual ProgramObjectProvider * | clan::GraphicContextProvider::alloc_program_object ()=0
| Allocate program object provider of this gc. More...
virtual ShaderObjectProvider * | clan::GraphicContextProvider::alloc_shader_object ()=0
| Allocate shader object provider of this gc. More...
virtual FrameBufferProvider * | clan::GraphicContextProvider::alloc_frame_buffer ()=0
| Allocate frame buffer provider for this gc. More...
virtual RenderBufferProvider * | clan::GraphicContextProvider::alloc_render_buffer ()=0
| Allocate render buffer provider for this gc. More...
virtual VertexArrayBufferProvider * | clan::GraphicContextProvider::alloc_vertex_array_buffer ()=0
| Allocate vertex array buffer provider for this gc. More...
virtual UniformBufferProvider * | clan::GraphicContextProvider::alloc_uniform_buffer ()=0
| Allocate uniform buffer provider for this gc. More...
virtual StorageBufferProvider * | clan::GraphicContextProvider::alloc_storage_buffer ()=0
| Allocate storage buffer provider for this gc. More...
virtual ElementArrayBufferProvider * | clan::GraphicContextProvider::alloc_element_array_buffer ()=0
| Allocate element array buffer provider for this gc. More...
virtual TransferBufferProvider * | clan::GraphicContextProvider::alloc_transfer_buffer ()=0
| Allocate transfer buffer provider for this gc. More...
virtual PixelBufferProvider * | clan::GraphicContextProvider::alloc_pixel_buffer ()=0
| Allocate pixel buffer provider for this gc. More...
virtual PrimitivesArrayProvider * | clan::GraphicContextProvider::alloc_primitives_array ()=0
| Allocate primitives array provider for this gc. More...
virtual std::shared_ptr< RasterizerStateProvider > | clan::GraphicContextProvider::create_rasterizer_state (const RasterizerStateDescription &desc)=0
| Retrieve rasterizer state object. More...
virtual std::shared_ptr< BlendStateProvider > | clan::GraphicContextProvider::create_blend_state (const BlendStateDescription &desc)=0
| Retrieve blend state object. More...
virtual std::shared_ptr< DepthStencilStateProvider > | clan::GraphicContextProvider::create_depth_stencil_state (const DepthStencilStateDescription &desc)=0
| Retrieve depth-stencil state object. More...
virtual void | clan::GraphicContextProvider::set_rasterizer_state (RasterizerStateProvider *state)=0
| Set active rasterizer state. More...
virtual void | clan::GraphicContextProvider::set_blend_state (BlendStateProvider *state, const Colorf &blend_color, unsigned int sample_mask)=0
| Set active blend state. More...
virtual void | clan::GraphicContextProvider::set_depth_stencil_state (DepthStencilStateProvider *state, int stencil_ref)=0
| Set active depth stencil state. More...
virtual void | clan::GraphicContextProvider::set_program_object (StandardProgram standard_program)=0
| Set active program object to the standard program specified. More...
virtual void | clan::GraphicContextProvider::set_program_object (const ProgramObject &program)=0
| Set active program object. More...
virtual void | clan::GraphicContextProvider::reset_program_object ()=0
| Remove active program object. More...
virtual void | clan::GraphicContextProvider::set_uniform_buffer (int index, const UniformBuffer &buffer)=0
| Select uniform buffer into index. More...
virtual void | clan::GraphicContextProvider::reset_uniform_buffer (int index)=0
| Remove uniform buffer from index. More...
virtual void | clan::GraphicContextProvider::set_storage_buffer (int index, const StorageBuffer &buffer)=0
| Select storage buffer into index. More...
virtual void | clan::GraphicContextProvider::reset_storage_buffer (int index)=0
| Remove storage buffer from index. More...
virtual void | clan::GraphicContextProvider::set_texture (int unit_index, const Texture &texture)=0
| Select texture into unit. More...
virtual void | clan::GraphicContextProvider::reset_texture (int unit_index)=0
| Remove texture from unit. More...
virtual void | clan::GraphicContextProvider::set_image_texture (int unit_index, const Texture &texture)=0
| Select texture into image unit. More...
virtual void | clan::GraphicContextProvider::reset_image_texture (int unit_index)=0
| Remove texture from image unit. More...
virtual bool | clan::GraphicContextProvider::is_frame_buffer_owner (const FrameBuffer &fb)=0
| Returns true if this frame buffer object is owned by this graphic context. More...
virtual void | clan::GraphicContextProvider::set_frame_buffer (const FrameBuffer &write_buffer, const FrameBuffer &read_buffer)=0
| Set a frame buffer for off-screen rendering. More...
virtual void | clan::GraphicContextProvider::reset_frame_buffer ()=0
| Set the rendering buffer back to the screen. More...
virtual void | clan::GraphicContextProvider::set_draw_buffer (DrawBuffer buffer)=0
virtual bool | clan::GraphicContextProvider::is_primitives_array_owner (const PrimitivesArray &primitives_array)=0
| Returns true if this primitives_array is owned by this graphic context. More...
virtual void | clan::GraphicContextProvider::draw_primitives (PrimitivesType type, int num_vertices, const PrimitivesArray &primitives_array)=0
| Draw primitives on gc. More...
virtual void | clan::GraphicContextProvider::set_primitives_array (const PrimitivesArray &primitives_array)=0
| Set the primitives array on the gc. More...
virtual void | clan::GraphicContextProvider::draw_primitives_array (PrimitivesType type, int offset, int num_vertices)=0
| Draws primitives from the current assigned primitives array. More...
virtual void | clan::GraphicContextProvider::draw_primitives_array_instanced (PrimitivesType type, int offset, int num_vertices, int instance_count)=0
| Draws instanced primitives from the current assigned primitives array. More...
virtual void | clan::GraphicContextProvider::set_primitives_elements (ElementArrayBufferProvider *array_provider)=0
| Sets current elements array buffer. More...
virtual void | clan::GraphicContextProvider::draw_primitives_elements (PrimitivesType type, int count, VertexAttributeDataType indices_type, size_t offset=0)=0
| Draw primitives elements. More...
virtual void | clan::GraphicContextProvider::draw_primitives_elements_instanced (PrimitivesType type, int count, VertexAttributeDataType indices_type, size_t offset, int instance_count)=0
| Draw primitives elements instanced. More...
virtual void | clan::GraphicContextProvider::reset_primitives_elements ()=0
| Resets current elements array buffer. More...
virtual void | clan::GraphicContextProvider::draw_primitives_elements (PrimitivesType type, int count, ElementArrayBufferProvider *array_provider, VertexAttributeDataType indices_type, void *offset)=0
| Draw primitives elements. More...
virtual void | clan::GraphicContextProvider::draw_primitives_elements_instanced (PrimitivesType type, int count, ElementArrayBufferProvider *array_provider, VertexAttributeDataType indices_type, void *offset, int instance_count)=0
| Draw primitives elements instanced. More...
virtual void | clan::GraphicContextProvider::reset_primitives_array ()=0
| Reset the primitives arrays. More...
virtual void | clan::GraphicContextProvider::set_scissor (const Rect &rect)=0
| Set scissor. More...
virtual void | clan::GraphicContextProvider::reset_scissor ()=0
| Reset scissor. More...
virtual void | clan::GraphicContextProvider::dispatch (int x, int y, int z)=0
| Execute a compute shader. More...
virtual void | clan::GraphicContextProvider::clear (const Colorf &color)=0
| Clears the whole context using the specified color. More...
virtual void | clan::GraphicContextProvider::clear_depth (float value)=0
| Clear the depth buffer. More...
virtual void | clan::GraphicContextProvider::clear_stencil (int value)=0
| Clear the stencil buffer. More...
virtual void | clan::GraphicContextProvider::set_viewport (const Rectf &viewport)=0
| Set the viewport to be used in user projection map mode. More...
virtual void | clan::GraphicContextProvider::set_viewport (int index, const Rectf &viewport)=0
| Set the specified viewport to be used in user projection map mode. More...
virtual void | clan::GraphicContextProvider::set_depth_range (float n, float f)=0
| Specifies the depth range for all viewports. More...
virtual void | clan::GraphicContextProvider::set_depth_range (int viewport, float n, float f)=0
| Specifies the depth range for the specified viewport. More...
virtual void | clan::GraphicContextProvider::flush ()=0

## Construction
virtual | clan::PixelBufferProvider::~PixelBufferProvider ()
virtual void | clan::PixelBufferProvider::create (const void *data, const Size &new_size, PixelBufferDirection direction, TextureFormat new_format, BufferUsage usage)=0
| Create. More...

## Attributes
virtual void * | clan::PixelBufferProvider::get_data ()=0
| Retrieves a pointer to the mapped buffer. More...
virtual int | clan::PixelBufferProvider::get_pitch () const =0
| Retrieves the pitch of the mapped buffer. Use this after get_data() More...
virtual Size | clan::PixelBufferProvider::get_size () const =0
virtual bool | clan::PixelBufferProvider::is_gpu () const =0
| Returns true if this pixel buffer is a GPU based one. More...
virtual TextureFormat | clan::PixelBufferProvider::get_format () const =0
| Returns the pixel format. More...

## Operations
virtual void | clan::PixelBufferProvider::lock (GraphicContext &gc, BufferAccess access)=0
| Maps buffer into system memory. More...
virtual void | clan::PixelBufferProvider::unlock ()=0
| Unmaps element buffer. More...
virtual void | clan::PixelBufferProvider::upload_data (GraphicContext &gc, const Rect &dest_rect, const void *data)=0
| Uploads data to buffer. More...

## Construction
virtual | clan::PrimitivesArrayProvider::~PrimitivesArrayProvider ()

## Construction
virtual | clan::ProgramObjectProvider::~ProgramObjectProvider ()

## Attributes
virtual unsigned int | clan::ProgramObjectProvider::get_handle () const =0
| Returns the OpenGL program object handle. More...
virtual bool | clan::ProgramObjectProvider::get_link_status () const =0
| Returns true if the link succeeded. More...
virtual bool | clan::ProgramObjectProvider::get_validate_status () const =0
| Returns true if validation succeeded. More...
virtual std::string | clan::ProgramObjectProvider::get_info_log () const =0
| Returns the current info log for the program object. More...
virtual std::vector< ShaderObject > | clan::ProgramObjectProvider::get_shaders () const =0
| Returns the shaders used in this program. More...
virtual int | clan::ProgramObjectProvider::get_attribute_location (const std::string &name) const =0
| Returns the location of a named active attribute. More...
virtual int | clan::ProgramObjectProvider::get_uniform_location (const std::string &name) const =0
| Returns the location of a named uniform variable. More...
virtual int | clan::ProgramObjectProvider::get_uniform_buffer_size (int block_index) const =0
| Get the uniform block size. More...
virtual int | clan::ProgramObjectProvider::get_uniform_buffer_index (const std::string &block_name) const =0
| Get the uniform block index. More...
virtual int | clan::ProgramObjectProvider::get_storage_buffer_index (const std::string &name) const =0
| Get the storage block index. More...

## Operations
virtual void | clan::ProgramObjectProvider::attach (const ShaderObject &obj)=0
| Add shader to program object. More...
virtual void | clan::ProgramObjectProvider::detach (const ShaderObject &obj)=0
| Remove shader from program object. More...
virtual void | clan::ProgramObjectProvider::bind_attribute_location (int index, const std::string &name)=0
| Bind attribute to specific location. More...
virtual void | clan::ProgramObjectProvider::bind_frag_data_location (int color_number, const std::string &name)=0
| Bind shader out variable a specific color buffer location. More...
virtual void | clan::ProgramObjectProvider::link ()=0
| Link program. More...
virtual void | clan::ProgramObjectProvider::validate ()=0
| Validate program. More...
virtual void | clan::ProgramObjectProvider::set_uniform1i (int location, int value_a)=0
| Set uniform variable(s). More...
virtual void | clan::ProgramObjectProvider::set_uniform2i (int location, int value_a, int value_b)=0
virtual void | clan::ProgramObjectProvider::set_uniform3i (int location, int value_a, int value_b, int value_c)=0
virtual void | clan::ProgramObjectProvider::set_uniform4i (int location, int value_a, int value_b, int value_c, int value_d)=0
virtual void | clan::ProgramObjectProvider::set_uniformiv (int location, int size, int count, const int *data)=0
virtual void | clan::ProgramObjectProvider::set_uniform1f (int location, float value_a)=0
virtual void | clan::ProgramObjectProvider::set_uniform2f (int location, float value_a, float value_b)=0
virtual void | clan::ProgramObjectProvider::set_uniform3f (int location, float value_a, float value_b, float value_c)=0
virtual void | clan::ProgramObjectProvider::set_uniform4f (int location, float value_a, float value_b, float value_c, float value_d)=0
virtual void | clan::ProgramObjectProvider::set_uniformfv (int location, int size, int count, const float *data)=0
virtual void | clan::ProgramObjectProvider::set_uniform_matrix (int location, int size, int count, bool transpose, const float *data)=0
virtual void | clan::ProgramObjectProvider::set_uniform_buffer_index (int block_index, int bind_index)=0
virtual void | clan::ProgramObjectProvider::set_storage_buffer_index (int buffer_index, int bind_unit_index)=0

## Construction
virtual | clan::RenderBufferProvider::~RenderBufferProvider ()

## Operations
virtual void | clan::RenderBufferProvider::create (int width, int height, TextureFormat texture_format, int multisample_samples)=0
| Create a render buffer image with the specified dimensions. More...

## Construction
virtual | clan::ShaderObjectProvider::~ShaderObjectProvider ()
virtual void | clan::ShaderObjectProvider::create (ShaderType type, const std::string &source)=0
| Creates a shader object. More...
virtual void | clan::ShaderObjectProvider::create (ShaderType type, const void *source, int source_size)=0
| Creates a shader object. More...
virtual void | clan::ShaderObjectProvider::create (ShaderType type, const std::vector< std::string > &sources)=0
| Create. More...

## Attributes
virtual unsigned int | clan::ShaderObjectProvider::get_handle () const =0
| Returns the OpenGL shader handle. More...
virtual bool | clan::ShaderObjectProvider::get_compile_status () const =0
| Returns true if compile succeeded. More...
virtual ShaderType | clan::ShaderObjectProvider::get_shader_type () const =0
| Gets the shader type. More...
virtual std::string | clan::ShaderObjectProvider::get_info_log () const =0
| Get shader object's info log. More...
virtual std::string | clan::ShaderObjectProvider::get_shader_source () const =0
| Get shader source code. More...

## Operations
virtual void | clan::ShaderObjectProvider::compile ()=0
| Compile program. More...

## Construction
virtual | clan::StorageBufferProvider::~StorageBufferProvider ()
virtual void | clan::StorageBufferProvider::create (int size, int stride, BufferUsage usage)=0
| Constructs a vertex array buffer. More...
virtual void | clan::StorageBufferProvider::create (const void *data, int size, int stride, BufferUsage usage)=0
| Create. More...

## Operations
virtual void | clan::StorageBufferProvider::upload_data (GraphicContext &gc, const void *data, int size)=0
| Uploads data to storages buffer. More...
virtual void | clan::StorageBufferProvider::copy_from (GraphicContext &gc, TransferBuffer &buffer, int dest_pos, int src_pos, int size)=0
| Copies data from transfer buffer. More...
virtual void | clan::StorageBufferProvider::copy_to (GraphicContext &gc, TransferBuffer &buffer, int dest_pos, int src_pos, int size)=0
| Copies data to transfer buffer. More...

## Construction
virtual | clan::TextureProvider::~TextureProvider ()

## Operations
virtual void | clan::TextureProvider::create (int width, int height, int depth, int array_size, TextureFormat texture_format, int levels)=0
| Create texture. More...
virtual PixelBuffer | clan::TextureProvider::get_pixeldata (GraphicContext &gc, TextureFormat texture_format, int level) const =0
| Retrieve image data from texture. More...
virtual void | clan::TextureProvider::generate_mipmap ()=0
| Generate the mipmap. More...
virtual void | clan::TextureProvider::copy_from (GraphicContext &gc, int x, int y, int slice, int level, const PixelBuffer &src, const Rect &src_rect)=0
| Copy image data to texture. More...
virtual void | clan::TextureProvider::copy_image_from (int x, int y, int width, int height, int level, TextureFormat texture_format, GraphicContextProvider *gc)=0
| Copy image data from a graphic context. More...
virtual void | clan::TextureProvider::copy_subimage_from (int offset_x, int offset_y, int x, int y, int width, int height, int level, GraphicContextProvider *gc)=0
| Copy sub image data from a graphic context. More...
virtual void | clan::TextureProvider::set_min_lod (double min_lod)=0
| Set the minimum level of detail texture parameter. More...
virtual void | clan::TextureProvider::set_max_lod (double max_lod)=0
| Set the maximum level of detail texture parameter. More...
virtual void | clan::TextureProvider::set_lod_bias (double lod_bias)=0
| Sets the level of detail bias constant. More...
virtual void | clan::TextureProvider::set_base_level (int base_level)=0
| Sets the texture base level texture parameter. More...
virtual void | clan::TextureProvider::set_max_level (int max_level)=0
| Sets the texture max level texture parameter. More...
virtual void | clan::TextureProvider::set_wrap_mode (TextureWrapMode wrap_s, TextureWrapMode wrap_t, TextureWrapMode wrap_r)=0
| Set the texture wrapping mode. More...
virtual void | clan::TextureProvider::set_wrap_mode (TextureWrapMode wrap_s, TextureWrapMode wrap_t)=0
virtual void | clan::TextureProvider::set_wrap_mode (TextureWrapMode wrap_s)=0
virtual void | clan::TextureProvider::set_min_filter (TextureFilter filter)=0
| Set the minification filter. More...
virtual void | clan::TextureProvider::set_mag_filter (TextureFilter filter)=0
| Set the magnification filter. More...
virtual void | clan::TextureProvider::set_max_anisotropy (float v)=0
| Set the maximum degree of anisotropy. More...
virtual void | clan::TextureProvider::set_texture_compare (TextureCompareMode mode, CompareFunction func)=0
| Sets the texture compare mode and compare function texture parameters. More...
virtual TextureProvider * | clan::TextureProvider::create_view (TextureDimensions texture_dimensions, TextureFormat texture_format, int min_level, int num_levels, int min_layer, int num_layers)=0
| Creates a texture view for this texture More...

## Construction
virtual | clan::TransferBufferProvider::~TransferBufferProvider ()
virtual void | clan::TransferBufferProvider::create (int size, BufferUsage usage)=0
| Constructs a array buffer. More...
virtual void | clan::TransferBufferProvider::create (void *data, int size, BufferUsage usage)=0
| Create. More...

## Attributes
virtual void * | clan::TransferBufferProvider::get_data ()=0
| Retrieves a pointer to the mapped buffer. More...

## Operations
virtual void | clan::TransferBufferProvider::lock (GraphicContext &gc, BufferAccess access)=0
| Maps buffer into system memory. More...
virtual void | clan::TransferBufferProvider::unlock ()=0
| Unmaps buffer. More...
virtual void | clan::TransferBufferProvider::upload_data (GraphicContext &gc, int offset, const void *data, int size)=0
| Uploads data to buffer. More...

## Construction
virtual | clan::UniformBufferProvider::~UniformBufferProvider ()
virtual void | clan::UniformBufferProvider::create (int size, BufferUsage usage)=0
| Constructs a vertex array buffer. More...
virtual void | clan::UniformBufferProvider::create (const void *data, int size, BufferUsage usage)=0
| Create. More...

## Operations
virtual void | clan::UniformBufferProvider::upload_data (GraphicContext &gc, const void *data, int size)=0
| Uploads data to uniforms buffer. More...
virtual void | clan::UniformBufferProvider::copy_from (GraphicContext &gc, TransferBuffer &buffer, int dest_pos, int src_pos, int size)=0
| Copies data from transfer buffer. More...
virtual void | clan::UniformBufferProvider::copy_to (GraphicContext &gc, TransferBuffer &buffer, int dest_pos, int src_pos, int size)=0
| Copies data to transfer buffer. More...

## Construction
virtual | clan::VertexArrayBufferProvider::~VertexArrayBufferProvider ()
virtual void | clan::VertexArrayBufferProvider::create (int size, BufferUsage usage)=0
| Constructs a vertex array buffer. More...
virtual void | clan::VertexArrayBufferProvider::create (void *data, int size, BufferUsage usage)=0
| Create. More...

## Operations
virtual void | clan::VertexArrayBufferProvider::upload_data (GraphicContext &gc, int offset, const void *data, int size)=0
| Uploads data to vertex array buffer. More...
virtual void | clan::VertexArrayBufferProvider::copy_from (GraphicContext &gc, TransferBuffer &buffer, int dest_pos, int src_pos, int size)=0
| Copies data from transfer buffer. More...
virtual void | clan::VertexArrayBufferProvider::copy_to (GraphicContext &gc, TransferBuffer &buffer, int dest_pos, int src_pos, int size)=0
| Copies data to transfer buffer. More...

## Detailed Description

## Macro Definition Documentation

#define cl_offsetof | ( |  | s,
|  |  | m
| ) |  | (&(((s *)0)->m))

## Typedef Documentation

typedef PixelBufferLock<signed char> clan::PixelBufferLock1b

typedef PixelBufferLock<double> clan::PixelBufferLock1d

typedef PixelBufferLock<float> clan::PixelBufferLock1f

typedef PixelBufferLock<HalfFloat> clan::PixelBufferLock1hf

typedef PixelBufferLock<signed int> clan::PixelBufferLock1i

typedef PixelBufferLock<signed short> clan::PixelBufferLock1s

typedef PixelBufferLock<unsigned char> clan::PixelBufferLock1ub

typedef PixelBufferLock<unsigned int> clan::PixelBufferLock1ui

typedef PixelBufferLock<unsigned short> clan::PixelBufferLock1us

typedef PixelBufferLock<Vec2b> clan::PixelBufferLock2b

typedef PixelBufferLock<Vec2d> clan::PixelBufferLock2d

typedef PixelBufferLock<Vec2f> clan::PixelBufferLock2f

typedef PixelBufferLock<Vec2hf> clan::PixelBufferLock2hf

typedef PixelBufferLock<Vec2i> clan::PixelBufferLock2i

typedef PixelBufferLock<Vec2s> clan::PixelBufferLock2s

typedef PixelBufferLock<Vec2ub> clan::PixelBufferLock2ub

typedef PixelBufferLock<Vec2ui> clan::PixelBufferLock2ui

typedef PixelBufferLock<Vec2us> clan::PixelBufferLock2us

typedef PixelBufferLock<Vec3b> clan::PixelBufferLock3b

typedef PixelBufferLock<Vec3d> clan::PixelBufferLock3d

typedef PixelBufferLock<Vec3f> clan::PixelBufferLock3f

typedef PixelBufferLock<Vec3hf> clan::PixelBufferLock3hf

typedef PixelBufferLock<Vec3i> clan::PixelBufferLock3i

typedef PixelBufferLock<Vec3s> clan::PixelBufferLock3s

typedef PixelBufferLock<Vec3ub> clan::PixelBufferLock3ub

typedef PixelBufferLock<Vec3ui> clan::PixelBufferLock3ui

typedef PixelBufferLock<Vec3us> clan::PixelBufferLock3us

typedef PixelBufferLock<Vec4b> clan::PixelBufferLock4b

typedef PixelBufferLock<Vec4d> clan::PixelBufferLock4d

typedef PixelBufferLock<Vec4f> clan::PixelBufferLock4f

typedef PixelBufferLock<Vec4hf> clan::PixelBufferLock4hf

typedef PixelBufferLock<Vec4i> clan::PixelBufferLock4i

typedef PixelBufferLock<Vec4s> clan::PixelBufferLock4s

typedef PixelBufferLock<Vec4ub> clan::PixelBufferLock4ub

typedef PixelBufferLock<Vec4ui> clan::PixelBufferLock4ui

typedef PixelBufferLock<Vec4us> clan::PixelBufferLock4us

typedef PixelBufferLock<unsigned char> clan::PixelBufferLockAny

## Enumeration Type Documentation

enum clan::BlendEquation

Blending equations.

Enumerator
equation_add |
equation_subtract |
equation_reverse_subtract |
equation_min |
equation_max |

enum clan::BlendFunc

Blending functions.

Enumerator
blend_zero | source or destination (0, 0, 0, 0)
blend_one | source or destination (1, 1, 1, 1)
blend_dest_color | source (Rd, Gd, Bd, Ad)
blend_src_color | destination (Rs, Gs, Bs, As)
blend_one_minus_dest_color | source (1, 1, 1, 1) - (Rd, Gd, Bd, Ad)
blend_one_minus_src_color | destination (1, 1, 1, 1) - (Rs, Gs, Bs, As)
blend_src_alpha | source or destination (As, As, As, As)
blend_one_minus_src_alpha | source or destination (1, 1, 1, 1) - (As, As, As, As)
blend_dest_alpha | source or destination (Ad, Ad, Ad, Ad)
blend_one_minus_dest_alpha | source or destination (1, 1, 1, 1) - (Ad, Ad, Ad, Ad)
blend_src_alpha_saturate | source (f, f, f, 1) - f = min(As, 1 - Ad)
blend_constant_color | source or destination (Rc, Gc, Bc, Ac)
blend_one_minus_constant_color | source or destination (1, 1, 1, 1) - (Rc, Gc, Bc, Ac)
blend_constant_alpha | source or destination (Ac, Ac, Ac, Ac)
blend_one_minus_constant_alpha | source or destination (1, 1, 1, 1) - (Ac, Ac, Ac, Ac)

enum clan::BufferAccess

Array Buffer access enum.

Enumerator
access_read_only |
access_write_only |
access_read_write |
access_write_discard |

enum clan::BufferUsage

Array Buffer usage enum.

Enumerator
usage_stream_draw |
usage_stream_read |
usage_stream_copy |
usage_static_draw |
usage_static_read |
usage_static_copy |
usage_dynamic_draw |
usage_dynamic_read |
usage_dynamic_copy |

enum clan::CompareFunction

Compare functions.

Enumerator
compare_lequal |
compare_gequal |
compare_less |
compare_greater |
compare_equal |
compare_notequal |
compare_always |
compare_never |

enum clan::CullMode

Polygon culling modes.

Enumerator
cull_front |
cull_back |
cull_front_and_back |

enum clan::DrawBuffer

Drawing buffers.

Enumerator
buffer_none |
buffer_front_left |
buffer_front_right |
buffer_back_left |
buffer_back_right |
buffer_front |
buffer_back |
buffer_left |
buffer_right |
buffer_front_and_back |

enum clan::FaceSide

Front face modes.

Enumerator
face_clockwise |
face_counter_clockwise |

enum clan::FillMode

Polygon filling modes.

Enumerator
fill_point |
fill_line |
fill_polygon |

enum clan::FrameBufferBindTarget

Framebuffer bind target.

Enumerator
framebuffer_draw |
framebuffer_read |

enum clan::LogicOp

Logic Op.

Enumerator
logic_clear |
logic_and |
logic_and_reverse |
logic_copy |
logic_and_inverted |
logic_noop |
logic_xor |
logic_or |
logic_nor |
logic_equiv |
logic_invert |
logic_or_reverse |
logic_copy_inverted |
logic_or_inverted |
logic_nand |
logic_set |

enum clan::MapMode

Mapping modes.

Enumerator
map_2d_upper_left |
map_2d_lower_left |
map_user_projection |

enum clan::PixelBufferDirection

Pixel buffer prefered direction.

Enumerator
data_to_gpu | Use of the pixel buffer is to send data to the gpu.
data_from_gpu | Use of the pixel buffer is to retrieve data from the gpu.

enum clan::PointSpriteOrigin

Point Sprite Origin.

Enumerator
origin_upper_left |
origin_lower_left |

enum clan::PrimitivesType

Primitive types.

Enumerator
type_points |
type_line_strip |
type_line_loop |
type_lines |
type_triangle_strip |
type_triangle_fan |
type_triangles |

enum clan::ShaderLanguage

Shader language used.

Enumerator
shader_glsl |
shader_hlsl |
shader_fixed_function |
num_shader_languages |

enum clan::ShaderType

Shader Type.

Enumerator
shadertype_vertex |
shadertype_geometry |
shadertype_fragment |
shadertype_tess_evaluation |
shadertype_tess_control |
shadertype_compute |
shadertype_num_types |

enum clan::StandardProgram

Standard Program.

Enumerator
program_color_only |
program_single_texture |
program_sprite |
program_path |

enum clan::StencilOp

Stencil operations.

Enumerator
stencil_keep |
stencil_zero |
stencil_replace |
stencil_incr |
stencil_decr |
stencil_invert |
stencil_incr_wrap |
stencil_decr_wrap |

enum clan::TextureCompareMode

Texture compare modes.

Enumerator
comparemode_none |
comparemode_compare_r_to_texture |

enum clan::TextureCubeDirection

Texture cube directions.

Enumerator
cl_cube_positive_x |
cl_cube_negative_x |
cl_cube_positive_y |
cl_cube_negative_y |
cl_cube_positive_z |
cl_cube_negative_z |

enum clan::TextureDimensions

Texture dimensions.

Enumerator
texture_1d |
texture_1d_array |
texture_2d |
texture_2d_array |
texture_3d |
texture_cube |
texture_cube_array |

enum clan::TextureFilter

Texture filters.

Enumerator
filter_nearest |
filter_linear |
filter_nearest_mipmap_nearest |
filter_nearest_mipmap_linear |
filter_linear_mipmap_nearest |
filter_linear_mipmap_linear |

enum clan::TextureFormat

Texture format.

Enumerator
tf_rgba8 |
tf_rgb8 |
tf_bgra8 |
tf_bgr8 |
tf_stencil_index1 |
tf_stencil_index4 |
tf_stencil_index8 |
tf_stencil_index16 |
tf_r8 |
tf_r8_snorm |
tf_r16 |
tf_r16_snorm |
tf_rg8 |
tf_rg8_snorm |
tf_rg16 |
tf_rg16_snorm |
tf_r3_g3_b2 |
tf_rgb4 |
tf_rgb5 |
tf_rgb8_snorm |
tf_rgb10 |
tf_rgb12 |
tf_rgb16 |
tf_rgb16_snorm |
tf_rgba2 |
tf_rgba4 |
tf_rgb5_a1 |
tf_rgba8_snorm |
tf_rgb10_a2 |
tf_rgba12 |
tf_rgba16 |
tf_rgba16_snorm |
tf_srgb8 |
tf_srgb8_alpha8 |
tf_r16f |
tf_rg16f |
tf_rgb16f |
tf_rgba16f |
tf_r32f |
tf_rg32f |
tf_rgb32f |
tf_rgba32f |
tf_r11f_g11f_b10f |
tf_rgb9_e5 |
tf_r8i |
tf_r8ui |
tf_r16i |
tf_r16ui |
tf_r32i |
tf_r32ui |
tf_rg8i |
tf_rg8ui |
tf_rg16i |
tf_rg16ui |
tf_rg32i |
tf_rg32ui |
tf_rgb8i |
tf_rgb8ui |
tf_rgb16i |
tf_rgb16ui |
tf_rgb32i |
tf_rgb32ui |
tf_rgba8i |
tf_rgba8ui |
tf_rgba16i |
tf_rgba16ui |
tf_rgba32i |
tf_rgba32ui |
tf_depth_component16 |
tf_depth_component24 |
tf_depth_component32 |
tf_depth_component32f |
tf_depth24_stencil8 |
tf_depth32f_stencil8 |
tf_compressed_red |
tf_compressed_rg |
tf_compressed_rgb |
tf_compressed_rgba |
tf_compressed_srgb |
tf_compressed_srgb_alpha |
tf_compressed_red_rgtc1 |
tf_compressed_signed_red_rgtc1 |
tf_compressed_rg_rgtc2 |
tf_compressed_signed_rg_rgtc2 |
tf_compressed_rgb_s3tc_dxt1 |
tf_compressed_rgba_s3tc_dxt1 |
tf_compressed_rgba_s3tc_dxt3 |
tf_compressed_rgba_s3tc_dxt5 |
tf_compressed_srgb_s3tc_dxt1 |
tf_compressed_srgb_alpha_s3tc_dxt1 |
tf_compressed_srgb_alpha_s3tc_dxt3 |
tf_compressed_srgb_alpha_s3tc_dxt5 |

enum clan::TextureImageYAxis

Y axis direction for viewports, clipping rects, textures and render targets.

Enumerator
y_axis_bottom_up | OpenGL, origin is lower left with Y going upwards.
y_axis_top_down | Direct3D, origin is upper left with Y going downwards.

enum clan::TextureSubtype

Texture Subtype.

Enumerator
subtype_cube_map_positive_x |
subtype_cube_map_negative_x |
subtype_cube_map_positive_y |
subtype_cube_map_negative_y |
subtype_cube_map_positive_z |
subtype_cube_map_negative_z |

enum clan::TextureWrapMode

Texture coordinate wrapping modes.

Enumerator
wrap_clamp_to_edge |
wrap_repeat |
wrap_mirrored_repeat |

enum clan::VertexAttributeDataType

Primitives array description.

Enumerator
type_unsigned_byte |
type_unsigned_short |
type_unsigned_int |
type_byte |
type_short |
type_int |
type_float |

## Function Documentation

clan::BlendState::BlendState | ( |  | ) |

Constructs a null instance.

clan::BlendState::BlendState | ( | GraphicContext & | context,
|  | const BlendStateDescription & | desc
| ) |  |

Constructs a Texture.

Parameters

  context | = Graphic context
  desc | = Blend state description

clan::BlendStateDescription::BlendStateDescription | ( |  | ) |

clan::Canvas::Canvas | ( |  | ) |

Constructs a null instance.

clan::Canvas::Canvas | ( | Canvas & | canvas,
|  | FrameBuffer & | framebuffer
| ) |  |

Constructs a Canvas based on a framebuffer. (based on the copy of the canvas)

clan::Canvas::Canvas | ( | DisplayWindow & | window | ) |
| explicit

Constructs a Canvas.

clan::DepthStencilState::DepthStencilState | ( |  | ) |

Constructs a null instance.

clan::DepthStencilState::DepthStencilState | ( | GraphicContext & | context,
|  | const DepthStencilStateDescription & | desc
| ) |  |

Constructs a Texture.

Parameters

  context | = Graphic context
  desc | = DepthStencil state description

clan::DepthStencilStateDescription::DepthStencilStateDescription | ( |  | ) |

clan::DisplayTarget::DisplayTarget | ( | DisplayTargetProvider * | provider | ) |

Constructs a DisplayTarget.

Parameters

  provider | = Display Target Provider

clan::ElementArrayBuffer::ElementArrayBuffer | ( |  | ) |

Constructs a null instance.

clan::ElementArrayBuffer::ElementArrayBuffer | ( | GraphicContext & | gc,
|  | int | size,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |

Constructs a ElementArrayBuffer.

Parameters

  gc | = Graphic Context
  size | = value
  usage | = Buffer Usage

clan::ElementArrayBuffer::ElementArrayBuffer | ( | GraphicContext & | gc,
|  | const void * | data,
|  | int | size,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |

Constructs a ElementArrayBuffer.

Parameters

  gc | = Graphic Context
  data | = void
  size | = value
  usage | = Buffer Usage

template<typename Type>

clan::ElementArrayVector< Type >::ElementArrayVector | ( |  | ) |
| inline

Constructs a null instance.

template<typename Type>

clan::ElementArrayVector< Type >::ElementArrayVector | ( | GraphicContext & | gc,
|  | int | size,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |
| inline

Constructs a ElementArrayBuffer.

Parameters

  gc | = Graphic Context
  size | = value
  usage | = Buffer Usage

template<typename Type>

clan::ElementArrayVector< Type >::ElementArrayVector | ( | GraphicContext & | gc,
|  | Type * | data,
|  | int | size,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |
| inline

Constructs a ElementArrayBuffer.

Parameters

  gc | = Graphic Context
  data | = void
  size | = value
  usage | = Buffer Usage

template<typename Type>

clan::ElementArrayVector< Type >::ElementArrayVector | ( | GraphicContext & | gc,
|  | const std::vector< Type > & | data,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |
| inline

clan::FrameBuffer::FrameBuffer | ( |  | ) |

Constructs a null instance.

clan::FrameBuffer::FrameBuffer | ( | GraphicContext & | context | ) |

Constructs a FrameBuffer.

By default, the bind target is set to framebuffer_draw. See set_bind_target()

Parameters

  context | = Graphic Context

clan::GraphicContext::GraphicContext | ( |  | ) |

Constructs a null instance.

clan::GraphicContext::GraphicContext | ( | GraphicContextProvider * | provider | ) |

Constructs a new graphic context from a provider.

Parameters

  provider | = Graphic Context Provider

clan::IconSet::IconSet | ( |  | ) |

Constructs an icon set.

clan::ImageImportDescription::ImageImportDescription | ( |  | ) |

Constructs a image import description with default values.

clan::OcclusionQuery::OcclusionQuery | ( |  | ) |

Constructs a null instance.

clan::OcclusionQuery::OcclusionQuery | ( | GraphicContext & | context | ) |

Constructs an occlusion query object.

clan::PerlinNoise::PerlinNoise | ( |  | ) |

Constructor.

clan::PixelBuffer::PixelBuffer | ( |  | ) |

Constructs a null instance.

clan::PixelBuffer::PixelBuffer | ( | int | width,
|  | int | height,
|  | TextureFormat | texture_format,
|  | const void * | data = `nullptr`,
|  | bool | only_reference_data = `false`
| ) |  |

Constructs a PixelBuffer.

Parameters

  width | = value
  height | = value
  sized_format | = Pixel Format
  data | = The data (0 = Allocate automatically to a boundary of 16 bytes)
  only_reference_data | : true = Reference the data. false = Copy the data

clan::PixelBuffer::PixelBuffer | ( | const std::string & | fullname,
|  | bool | srgb = `false`
| ) |  |

Constructs a PixelBuffer.

Parameters

  fullname | = String Ref

clan::PixelBuffer::PixelBuffer | ( | const std::string & | filename,
|  | const FileSystem & | file_system,
|  | bool | srgb = `false`
| ) |  |

Constructs a PixelBuffer.

Parameters

  filename | = String Ref
  dir | = Virtual Directory

clan::PixelBuffer::PixelBuffer | ( | IODevice & | file,
|  | const std::string & | image_type,
|  | bool | srgb = `false`
| ) |  |

Constructs a PixelBuffer.

Parameters

  file | = IODevice
  image_type | = String

clan::PixelBuffer::PixelBuffer | ( | PixelBufferProvider * | provider | ) |

Constructs a PixelBuffer.

Parameters

  provider | = Font Provider

template<typename Type >

clan::PixelBufferLock< Type >::PixelBufferLock | ( | GraphicContext & | gc,
|  | PixelBuffer & | pixel_buffer,
|  | BufferAccess | access,
|  | bool | lock_pixelbuffer = `true`
| ) |  |
| inline

Constructs a gpu pixel buffer lock.

References clan::PixelBuffer::get_height(), clan::PixelBuffer::get_width(), and clan::PixelBufferLock< Type >::lock().

template<typename Type >

clan::PixelBufferLock< Type >::PixelBufferLock | ( | PixelBuffer & | pixel_buffer,
|  | bool | lock_pixelbuffer = `true`
| ) |  |
| inline

Constructs a system pixel buffer lock.

References clan::PixelBuffer::get_height(), clan::PixelBuffer::get_width(), and clan::PixelBufferLock< Type >::lock().

clan::PixelBufferSet::PixelBufferSet | ( |  | ) |

Constructs a null instance.

clan::PixelBufferSet::PixelBufferSet | ( | TextureDimensions | dimensions,
|  | TextureFormat | format,
|  | int | width,
|  | int | height = `1`,
|  | int | slices = `1`
| ) |  |

Constructs an image set of the specified dimensions type and internal format.

clan::PixelBufferSet::PixelBufferSet | ( | const PixelBuffer & | image | ) |

Constructs an image set with a single image using the dimensions and internal format of the pixel buffer.

clan::PixelConverter::PixelConverter | ( |  | ) |

Constructs a pixel format converter.

clan::PrimitivesArray::PrimitivesArray | ( |  | ) |

Construct a null instance.

clan::PrimitivesArray::PrimitivesArray | ( | GraphicContext & | gc | ) |

Constructs a PrimitivesArray.

Parameters

  gc | = Graphic Context

clan::ProgramObject::ProgramObject | ( |  | ) |

Construct a null instance.

clan::ProgramObject::ProgramObject | ( | GraphicContext & | gc | ) |

Constructs a ProgramObject.

Parameters

  gc | = Graphic Context

clan::ProgramObject::ProgramObject | ( | GraphicContextProvider * | gc_provider | ) |

Constructs a ProgramObject.

Parameters

  gc_provider | = Graphic Context Provider

clan::ProgramObject::ProgramObject | ( | ProgramObjectProvider * | provider | ) |

Constructs a ProgramObject.

Parameters

  provider | = Font Provider

clan::RasterizerState::RasterizerState | ( |  | ) |

Constructs a null instance.

clan::RasterizerState::RasterizerState | ( | GraphicContext & | context,
|  | const RasterizerStateDescription & | desc
| ) |  |

Constructs a Texture.

Parameters

  context | = Graphic context
  desc | = Rasterizer state description

clan::RasterizerStateDescription::RasterizerStateDescription | ( |  | ) |

clan::RenderBuffer::RenderBuffer | ( |  | ) |

Constructs a null instance.

clan::RenderBuffer::RenderBuffer | ( | GraphicContext & | context,
|  | int | width,
|  | int | height,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | int | multisample_samples = `0`
| ) |  |

Constructs a RenderBuffer.

Parameters

  context | = Graphic Context
  width | = value
  height | = value
  internal_format | = Texture Format

clan::ScreenInfo::ScreenInfo | ( |  | ) |

Constructs a ScreenInfo object.

clan::ShaderEffect::ShaderEffect | ( |  | ) |

Constructs a null instance.

clan::ShaderEffect::ShaderEffect | ( | GraphicContext & | gc,
|  | const ShaderEffectDescription & | description
| ) |  |

Constructs a shader effect.

Parameters

  description | Shader effect description.
  gc | Graphics context in which to create the shader effect.

clan::ShaderEffectDescription::ShaderEffectDescription | ( |  | ) |

clan::ShaderObject::ShaderObject | ( |  | ) |

Constructs a null instance.

clan::ShaderObject::ShaderObject | ( | GraphicContext & | gc,
|  | ShaderType | type,
|  | const std::string & | source
| ) |  |

Constructs an OpenGL shader.

Parameters

  type | Shader type. Can be shadertype_vertex or shadertype_fragment.
  source | Shader source code, in OpenGL Shader Language (GLSL).
  gc | Graphics context in which to create the shader object

clan::ShaderObject::ShaderObject | ( | GraphicContext & | gc,
|  | ShaderType | type,
|  | const void * | source,
|  | int | source_size
| ) |  |

Constructs a ShaderObject.

clan::ShaderObject::ShaderObject | ( | GraphicContext & | gc,
|  | ShaderType | type,
|  | const std::vector< std::string > & | sources
| ) |  |

Constructs a ShaderObject.

Parameters

  gc | = Graphic Context
  type | = Shader Type
  sources | = sources

clan::ShaderObject::ShaderObject | ( | GraphicContextProvider * | gc_provider,
|  | ShaderType | type,
|  | const std::string & | source
| ) |  |

Constructs a ShaderObject.

Parameters

  gc_provider | = Graphic Context Provider
  type | = Shader Type
  source | = String Ref

clan::ShaderObject::ShaderObject | ( | GraphicContextProvider * | gc_provider,
|  | ShaderType | type,
|  | const std::vector< std::string > & | sources
| ) |  |

Constructs a ShaderObject.

Parameters

  gc_provider | = Graphic Context Provider
  type | = Shader Type
  sources | = sources

clan::StorageBuffer::StorageBuffer | ( |  | ) |

Constructs a null instance.

clan::StorageBuffer::StorageBuffer | ( | GraphicContext & | gc,
|  | int | size,
|  | int | stride,
|  | BufferUsage | usage = `usage_dynamic_draw`
| ) |  |

Constructs a buffer.

Parameters

  gc | = Graphic Context
  size | = size - use ProgramObject::get_storage_buffer_size() to calcuate this
  usage | = Buffer Usage

clan::StorageBuffer::StorageBuffer | ( | GraphicContext & | gc,
|  | const void * | data,
|  | int | size,
|  | int | stride,
|  | BufferUsage | usage = `usage_dynamic_draw`
| ) |  |

Constructs a buffer.

Parameters

  gc | = Graphic Context
  data | = void
  size | = value
  usage | = Buffer Usage

template<typename Type >

clan::StorageVector< Type >::StorageVector | ( |  | ) |
| inline

Constructs a null instance.

template<typename Type >

clan::StorageVector< Type >::StorageVector | ( | GraphicContext & | gc,
|  | int | size,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |
| inline

Constructs a ElementArrayBuffer.

Parameters

  gc | = Graphic Context
  size | = value
  usage | = Buffer Usage

template<typename Type >

clan::StorageVector< Type >::StorageVector | ( | GraphicContext & | gc,
|  | Type * | data,
|  | int | size,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |
| inline

Constructs a ElementArrayBuffer.

Parameters

  gc | = Graphic Context
  data | = void
  size | = value
  usage | = Buffer Usage

template<typename Type >

clan::StorageVector< Type >::StorageVector | ( | GraphicContext & | gc,
|  | const std::vector< Type > & | data,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |
| inline

clan::Texture::Texture | ( |  | ) |

Constructs a null instance.

clan::Texture::Texture | ( | GraphicContext & | gc,
|  | PixelBufferSet | pixelbuffer_set
| ) |  |

Constructs a texture as described in a pixelbuffer set.

clan::Texture::Texture | ( | const std::shared_ptr< Texture_Impl > & | impl | ) |

Constructs a texture from an implementation.

Parameters

  impl | = The implementation

clan::Texture::Texture | ( | TextureProvider * | provider | ) |

Constructs a texture from a texture provider.

Parameters

  provider | = The provider

clan::Texture1D::Texture1D | ( |  | ) |

Constructs a null instance.

clan::Texture1D::Texture1D | ( | const std::shared_ptr< Texture_Impl > & | impl | ) |
| inline

Constructs a texture from an implementation.

Parameters

  impl | = The implementation

clan::Texture1D::Texture1D | ( | GraphicContext & | context,
|  | int | size,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | int | levels = `1`
| ) |  |

Constructs a Texture.

Parameters

  context | = Graphic Context
  size | = value
  height | = value
  internal_format | = Texture Format
  levels | = Mipmap levels for the texture. 0 = all levels

clan::Texture1D::Texture1D | ( | GraphicContext & | context,
|  | const PixelBuffer & | image,
|  | bool | is_srgb = `false`
| ) |  |

clan::Texture1D::Texture1D | ( | GraphicContext & | context,
|  | const PixelBuffer & | image,
|  | int | src_x,
|  | int | width,
|  | bool | is_srgb = `false`
| ) |  |

clan::Texture1DArray::Texture1DArray | ( |  | ) |

Constructs a null instance.

clan::Texture1DArray::Texture1DArray | ( | const std::shared_ptr< Texture_Impl > & | impl | ) |
| inline

Constructs a texture from an implementation.

Parameters

  impl | = The implementation

clan::Texture1DArray::Texture1DArray | ( | GraphicContext & | context,
|  | int | size,
|  | int | array_size,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | int | levels = `1`
| ) |  |

Constructs a Texture.

Parameters

  context | = Graphic Context
  size | = value
  height | = value
  internal_format | = Texture Format
  levels | = Mipmap levels for the texture. 0 = all levels

clan::Texture2D::Texture2D | ( |  | ) |

Constructs a null instance.

clan::Texture2D::Texture2D | ( | const std::shared_ptr< Texture_Impl > & | impl | ) |
| inline

Constructs a texture from an implementation.

Parameters

  impl | The Texture object implementation.

clan::Texture2D::Texture2D | ( | GraphicContext & | context,
|  | int | width,
|  | int | height,
|  | TextureFormat | format = `tf_rgba8`,
|  | int | levels = `1`
| ) |  |

Constructs a new Texture object.

Parameters

  context | Graphic context to construct the texture on.
  width | Width of the new texture.
  height | Height of the new texture.
  format | Data format of the new texture.
  levels | Number of mipmap levels for the new texture. Setting this to `0` enables all levels.

clan::Texture2D::Texture2D | ( | GraphicContext & | context,
|  | const Size & | size,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | int | levels = `1`
| ) |  |

Constructs a new Texture object.

Parameters

  context | Graphic context to construct the texture on.
  size | Size of the new texture.
  format | Data format of the new texture.
  levels | Number of mipmap levels for the new texture. Setting this to `0` enables all levels.

clan::Texture2D::Texture2D | ( | GraphicContext & | context,
|  | const std::string & | fullname,
|  | const ImageImportDescription & | import_desc = `{}`
| ) |  |

clan::Texture2D::Texture2D | ( | GraphicContext & | context,
|  | const std::string & | filename,
|  | const FileSystem & | fs,
|  | const ImageImportDescription & | import_desc = `{}`
| ) |  |

clan::Texture2D::Texture2D | ( | GraphicContext & | context,
|  | IODevice & | file,
|  | const std::string & | image_type,
|  | const ImageImportDescription & | import_desc = `{}`
| ) |  |

clan::Texture2D::Texture2D | ( | GraphicContext & | context,
|  | const PixelBuffer & | image,
|  | bool | is_srgb = `false`
| ) |  |

clan::Texture2D::Texture2D | ( | GraphicContext & | context,
|  | const PixelBuffer & | image,
|  | const Rect & | src_rect,
|  | bool | is_srgb = `false`
| ) |  |

clan::Texture2DArray::Texture2DArray | ( |  | ) |

Constructs a null instance.

clan::Texture2DArray::Texture2DArray | ( | const std::shared_ptr< Texture_Impl > & | impl | ) |
| inline

Constructs a texture from an implementation.

Parameters

  impl | The Texture object implementation.

clan::Texture2DArray::Texture2DArray | ( | GraphicContext & | context,
|  | int | width,
|  | int | height,
|  | int | array_size,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | int | levels = `1`
| ) |  |

Constructs a new Texture object.

Parameters

  context | Graphic context to construct the texture on.
  width | Width of the new texture.
  height | Height of the new texture.
  array_size | Number of textures to allocate in this array.
  format | Data format of the new texture.
  levels | Number of mipmap levels for the new texture. Setting this to `0` enables all levels.

clan::Texture2DArray::Texture2DArray | ( | GraphicContext & | context,
|  | const Size & | size,
|  | int | array_size,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | int | levels = `1`
| ) |  |

Constructs a new Texture object.

Parameters

  context | Graphic context to construct the texture on.
  size | Size of the new texture.
  array_size | Number of textures to allocate in this array.
  format | Data format of the new texture.
  levels | Number of mipmap levels for the new texture. Setting this to `0` enables all levels.

clan::Texture3D::Texture3D | ( |  | ) |

Constructs a null instance.

clan::Texture3D::Texture3D | ( | const std::shared_ptr< Texture_Impl > & | impl | ) |
| inline

Constructs a texture from an implementation.

Parameters

  impl | = The implementation

clan::Texture3D::Texture3D | ( | GraphicContext & | context,
|  | int | width,
|  | int | height,
|  | int | depth,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | int | levels = `1`
| ) |  |

Constructs a 3D Texture.

Parameters

  context | = Graphic Context
  width | = value
  height | = value
  depth | = value
  internal_format | = Texture Format
  levels | = Mipmap levels for the texture. 0 = all levels

clan::Texture3D::Texture3D | ( | GraphicContext & | context,
|  | const Vec3i & | size,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | int | levels = `1`
| ) |  |

Constructs a Texture.

Parameters

  context | = Graphic Context
  size | = Size
  internal_format | = Texture Format
  levels | = Mipmap levels for the texture. 0 = all levels

clan::TextureCube::TextureCube | ( |  | ) |

Constructs a null instance.

clan::TextureCube::TextureCube | ( | const std::shared_ptr< Texture_Impl > & | impl | ) |
| inline

Constructs a texture from an implementation.

Parameters

  impl | = The implementation

clan::TextureCube::TextureCube | ( | GraphicContext & | context,
|  | int | width,
|  | int | height,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | int | levels = `1`
| ) |  |

Constructs a Texture.

Parameters

  context | = Graphic Context
  width | = value
  height | = value
  internal_format | = Texture Format
  levels | = Mipmap levels for the texture. 0 = all levels

clan::TextureCube::TextureCube | ( | GraphicContext & | context,
|  | const Size & | size,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | int | levels = `1`
| ) |  |

Constructs a Texture.

Parameters

  context | = Graphic Context
  size | = Size
  internal_format | = Texture Format
  levels | = Mipmap levels for the texture. 0 = all levels

clan::TextureCubeArray::TextureCubeArray | ( |  | ) |

Constructs a null instance.

clan::TextureCubeArray::TextureCubeArray | ( | const std::shared_ptr< Texture_Impl > & | impl | ) |
| inline

Constructs a texture from an implementation.

Parameters

  impl | = The implementation

clan::TextureCubeArray::TextureCubeArray | ( | GraphicContext & | context,
|  | int | width,
|  | int | height,
|  | int | array_size,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | int | levels = `1`
| ) |  |

Constructs a Texture.

Parameters

  context | = Graphic Context
  width | = value
  height | = value
  internal_format | = Texture Format
  levels | = Mipmap levels for the texture. 0 = all levels

clan::TextureCubeArray::TextureCubeArray | ( | GraphicContext & | context,
|  | const Size & | size,
|  | int | array_size,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | int | levels = `1`
| ) |  |

Constructs a Texture.

Parameters

  context | = Graphic Context
  size | = Size
  internal_format | = Texture Format
  levels | = Mipmap levels for the texture. 0 = all levels

clan::TransferBuffer::TransferBuffer | ( |  | ) |

Constructs a null instance.

clan::TransferBuffer::TransferBuffer | ( | GraphicContext & | gc,
|  | int | size,
|  | BufferUsage | usage = `usage_dynamic_copy`
| ) |  |

Constructs a transfer buffer.

Parameters

  gc | = Graphic Context
  size | = value
  usage | = Buffer Usage

clan::TransferBuffer::TransferBuffer | ( | GraphicContext & | gc,
|  | const void * | data,
|  | int | size,
|  | BufferUsage | usage = `usage_dynamic_copy`
| ) |  |

Constructs a transfer buffer.

Parameters

  gc | = Graphic Context
  data | = void
  size | = value
  usage | = Buffer Usage

clan::TransferTexture::TransferTexture | ( |  | ) |

Constructs a null instance.

clan::TransferTexture::TransferTexture | ( | PixelBufferProvider * | provider | ) |

Constructs a GPU Transfer Buffer.

Parameters

  provider | = Font Provider

clan::TransferTexture::TransferTexture | ( | GraphicContext & | gc,
|  | int | width,
|  | int | height,
|  | PixelBufferDirection | direction = `data_to_gpu`,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | const void * | data = `nullptr`,
|  | BufferUsage | usage = `usage_stream_draw`
| ) |  |

Constructs a GPU Transfer Buffer.

Parameters

  gc | = Graphic Context
  width | = value
  height | = value
  direction | = prefered direction that you will use tranferring the pixel buffer data
  sized_format | = Texture Format
  data | = data to copy from (May be NULL)
  usage | = Buffer Usage

clan::TransferTexture::TransferTexture | ( | GraphicContext & | gc,
|  | const PixelBuffer & | pbuff,
|  | PixelBufferDirection | direction = `data_to_gpu`,
|  | BufferUsage | usage = `usage_stream_draw`
| ) |  |

Constructs a GPU Transfer Buffer from an existing pixelbuffer.

Parameters

  gc | = Graphic Context
  pbuff | = The pixelbuffer to copy from
  direction | = prefered direction that you will use tranferring the pixel buffer data
  usage | = Buffer Usage

template<typename Type>

clan::TransferVector< Type >::TransferVector | ( |  | ) |
| inline

Constructs a null instance.

template<typename Type>

clan::TransferVector< Type >::TransferVector | ( | GraphicContext & | gc,
|  | int | size,
|  | BufferUsage | usage = `usage_dynamic_copy`
| ) |  |
| inline

Constructs a TransferVector.

Parameters

  gc | = Graphic Context
  size | = value
  usage | = Buffer Usage

template<typename Type>

clan::TransferVector< Type >::TransferVector | ( | GraphicContext & | gc,
|  | Type * | data,
|  | int | size,
|  | BufferUsage | usage = `usage_dynamic_copy`
| ) |  |
| inline

Constructs a TransferVector.

Parameters

  gc | = Graphic Context
  data | = void
  size | = value
  usage | = Buffer Usage

template<typename Type>

clan::TransferVector< Type >::TransferVector | ( | GraphicContext & | gc,
|  | const std::vector< Type > & | data,
|  | BufferUsage | usage = `usage_dynamic_copy`
| ) |  |
| inline

template<typename Type>

clan::TransferVector< Type >::TransferVector | ( | const TransferBuffer & | transfer_buffer | ) |
| inline explicit

Constructs a TransferVector from an existing buffer.

clan::UniformBuffer::UniformBuffer | ( |  | ) |

Constructs a null instance.

clan::UniformBuffer::UniformBuffer | ( | GraphicContext & | gc,
|  | int | block_size,
|  | BufferUsage | usage = `usage_dynamic_draw`
| ) |  |

Constructs a ProgramUniformBlock.

Parameters

  gc | = Graphic Context
  size | = size - use ProgramObject::get_uniform_buffer_size() to calcuate this
  usage | = Buffer Usage

clan::UniformBuffer::UniformBuffer | ( | GraphicContext & | gc,
|  | const void * | data,
|  | int | size,
|  | BufferUsage | usage = `usage_dynamic_draw`
| ) |  |

Constructs a VertexArrayBuffer.

Parameters

  gc | = Graphic Context
  data | = void
  size | = value
  usage | = Buffer Usage

clan::UniformBuffer::UniformBuffer | ( | GraphicContext & | gc,
|  | ProgramObject & | program,
|  | const std::string & | name,
|  | int | num_blocks = `1`,
|  | BufferUsage | usage = `usage_dynamic_draw`
| ) |  |

Constructs a ProgramUniformBlock - convenience function.

Parameters

  gc | = Graphic Context
  num_blocks | = Number of blocks to allocate
  usage | = Buffer Usage

template<typename Type >

clan::UniformVector< Type >::UniformVector | ( |  | ) |
| inline

Constructs a null instance.

template<typename Type >

clan::UniformVector< Type >::UniformVector | ( | GraphicContext & | gc,
|  | int | size,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |
| inline

Constructs a ElementArrayBuffer.

Parameters

  gc | = Graphic Context
  size | = value
  usage | = Buffer Usage

template<typename Type >

clan::UniformVector< Type >::UniformVector | ( | GraphicContext & | gc,
|  | Type * | data,
|  | int | size,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |
| inline

Constructs a ElementArrayBuffer.

Parameters

  gc | = Graphic Context
  data | = void
  size | = value
  usage | = Buffer Usage

template<typename Type >

clan::UniformVector< Type >::UniformVector | ( | GraphicContext & | gc,
|  | const std::vector< Type > & | data,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |
| inline

clan::VertexArrayBuffer::VertexArrayBuffer | ( |  | ) |

Constructs a null instance.

clan::VertexArrayBuffer::VertexArrayBuffer | ( | GraphicContext & | gc,
|  | int | size,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |

Constructs a VertexArrayBuffer.

Parameters

  gc | = Graphic Context
  size | = value
  usage | = Buffer Usage

clan::VertexArrayBuffer::VertexArrayBuffer | ( | GraphicContext & | gc,
|  | const void * | data,
|  | int | size,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |

Constructs a VertexArrayBuffer.

Parameters

  gc | = Graphic Context
  data | = void
  size | = value
  usage | = Buffer Usage

template<typename Type>

clan::VertexArrayVector< Type >::VertexArrayVector | ( |  | ) |
| inline

Constructs a null instance.

template<typename Type>

clan::VertexArrayVector< Type >::VertexArrayVector | ( | const VertexArrayBuffer & | buffer | ) |
| inline explicit

Constructs a VertexArrayBuffer using an existing VertexArrayBuffer.

template<typename Type>

clan::VertexArrayVector< Type >::VertexArrayVector | ( | GraphicContext & | gc,
|  | int | size,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |
| inline

Constructs a VertexArrayBuffer.

Parameters

  gc | = Graphic Context
  size | = value
  usage | = Buffer Usage

template<typename Type>

clan::VertexArrayVector< Type >::VertexArrayVector | ( | GraphicContext & | gc,
|  | Type * | data,
|  | int | size,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |
| inline

Constructs a VertexArrayBuffer.

Parameters

  gc | = Graphic Context
  data | = void
  size | = value
  usage | = Buffer Usage

template<typename Type>

clan::VertexArrayVector< Type >::VertexArrayVector | ( | GraphicContext & | gc,
|  | const std::vector< Type > & | data,
|  | BufferUsage | usage = `usage_static_draw`
| ) |  |
| inline

virtual clan::BlendStateProvider::~BlendStateProvider | ( |  | ) |
| inline virtual

clan::Canvas::~Canvas | ( |  | ) |

virtual clan::CursorProvider::~CursorProvider | ( |  | ) |
| inline virtual

virtual clan::DepthStencilStateProvider::~DepthStencilStateProvider | ( |  | ) |
| inline virtual

virtual clan::DisplayTarget::~DisplayTarget | ( |  | ) |
| virtual

virtual clan::DisplayTargetProvider::~DisplayTargetProvider | ( |  | ) |
| inline virtual

virtual clan::DisplayWindowProvider::~DisplayWindowProvider | ( |  | ) |
| inline virtual

virtual clan::ElementArrayBuffer::~ElementArrayBuffer | ( |  | ) |
| virtual

virtual clan::ElementArrayBufferProvider::~ElementArrayBufferProvider | ( |  | ) |
| inline virtual

virtual clan::FrameBufferProvider::~FrameBufferProvider | ( |  | ) |
| inline virtual

clan::GraphicContext::~GraphicContext | ( |  | ) |

virtual clan::GraphicContextProvider::~GraphicContextProvider | ( |  | ) |
| inline virtual

clan::ImageImportDescription::~ImageImportDescription | ( |  | ) |

virtual clan::OcclusionQuery::~OcclusionQuery | ( |  | ) |
| virtual

virtual clan::PerlinNoise::~PerlinNoise | ( |  | ) |
| virtual

Destructor.

virtual clan::PixelBuffer::~PixelBuffer | ( |  | ) |
| virtual

template<typename Type >

clan::PixelBufferLock< Type >::~PixelBufferLock | ( |  | ) |
| inline

References clan::PixelBuffer::is_null(), and clan::PixelBuffer::unlock().

virtual clan::PixelBufferProvider::~PixelBufferProvider | ( |  | ) |
| inline virtual

clan::PixelConverter::~PixelConverter | ( |  | ) |

clan::PrimitivesArray::~PrimitivesArray | ( |  | ) |

virtual clan::PrimitivesArrayProvider::~PrimitivesArrayProvider | ( |  | ) |
| inline virtual

virtual clan::ProgramObject::~ProgramObject | ( |  | ) |
| virtual

virtual clan::ProgramObjectProvider::~ProgramObjectProvider | ( |  | ) |
| inline virtual

virtual clan::RasterizerStateProvider::~RasterizerStateProvider | ( |  | ) |
| inline virtual

virtual clan::RenderBatcher::~RenderBatcher | ( |  | ) |
| inline virtual

virtual clan::RenderBufferProvider::~RenderBufferProvider | ( |  | ) |
| inline virtual

virtual clan::ShaderObject::~ShaderObject | ( |  | ) |
| virtual

virtual clan::ShaderObjectProvider::~ShaderObjectProvider | ( |  | ) |
| inline virtual

virtual clan::StorageBufferProvider::~StorageBufferProvider | ( |  | ) |
| inline virtual

virtual clan::Texture::~Texture | ( |  | ) |
| virtual

virtual clan::TextureProvider::~TextureProvider | ( |  | ) |
| inline virtual

virtual clan::TransferBuffer::~TransferBuffer | ( |  | ) |
| virtual

virtual clan::TransferBufferProvider::~TransferBufferProvider | ( |  | ) |
| inline virtual

clan::TransferTexture::~TransferTexture | ( |  | ) |

virtual clan::UniformBufferProvider::~UniformBufferProvider | ( |  | ) |
| inline virtual

virtual clan::VertexArrayBuffer::~VertexArrayBuffer | ( |  | ) |
| virtual

virtual clan::VertexArrayBufferProvider::~VertexArrayBufferProvider | ( |  | ) |
| inline virtual

static PixelBuffer clan::PixelBufferHelp::add_border | ( | const PixelBuffer & | pb,
|  | int | border_size,
|  | const Rect & | rect
| ) |  |
| static

Add a border around a pixelbuffer, duplicating the edge pixels.

static void clan::SharedGCData::add_disposable | ( | DisposableObject * | disposable | ) |
| static

Add disposable.

Parameters

  disposable | = Disposable Object

void clan::IconSet::add_image | ( | const PixelBuffer & | image | ) |

Adds an image to the icon set.

static void clan::SharedGCData::add_provider | ( | GraphicContextProvider * | provider | ) |
| static

Add a provider.

static void clan::SharedGCData::add_ref | ( |  | ) |
| static

Add ref.

virtual DisplayWindowProvider* clan::DisplayTargetProvider::alloc_display_window | ( |  | ) |
| pure virtual

Allocates a display window provider.

virtual ElementArrayBufferProvider* clan::GraphicContextProvider::alloc_element_array_buffer | ( |  | ) |
| pure virtual

Allocate element array buffer provider for this gc.

virtual FrameBufferProvider* clan::GraphicContextProvider::alloc_frame_buffer | ( |  | ) |
| pure virtual

Allocate frame buffer provider for this gc.

virtual OcclusionQueryProvider* clan::GraphicContextProvider::alloc_occlusion_query | ( |  | ) |
| pure virtual

Allocate occlusion query provider of this gc.

virtual PixelBufferProvider* clan::GraphicContextProvider::alloc_pixel_buffer | ( |  | ) |
| pure virtual

Allocate pixel buffer provider for this gc.

virtual PrimitivesArrayProvider* clan::GraphicContextProvider::alloc_primitives_array | ( |  | ) |
| pure virtual

Allocate primitives array provider for this gc.

virtual ProgramObjectProvider* clan::GraphicContextProvider::alloc_program_object | ( |  | ) |
| pure virtual

Allocate program object provider of this gc.

virtual RenderBufferProvider* clan::GraphicContextProvider::alloc_render_buffer | ( |  | ) |
| pure virtual

Allocate render buffer provider for this gc.

virtual ShaderObjectProvider* clan::GraphicContextProvider::alloc_shader_object | ( |  | ) |
| pure virtual

Allocate shader object provider of this gc.

virtual StorageBufferProvider* clan::GraphicContextProvider::alloc_storage_buffer | ( |  | ) |
| pure virtual

Allocate storage buffer provider for this gc.

virtual TextureProvider* clan::GraphicContextProvider::alloc_texture | ( | TextureDimensions | texture_dimensions | ) |
| pure virtual

Allocate texture provider for this gc.

virtual TransferBufferProvider* clan::GraphicContextProvider::alloc_transfer_buffer | ( |  | ) |
| pure virtual

Allocate transfer buffer provider for this gc.

virtual UniformBufferProvider* clan::GraphicContextProvider::alloc_uniform_buffer | ( |  | ) |
| pure virtual

Allocate uniform buffer provider for this gc.

virtual VertexArrayBufferProvider* clan::GraphicContextProvider::alloc_vertex_array_buffer | ( |  | ) |
| pure virtual

Allocate vertex array buffer provider for this gc.

virtual void clan::ProgramObjectProvider::attach | ( | const ShaderObject & | obj | ) |
| pure virtual

Add shader to program object.

void clan::ProgramObject::attach | ( | const ShaderObject & | obj | ) |

Add shader to program object.

virtual void clan::FrameBufferProvider::attach_color | ( | int | attachment_index,
|  | const RenderBuffer & | render_buffer
| ) |  |
| pure virtual

Attach color buffer.

Parameters

  attachment_index | = value
  render_buffer | = Render Buffer

virtual void clan::FrameBufferProvider::attach_color | ( | int | attachment_index,
|  | const Texture1D & | texture,
|  | int | level
| ) |  |
| pure virtual

Attach color buffer.

Parameters

  attachment_index | = value
  texture | = Texture
  level | = value

virtual void clan::FrameBufferProvider::attach_color | ( | int | attachment_index,
|  | const Texture1DArray & | texture,
|  | int | array_index,
|  | int | level
| ) |  |
| pure virtual

Attach color buffer.

Parameters

  attachment_index | = value
  texture | = Texture
  array_index | = value
  level | = value

virtual void clan::FrameBufferProvider::attach_color | ( | int | attachment_index,
|  | const Texture2D & | texture,
|  | int | level
| ) |  |
| pure virtual

Attach color buffer.

Parameters

  attachment_index | = value
  texture | = Texture
  level | = value

virtual void clan::FrameBufferProvider::attach_color | ( | int | attachment_index,
|  | const Texture2DArray & | texture,
|  | int | array_index,
|  | int | level
| ) |  |
| pure virtual

Attach color buffer.

Parameters

  attachment_index | = value
  texture | = Texture
  array_index | = value
  level | = value

virtual void clan::FrameBufferProvider::attach_color | ( | int | attachment_index,
|  | const Texture3D & | texture,
|  | int | depth,
|  | int | level
| ) |  |
| pure virtual

Attach color buffer.

Parameters

  attachment_index | = value
  texture | = Texture
  depth | = value
  level | = value

virtual void clan::FrameBufferProvider::attach_color | ( | int | attachment_index,
|  | const TextureCube & | texture,
|  | TextureSubtype | subtype,
|  | int | level
| ) |  |
| pure virtual

Attach color buffer.

Parameters

  attachment_index | = value
  texture | = Texture
  subtype | = Texture Subtype
  level | = value
  zoffset | = value

void clan::FrameBuffer::attach_color | ( | int | attachment_index,
|  | const RenderBuffer & | render_buffer
| ) |  |

Attach color buffer.

Parameters

  attachment_index | = value
  render_buffer | = Render Buffer

void clan::FrameBuffer::attach_color | ( | int | attachment_index,
|  | const Texture1D & | texture,
|  | int | level = `0`
| ) |  |

Attach color buffer.

Parameters

  attachment_index | = value
  texture | = Texture
  level | = value

void clan::FrameBuffer::attach_color | ( | int | attachment_index,
|  | const Texture1DArray & | texture,
|  | int | array_index = `-1`,
|  | int | level = `0`
| ) |  |

Attach color buffer.

Parameters

  attachment_index | = value
  texture | = Texture
  array_index | = value
  level | = value

void clan::FrameBuffer::attach_color | ( | int | attachment_index,
|  | const Texture2D & | texture,
|  | int | level = `0`
| ) |  |

Attach color buffer.

Parameters

  attachment_index | = value
  texture | = Texture
  level | = value

void clan::FrameBuffer::attach_color | ( | int | attachment_index,
|  | const Texture2DArray & | texture,
|  | int | array_index = `-1`,
|  | int | level = `0`
| ) |  |

Attach color buffer.

Parameters

  attachment_index | = value
  texture | = Texture
  array_index | = value
  level | = value

void clan::FrameBuffer::attach_color | ( | int | attachment_index,
|  | const Texture3D & | texture,
|  | int | depth,
|  | int | level = `0`
| ) |  |

Attach color buffer.

Parameters

  attachment_index | = value
  texture | = Texture
  depth | = value
  level | = value

void clan::FrameBuffer::attach_color | ( | int | attachment_index,
|  | const TextureCube & | texture,
|  | TextureSubtype | subtype,
|  | int | level = `0`
| ) |  |

Attach color buffer.

Parameters

  attachment_index | = value
  texture | = Texture
  subtype | = Texture Subtype
  level | = value
  zoffset | = value

virtual void clan::FrameBufferProvider::attach_depth | ( | const RenderBuffer & | render_buffer | ) |
| pure virtual

virtual void clan::FrameBufferProvider::attach_depth | ( | const Texture2D & | texture,
|  | int | level
| ) |  |
| pure virtual

virtual void clan::FrameBufferProvider::attach_depth | ( | const TextureCube & | texture,
|  | TextureSubtype | subtype,
|  | int | level
| ) |  |
| pure virtual

void clan::FrameBuffer::attach_depth | ( | const RenderBuffer & | render_buffer | ) |

void clan::FrameBuffer::attach_depth | ( | const Texture2D & | texture,
|  | int | level = `0`
| ) |  |

void clan::FrameBuffer::attach_depth | ( | const TextureCube & | texture,
|  | TextureSubtype | subtype,
|  | int | level = `0`
| ) |  |

virtual void clan::FrameBufferProvider::attach_depth_stencil | ( | const RenderBuffer & | render_buffer | ) |
| pure virtual

virtual void clan::FrameBufferProvider::attach_depth_stencil | ( | const Texture2D & | texture,
|  | int | level
| ) |  |
| pure virtual

virtual void clan::FrameBufferProvider::attach_depth_stencil | ( | const TextureCube & | texture,
|  | TextureSubtype | subtype,
|  | int | level
| ) |  |
| pure virtual

void clan::FrameBuffer::attach_depth_stencil | ( | const RenderBuffer & | render_buffer | ) |

void clan::FrameBuffer::attach_depth_stencil | ( | const Texture2D & | texture,
|  | int | level = `0`
| ) |  |

void clan::FrameBuffer::attach_depth_stencil | ( | const TextureCube & | texture,
|  | TextureSubtype | subtype,
|  | int | level = `0`
| ) |  |

virtual void clan::FrameBufferProvider::attach_stencil | ( | const RenderBuffer & | render_buffer | ) |
| pure virtual

virtual void clan::FrameBufferProvider::attach_stencil | ( | const Texture2D & | texture,
|  | int | level
| ) |  |
| pure virtual

virtual void clan::FrameBufferProvider::attach_stencil | ( | const TextureCube & | texture,
|  | TextureSubtype | subtype,
|  | int | level
| ) |  |
| pure virtual

void clan::FrameBuffer::attach_stencil | ( | const RenderBuffer & | render_buffer | ) |

void clan::FrameBuffer::attach_stencil | ( | const Texture2D & | texture,
|  | int | level = `0`
| ) |  |

void clan::FrameBuffer::attach_stencil | ( | const TextureCube & | texture,
|  | TextureSubtype | subtype,
|  | int | level = `0`
| ) |  |

void clan::OcclusionQuery::begin | ( |  | ) |

Start occlusion query.

virtual void clan::ProgramObjectProvider::bind_attribute_location | ( | int | index,
|  | const std::string & | name
| ) |  |
| pure virtual

Bind attribute to specific location.

This function must be called before linking.

void clan::ProgramObject::bind_attribute_location | ( | int | index,
|  | const std::string & | name
| ) |  |

Bind attribute to specific location.

This function must be called before linking.

virtual void clan::ProgramObjectProvider::bind_frag_data_location | ( | int | color_number,
|  | const std::string & | name
| ) |  |
| pure virtual

Bind shader out variable a specific color buffer location.

This function must be called before linking.

void clan::ProgramObject::bind_frag_data_location | ( | int | color_number,
|  | const std::string & | name
| ) |  |

Bind shader out variable a specific color buffer location.

This function must be called before linking.

static BlendStateDescription clan::BlendStateDescription::blend | ( | bool | src_premultiplied,
|  | bool | dest_premultiplied = `true`
| ) |  |
| static

BlendStateDescription& clan::ShaderEffectDescription::blend | ( |  | ) |

virtual void clan::DisplayWindowProvider::bring_to_front | ( |  | ) |
| pure virtual

Raise window on top of other windows.

virtual void clan::DisplayWindowProvider::capture_mouse | ( | bool | capture | ) |
| pure virtual

Capture/Release the mouse.

void clan::Canvas::clear | ( | const Colorf & | color = `Colorf::black` | ) |

Clears the whole context using the specified color.

virtual void clan::GraphicContextProvider::clear | ( | const Colorf & | color | ) |
| pure virtual

Clears the whole context using the specified color.

void clan::GraphicContext::clear | ( | const Colorf & | color = `Colorf::black` | ) |

Clears the whole context using the specified color.

void clan::Canvas::clear_depth | ( | float | value = `0` | ) |

Clear the depth buffer.

Parameters

  value | value to clear to. Range 0.0 - 1.0.

virtual void clan::GraphicContextProvider::clear_depth | ( | float | value | ) |
| pure virtual

Clear the depth buffer.

Parameters

  value | value to clear to. Range 0.0 - 1.0.

void clan::GraphicContext::clear_depth | ( | float | value = `0` | ) |

Clear the depth buffer

Parameters

  value | value to clear to. Range 0.0 - 1.0.

void clan::Canvas::clear_stencil | ( | int | value = `0` | ) |

Clear the stencil buffer.

Parameters

  value | value to clear to.

virtual void clan::GraphicContextProvider::clear_stencil | ( | int | value | ) |
| pure virtual

Clear the stencil buffer.

Parameters

  value | value to clear to.

void clan::GraphicContext::clear_stencil | ( | int | value = `0` | ) |

Clear the stencil buffer

Parameters

  value | value to clear to.

virtual Point clan::DisplayWindowProvider::client_to_screen | ( | const Point & | client | ) |
| pure virtual

Convert from window client coordinates to screen coordinates.

DepthStencilStateDescription clan::DepthStencilStateDescription::clone | ( |  | ) | const

RasterizerStateDescription clan::RasterizerStateDescription::clone | ( |  | ) | const

BlendStateDescription clan::BlendStateDescription::clone | ( |  | ) | const

GraphicContext clan::GraphicContext::clone | ( |  | ) | const

Create a new default graphic context cloned with this one.

virtual void clan::ShaderObjectProvider::compile | ( |  | ) |
| pure virtual

Compile program.

bool clan::ShaderObject::compile | ( |  | ) |

Compile program.

If the compiling fails, get_info_log() will return the compile log.

void clan::PixelConverter::convert | ( | void * | output,
|  | int | output_pitch,
|  | TextureFormat | output_format,
|  | const void * | input,
|  | int | input_pitch,
|  | TextureFormat | input_format,
|  | int | width,
|  | int | height
| ) |  |

Convert some pixel data.

PixelBuffer clan::PixelBuffer::copy | ( |  | ) | const

Create a copy of the pixelbuffer that doesn't share data with the original pixel buffer.

PixelBuffer clan::PixelBuffer::copy | ( | const Rect & | rect | ) | const

Create a copy of the pixelbuffer that doesn't share data with the original pixel buffer.

virtual void clan::StorageBufferProvider::copy_from | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos,
|  | int | src_pos,
|  | int | size
| ) |  |
| pure virtual

Copies data from transfer buffer.

virtual void clan::UniformBufferProvider::copy_from | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos,
|  | int | src_pos,
|  | int | size
| ) |  |
| pure virtual

Copies data from transfer buffer.

virtual void clan::VertexArrayBufferProvider::copy_from | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos,
|  | int | src_pos,
|  | int | size
| ) |  |
| pure virtual

Copies data from transfer buffer.

virtual void clan::ElementArrayBufferProvider::copy_from | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos,
|  | int | src_pos,
|  | int | size
| ) |  |
| pure virtual

Copies data from transfer buffer.

virtual void clan::TextureProvider::copy_from | ( | GraphicContext & | gc,
|  | int | x,
|  | int | y,
|  | int | slice,
|  | int | level,
|  | const PixelBuffer & | src,
|  | const Rect & | src_rect
| ) |  |
| pure virtual

Copy image data to texture.

void clan::VertexArrayBuffer::copy_from | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |

Copies data from transfer buffer.

Referenced by clan::VertexArrayVector< Type >::copy_from().

void clan::StorageBuffer::copy_from | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |

Copies data from transfer buffer.

Referenced by clan::StorageVector< Type >::copy_from().

void clan::ElementArrayBuffer::copy_from | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |

Copies data from transfer buffer.

Referenced by clan::ElementArrayVector< Type >::copy_from().

template<typename Type>

void clan::ElementArrayVector< Type >::copy_from | ( | GraphicContext & | gc,
|  | TransferVector< Type > & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |
| inline

Copies data from transfer buffer.

References clan::ElementArrayBuffer::copy_from().

template<typename Type >

void clan::StorageVector< Type >::copy_from | ( | GraphicContext & | gc,
|  | TransferVector< Type > & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |
| inline

Copies data from transfer buffer.

References clan::StorageBuffer::copy_from().

template<typename Type >

void clan::UniformVector< Type >::copy_from | ( | GraphicContext & | gc,
|  | TransferVector< Type > & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |
| inline

Copies data from transfer buffer.

References clan::UniformBuffer::copy_from().

void clan::UniformBuffer::copy_from | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |

Copies data from transfer buffer.

Referenced by clan::UniformVector< Type >::copy_from().

template<typename Type>

void clan::VertexArrayVector< Type >::copy_from | ( | GraphicContext & | gc,
|  | TransferVector< Type > & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |
| inline

Copies data from transfer buffer.

References clan::VertexArrayBuffer::copy_from().

virtual void clan::TextureProvider::copy_image_from | ( | int | x,
|  | int | y,
|  | int | width,
|  | int | height,
|  | int | level,
|  | TextureFormat | texture_format,
|  | GraphicContextProvider * | gc
| ) |  |
| pure virtual

Copy image data from a graphic context.

void clan::Texture2D::copy_image_from | ( | GraphicContext & | context,
|  | int | level,
|  | TextureFormat | texture_format = `tf_rgba8`
| ) |  |

Copy image data from a graphic context.

void clan::Texture2D::copy_image_from | ( | GraphicContext & | context,
|  | int | x,
|  | int | y,
|  | int | width,
|  | int | height,
|  | int | level = `0`,
|  | TextureFormat | texture_format = `tf_rgba8`
| ) |  |

void clan::Texture2D::copy_image_from | ( | GraphicContext & | context,
|  | const Rect & | pos,
|  | int | level = `0`,
|  | TextureFormat | texture_format = `tf_rgba8`
| ) |  |

virtual void clan::TextureProvider::copy_subimage_from | ( | int | offset_x,
|  | int | offset_y,
|  | int | x,
|  | int | y,
|  | int | width,
|  | int | height,
|  | int | level,
|  | GraphicContextProvider * | gc
| ) |  |
| pure virtual

Copy sub image data from a graphic context.

void clan::Texture2D::copy_subimage_from | ( | GraphicContext & | context,
|  | int | offset_x,
|  | int | offset_y,
|  | int | x,
|  | int | y,
|  | int | width,
|  | int | height,
|  | int | level = `0`
| ) |  |

Copy sub image data from a graphic context.

void clan::Texture2D::copy_subimage_from | ( | GraphicContext & | context,
|  | const Point & | offset,
|  | const Rect & | pos,
|  | int | level = `0`
| ) |  |

virtual void clan::UniformBufferProvider::copy_to | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos,
|  | int | src_pos,
|  | int | size
| ) |  |
| pure virtual

Copies data to transfer buffer.

virtual void clan::StorageBufferProvider::copy_to | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos,
|  | int | src_pos,
|  | int | size
| ) |  |
| pure virtual

Copies data to transfer buffer.

virtual void clan::VertexArrayBufferProvider::copy_to | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos,
|  | int | src_pos,
|  | int | size
| ) |  |
| pure virtual

Copies data to transfer buffer.

virtual void clan::ElementArrayBufferProvider::copy_to | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos,
|  | int | src_pos,
|  | int | size
| ) |  |
| pure virtual

Copies data to transfer buffer.

void clan::VertexArrayBuffer::copy_to | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |

Copies data to transfer buffer.

Referenced by clan::VertexArrayVector< Type >::copy_to().

void clan::StorageBuffer::copy_to | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |

Copies data to transfer buffer.

Referenced by clan::StorageVector< Type >::copy_to().

void clan::ElementArrayBuffer::copy_to | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |

Copies data to transfer buffer.

Referenced by clan::ElementArrayVector< Type >::copy_to().

void clan::UniformBuffer::copy_to | ( | GraphicContext & | gc,
|  | TransferBuffer & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |

Copies data to transfer buffer.

Referenced by clan::UniformVector< Type >::copy_to().

template<typename Type>

void clan::ElementArrayVector< Type >::copy_to | ( | GraphicContext & | gc,
|  | TransferVector< Type > & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |
| inline

Copies data to transfer buffer.

References clan::ElementArrayBuffer::copy_to().

template<typename Type >

void clan::StorageVector< Type >::copy_to | ( | GraphicContext & | gc,
|  | TransferVector< Type > & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |
| inline

Copies data to transfer buffer.

References clan::StorageBuffer::copy_to().

template<typename Type >

void clan::UniformVector< Type >::copy_to | ( | GraphicContext & | gc,
|  | TransferVector< Type > & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |
| inline

Copies data to transfer buffer.

References clan::UniformBuffer::copy_to().

template<typename Type>

void clan::VertexArrayVector< Type >::copy_to | ( | GraphicContext & | gc,
|  | TransferVector< Type > & | buffer,
|  | int | dest_pos = `0`,
|  | int | src_pos = `0`,
|  | int | size = `-1`
| ) |  |
| inline

Copies data to transfer buffer.

References clan::VertexArrayBuffer::copy_to().

virtual void clan::ElementArrayBufferProvider::create | ( | int | size,
|  | BufferUsage | usage
| ) |  |
| pure virtual

Constructs a element array buffer.

virtual void clan::StorageBufferProvider::create | ( | int | size,
|  | int | stride,
|  | BufferUsage | usage
| ) |  |
| pure virtual

Constructs a vertex array buffer.

virtual void clan::UniformBufferProvider::create | ( | int | size,
|  | BufferUsage | usage
| ) |  |
| pure virtual

Constructs a vertex array buffer.

virtual void clan::TransferBufferProvider::create | ( | int | size,
|  | BufferUsage | usage
| ) |  |
| pure virtual

Constructs a array buffer.

virtual void clan::VertexArrayBufferProvider::create | ( | int | size,
|  | BufferUsage | usage
| ) |  |
| pure virtual

Constructs a vertex array buffer.

virtual void clan::ShaderObjectProvider::create | ( | ShaderType | type,
|  | const std::string & | source
| ) |  |
| pure virtual

Creates a shader object.

virtual void clan::ShaderObjectProvider::create | ( | ShaderType | type,
|  | const void * | source,
|  | int | source_size
| ) |  |
| pure virtual

Creates a shader object.

virtual void clan::ElementArrayBufferProvider::create | ( | void * | data,
|  | int | size,
|  | BufferUsage | usage
| ) |  |
| pure virtual

Create.

Parameters

  data | = void
  size | = value
  usage | = Buffer Usage

virtual void clan::StorageBufferProvider::create | ( | const void * | data,
|  | int | size,
|  | int | stride,
|  | BufferUsage | usage
| ) |  |
| pure virtual

Create.

Parameters

  data | = void
  size | = value
  usage | = Buffer Usage

virtual void clan::UniformBufferProvider::create | ( | const void * | data,
|  | int | size,
|  | BufferUsage | usage
| ) |  |
| pure virtual

Create.

Parameters

  data | = void
  size | = value
  usage | = Buffer Usage

virtual void clan::TransferBufferProvider::create | ( | void * | data,
|  | int | size,
|  | BufferUsage | usage
| ) |  |
| pure virtual

Create.

Parameters

  data | = void
  size | = value
  usage | = Buffer Usage

virtual void clan::VertexArrayBufferProvider::create | ( | void * | data,
|  | int | size,
|  | BufferUsage | usage
| ) |  |
| pure virtual

Create.

Parameters

  data | = void
  size | = value
  usage | = Buffer Usage

virtual void clan::PixelBufferProvider::create | ( | const void * | data,
|  | const Size & | new_size,
|  | PixelBufferDirection | direction,
|  | TextureFormat | new_format,
|  | BufferUsage | usage
| ) |  |
| pure virtual

Create.

Parameters

  data | = void
  new_width | = New width
  new_height | = New height
  direction | = Direction
  new_format | = New format
  usage | = Buffer Usage

virtual void clan::ShaderObjectProvider::create | ( | ShaderType | type,
|  | const std::vector< std::string > & | sources
| ) |  |
| pure virtual

Create.

Parameters

  type | = Shader Type
  vector | = std

virtual void clan::RenderBufferProvider::create | ( | int | width,
|  | int | height,
|  | TextureFormat | texture_format,
|  | int | multisample_samples
| ) |  |
| pure virtual

Create a render buffer image with the specified dimensions.

virtual void clan::TextureProvider::create | ( | int | width,
|  | int | height,
|  | int | depth,
|  | int | array_size,
|  | TextureFormat | texture_format,
|  | int | levels
| ) |  |
| pure virtual

Create texture.

Canvas clan::Canvas::create | ( |  | ) |

Create a copy of a canvas.

virtual void clan::DisplayWindowProvider::create | ( | DisplayWindowSite * | site,
|  | const DisplayWindowDescription & | description
| ) |  |
| pure virtual

Creates window, assigning site and description to provider.

GraphicContext clan::GraphicContext::create | ( |  | ) | const

Create a new default graphic context compatible with this one.

GraphicContext clan::GraphicContext::create | ( | FrameBuffer & | buffer | ) | const

Create a new default graphic context with a frame buffer selected.

Texture2D clan::Texture2DArray::create_2d_view | ( | int | array_index,
|  | TextureFormat | texture_format,
|  | int | min_level,
|  | int | num_levels
| ) |  |

Creates a 2D texture view.

virtual std::shared_ptr<BlendStateProvider> clan::GraphicContextProvider::create_blend_state | ( | const BlendStateDescription & | desc | ) |
| pure virtual

Retrieve blend state object.

virtual CursorProvider* clan::DisplayWindowProvider::create_cursor | ( | const CursorDescription & | cursor_description | ) |
| pure virtual

Creates a new custom cursor.

virtual std::shared_ptr<DepthStencilStateProvider> clan::GraphicContextProvider::create_depth_stencil_state | ( | const DepthStencilStateDescription & | desc | ) |
| pure virtual

Retrieve depth-stencil state object.

PixelBuffer clan::PerlinNoise::create_noise1d | ( | float | start_x,
|  | float | end_x
| ) |  |

Create the perlin noise.

Remember to call set_size() with the height set to 1.
The period of these parameters are from 0 to 255

Parameters

  start_x | = Start x position of the noise
  end_x | = End x position of the noise
  start_y | = Start y position of the noise
  end_y | = End y position of the noise

PixelBuffer clan::PerlinNoise::create_noise2d | ( | float | start_x,
|  | float | end_x,
|  | float | start_y,
|  | float | end_y
| ) |  |

Create the perlin noise.

The period of these parameters are from 0 to 255

Parameters

  start_x | = Start x position of the noise
  end_x | = End x position of the noise
  start_y | = Start y position of the noise
  end_y | = End y position of the noise

PixelBuffer clan::PerlinNoise::create_noise3d | ( | float | start_x,
|  | float | end_x,
|  | float | start_y,
|  | float | end_y,
|  | float | z_position
| ) |  |

Create the perlin noise.

The period of these parameters are from 0 to 255

Parameters

  start_x | = Start x position of the noise
  end_x | = End x position of the noise
  start_y | = Start y position of the noise
  end_y | = End y position of the noise
  z_position | = The z position of the noise

PixelBuffer clan::PerlinNoise::create_noise4d | ( | float | start_x,
|  | float | end_x,
|  | float | start_y,
|  | float | end_y,
|  | float | z_position,
|  | float | w_position
| ) |  |

Create the perlin noise.

The period of these parameters are from 0 to 255

Parameters

  start_x | = Start x position of the noise
  end_x | = End x position of the noise
  start_y | = Start y position of the noise
  end_y | = End y position of the noise
  z_position | = The z position of the noise
  w_position | = The w position of the noise

virtual std::shared_ptr<RasterizerStateProvider> clan::GraphicContextProvider::create_rasterizer_state | ( | const RasterizerStateDescription & | desc | ) |
| pure virtual

Retrieve rasterizer state object.

virtual TextureProvider* clan::TextureProvider::create_view | ( | TextureDimensions | texture_dimensions,
|  | TextureFormat | texture_format,
|  | int | min_level,
|  | int | num_levels,
|  | int | min_layer,
|  | int | num_layers
| ) |  |
| pure virtual

Creates a texture view for this texture

DataBuffer clan::IconSet::create_win32_icon | ( |  | ) |

Generates a Windows .ICO format icon from the set.

DepthStencilStateDescription& clan::ShaderEffectDescription::depth_stencil | ( |  | ) |

virtual void clan::ProgramObjectProvider::detach | ( | const ShaderObject & | obj | ) |
| pure virtual

Remove shader from program object.

void clan::ProgramObject::detach | ( | const ShaderObject & | obj | ) |

Remove shader from program object.

virtual void clan::FrameBufferProvider::detach_color | ( | int | attachment_index | ) |
| pure virtual

Detach color buffer.

Parameters

  color_buffer | = value
  texture | = Texture
  level | = value
  zoffset | = value

void clan::FrameBuffer::detach_color | ( | int | attachment_index | ) |

Detach color buffer.

Parameters

  attachment_index | = value
  texture | = Texture
  level | = value
  zoffset | = value

virtual void clan::FrameBufferProvider::detach_depth | ( |  | ) |
| pure virtual

void clan::FrameBuffer::detach_depth | ( |  | ) |

virtual void clan::FrameBufferProvider::detach_depth_stencil | ( |  | ) |
| pure virtual

void clan::FrameBuffer::detach_depth_stencil | ( |  | ) |

virtual void clan::FrameBufferProvider::detach_stencil | ( |  | ) |
| pure virtual

void clan::FrameBuffer::detach_stencil | ( |  | ) |

void clan::ShaderEffect::dispatch | ( | GraphicContext & | gc,
|  | int | x,
|  | int | y = `1`,
|  | int | z = `1`
| ) |  |

virtual void clan::GraphicContextProvider::dispatch | ( | int | x,
|  | int | y,
|  | int | z
| ) |  |
| pure virtual

Execute a compute shader.

void clan::GraphicContext::dispatch | ( | int | x = `1`,
|  | int | y = `1`,
|  | int | z = `1`
| ) |  |

Execute a compute shader.

void clan::ShaderEffect::draw | ( | GraphicContext & | gc | ) |

void clan::Canvas::draw_box | ( | float | x1,
|  | float | y1,
|  | float | x2,
|  | float | y2,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw a box / rectangle.

void clan::Canvas::draw_box | ( | const Pointf & | start,
|  | const Pointf & | end,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Box.

Parameters

  gc | = Graphic Context
  start | = Pointf
  end | = Pointf
  color | = Colorf

void clan::Canvas::draw_box | ( | const Rectf & | rect,
|  | const Colorf & | color
| ) |  |

Box.

Parameters

  gc | = Graphic Context
  rect | = Rectf
  color | = Colorf

void clan::Canvas::draw_line | ( | float | x1,
|  | float | y1,
|  | float | x2,
|  | float | y2,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw a line.

void clan::Canvas::draw_line | ( | const Pointf & | start,
|  | const Pointf & | end,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Line.

Parameters

  gc | = Graphic Context
  start | = Pointf
  end | = Pointf
  color | = Colorf

void clan::Canvas::draw_line | ( | const LineSegment2f & | line_segment,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Line.

Parameters

  gc | = Graphic Context
  line_segment | = The line
  color | = Colorf

void clan::Canvas::draw_line_strip | ( | const Vec2f * | positions,
|  | int | num_vertices,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Line Strip.

void clan::Canvas::draw_lines | ( | const Vec2f * | positions,
|  | int | num_vertices,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Lines.

void clan::Canvas::draw_lines | ( | const Vec2f * | line_positions,
|  | const Vec2f * | texture_positions,
|  | int | num_vertices,
|  | const Texture2D & | texture,
|  | const Colorf & | line_color = `Colorf::white`
| ) |  |

Lines.

void clan::Canvas::draw_point | ( | float | x1,
|  | float | y1,
|  | const Colorf & | color
| ) |  |

Draw a point.

void clan::Canvas::draw_point | ( | const Pointf & | point,
|  | const Colorf & | color
| ) |  |

Point.

Parameters

  gc | = Graphic Context
  point | = Pointf
  color | = Colorf

virtual void clan::GraphicContextProvider::draw_primitives | ( | PrimitivesType | type,
|  | int | num_vertices,
|  | const PrimitivesArray & | primitives_array
| ) |  |
| pure virtual

Draw primitives on gc.

void clan::GraphicContext::draw_primitives | ( | PrimitivesType | type,
|  | int | num_vertices,
|  | const PrimitivesArray & | array
| ) |  |

Draw primitives on gc.

virtual void clan::GraphicContextProvider::draw_primitives_array | ( | PrimitivesType | type,
|  | int | offset,
|  | int | num_vertices
| ) |  |
| pure virtual

Draws primitives from the current assigned primitives array.

void clan::GraphicContext::draw_primitives_array | ( | PrimitivesType | type,
|  | int | num_vertices
| ) |  |

Draws primitives from the current assigned primitives array.

void clan::GraphicContext::draw_primitives_array | ( | PrimitivesType | type,
|  | int | offset,
|  | int | num_vertices
| ) |  |

Draw primitives array

Parameters

  type | = Primitives Type
  offset | = value
  num_vertices | = value

virtual void clan::GraphicContextProvider::draw_primitives_array_instanced | ( | PrimitivesType | type,
|  | int | offset,
|  | int | num_vertices,
|  | int | instance_count
| ) |  |
| pure virtual

Draws instanced primitives from the current assigned primitives array.

void clan::GraphicContext::draw_primitives_array_instanced | ( | PrimitivesType | type,
|  | int | offset,
|  | int | num_vertices,
|  | int | instance_count
| ) |  |

Draw primitives array instanced

Parameters

  type | = Primitives Type
  offset | = value
  num_vertices | = value
  instance_count | = number of instances drawn

virtual void clan::GraphicContextProvider::draw_primitives_elements | ( | PrimitivesType | type,
|  | int | count,
|  | VertexAttributeDataType | indices_type,
|  | size_t | offset = `0`
| ) |  |
| pure virtual

Draw primitives elements.

Parameters

  type | = Primitives Type
  count | = value
  indices_type | = Vertex Attribute Data Type
  offset | = void

virtual void clan::GraphicContextProvider::draw_primitives_elements | ( | PrimitivesType | type,
|  | int | count,
|  | ElementArrayBufferProvider * | array_provider,
|  | VertexAttributeDataType | indices_type,
|  | void * | offset
| ) |  |
| pure virtual

Draw primitives elements.

Parameters

  type | = Primitives Type
  count | = value
  array_provider | = Element Array Buffer Provider
  indices_type | = Vertex Attribute Data Type
  offset | = void

void clan::GraphicContext::draw_primitives_elements | ( | PrimitivesType | type,
|  | int | count,
|  | VertexAttributeDataType | indices_type,
|  | size_t | offset = `0`
| ) |  |

Draw primitives elements

Parameters

  type | = Primitives Type
  count | = value
  indices_type | = Vertex Attribute Data Type
  offset | = void

Referenced by clan::GraphicContext::draw_primitives_elements().

void clan::GraphicContext::draw_primitives_elements | ( | PrimitivesType | type,
|  | int | count,
|  | ElementArrayBuffer & | element_array,
|  | VertexAttributeDataType | indices_type,
|  | size_t | offset = `0`
| ) |  |

Draw primitives elements

Parameters

  type | = Primitives Type
  count | = value
  element_array | = Element Array Buffer
  indices_type | = Vertex Attribute Data Type
  offset | = void

void clan::GraphicContext::draw_primitives_elements | ( | PrimitivesType | type,
|  | int | count,
|  | ElementArrayVector< unsigned int > & | element_array,
|  | size_t | offset = `0`
| ) |  |
| inline

Draw primitives elements

Parameters

  type | = Primitives Type
  count | = value
  element_array | = Element Array Buffer
  indices_type | = Vertex Attribute Data Type
  offset | = void

References clan::GraphicContext::draw_primitives_elements(), and clan::type_unsigned_int.

void clan::GraphicContext::draw_primitives_elements | ( | PrimitivesType | type,
|  | int | count,
|  | ElementArrayVector< unsigned short > & | element_array,
|  | size_t | offset = `0`
| ) |  |
| inline

Draw primitives elements

Parameters

  type | = Primitives Type
  count | = value
  element_array | = Element Array Buffer
  indices_type | = Vertex Attribute Data Type
  offset | = void

References clan::GraphicContext::draw_primitives_elements(), and clan::type_unsigned_short.

void clan::GraphicContext::draw_primitives_elements | ( | PrimitivesType | type,
|  | int | count,
|  | ElementArrayVector< unsigned char > & | element_array,
|  | size_t | offset = `0`
| ) |  |
| inline

Draw primitives elements

Parameters

  type | = Primitives Type
  count | = value
  element_array | = Element Array Buffer
  indices_type | = Vertex Attribute Data Type
  offset | = void

References clan::GraphicContext::draw_primitives_elements(), and clan::type_unsigned_byte.

virtual void clan::GraphicContextProvider::draw_primitives_elements_instanced | ( | PrimitivesType | type,
|  | int | count,
|  | VertexAttributeDataType | indices_type,
|  | size_t | offset,
|  | int | instance_count
| ) |  |
| pure virtual

Draw primitives elements instanced.

Parameters

  type | = Primitives Type
  count | = value
  indices_type | = Vertex Attribute Data Type
  offset | = void
  instance_count | = number of instances drawn

virtual void clan::GraphicContextProvider::draw_primitives_elements_instanced | ( | PrimitivesType | type,
|  | int | count,
|  | ElementArrayBufferProvider * | array_provider,
|  | VertexAttributeDataType | indices_type,
|  | void * | offset,
|  | int | instance_count
| ) |  |
| pure virtual

Draw primitives elements instanced.

Parameters

  type | = Primitives Type
  count | = value
  array_provider | = Element Array Buffer Provider
  indices_type | = Vertex Attribute Data Type
  offset | = void

void clan::GraphicContext::draw_primitives_elements_instanced | ( | PrimitivesType | type,
|  | int | count,
|  | VertexAttributeDataType | indices_type,
|  | size_t | offset,
|  | int | instance_count
| ) |  |

Draw primitives elements instanced

Parameters

  type | = Primitives Type
  count | = value
  indices_type | = Vertex Attribute Data Type
  offset | = void
  instance_count | = number of instances drawn

Referenced by clan::GraphicContext::draw_primitives_elements_instanced().

void clan::GraphicContext::draw_primitives_elements_instanced | ( | PrimitivesType | type,
|  | int | count,
|  | ElementArrayBuffer & | element_array,
|  | VertexAttributeDataType | indices_type,
|  | size_t | offset,
|  | int | instance_count
| ) |  |

Draw primitives elements instanced

Parameters

  type | = Primitives Type
  count | = value
  element_array | = Element Array Buffer
  indices_type | = Vertex Attribute Data Type
  offset | = void
  instance_count | = number of instances drawn

void clan::GraphicContext::draw_primitives_elements_instanced | ( | PrimitivesType | type,
|  | int | count,
|  | ElementArrayVector< unsigned int > & | element_array,
|  | size_t | offset,
|  | int | instance_count
| ) |  |
| inline

Draw primitives elements instanced

Parameters

  type | = Primitives Type
  count | = value
  element_array | = Element Array Buffer
  indices_type | = Vertex Attribute Data Type
  offset | = void
  instance_count | = number of instances drawn

References clan::GraphicContext::draw_primitives_elements_instanced(), and clan::type_unsigned_int.

void clan::GraphicContext::draw_primitives_elements_instanced | ( | PrimitivesType | type,
|  | int | count,
|  | ElementArrayVector< unsigned short > & | element_array,
|  | size_t | offset,
|  | int | instance_count
| ) |  |
| inline

Draw primitives elements instanced

Parameters

  type | = Primitives Type
  count | = value
  element_array | = Element Array Buffer
  indices_type | = Vertex Attribute Data Type
  offset | = void
  instance_count | = number of instances drawn

References clan::GraphicContext::draw_primitives_elements_instanced(), and clan::type_unsigned_short.

void clan::GraphicContext::draw_primitives_elements_instanced | ( | PrimitivesType | type,
|  | int | count,
|  | ElementArrayVector< unsigned char > & | element_array,
|  | size_t | offset,
|  | int | instance_count
| ) |  |
| inline

Draw primitives elements instanced

Parameters

  type | = Primitives Type
  count | = value
  element_array | = Element Array Buffer
  indices_type | = Vertex Attribute Data Type
  offset | = void
  instance_count | = number of instances drawn

References clan::GraphicContext::draw_primitives_elements_instanced(), and clan::type_unsigned_byte.

virtual void clan::DisplayWindowProvider::enable_alpha_channel | ( | const Rect & | blur_rect | ) |
| pure virtual

Enable alpha channel blending for this window.

Note
  This is only supported on Windows Vista and above. You can use layered windows to achieve the same effect on systems that do not support this.

Parameters

  blur_rect | Window blur area. If its size is `0`, the area of the entire window will be used.

void clan::RasterizerStateDescription::enable_antialiased | ( | bool | value | ) |

Enables/disables anti-aliasing. (clanGL only)

void clan::BlendStateDescription::enable_blending | ( | bool | value | ) |

Enable/Disable blending.

void clan::BlendStateDescription::enable_color_write | ( | bool | red,
|  | bool | green,
|  | bool | blue,
|  | bool | alpha
| ) |  |

Enable/disable writing to the color buffer.

void clan::DepthStencilStateDescription::enable_depth_test | ( | bool | enabled | ) |

Enables/disables depth testing.

void clan::DepthStencilStateDescription::enable_depth_write | ( | bool | enabled | ) |

Enables/disables depth writing.

void clan::RasterizerStateDescription::enable_line_antialiasing | ( | bool | enabled | ) |

Setting to true enables line antialiasing.

Initially antialiasing of lines is disabled.

void clan::BlendStateDescription::enable_logic_op | ( | bool | enabled | ) |

Enable/disable logic op. (clanGL only)

void clan::RasterizerStateDescription::enable_offset_fill | ( | bool | value | ) |

Enables/disables polygon offsetting.

void clan::RasterizerStateDescription::enable_offset_line | ( | bool | value | ) |

Enables/disables line offsetting.

void clan::RasterizerStateDescription::enable_offset_point | ( | bool | value | ) |

Enables/disables point offsetting.

void clan::RasterizerStateDescription::enable_point_size | ( | bool | enable | ) |

Enables if points sizes is set by the vertex shader. (clanGL only)

void clan::RasterizerStateDescription::enable_scissor | ( | bool | enabled | ) |

Enables/disables if clipping rects are used.

void clan::DepthStencilStateDescription::enable_stencil_test | ( | bool | enabled | ) |

Enables/disables stencil testing.

void clan::OcclusionQuery::end | ( |  | ) |

Finish occlusion query.

virtual void clan::DisplayWindowProvider::extend_frame_into_client_area | ( | int | left,
|  | int | top,
|  | int | right,
|  | int | bottom
| ) |  |
| pure virtual

Extend the window frame into the client area.

Note
  This is only applicable in Windows.

void clan::Canvas::fill_circle | ( | float | center_x,
|  | float | center_y,
|  | float | radius,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw a circle.

void clan::Canvas::fill_circle | ( | const Pointf & | center,
|  | float | radius,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Circle.

Parameters

  gc | = Graphic Context
  center | = Pointf
  radius | = value
  color | = Colorf

void clan::Canvas::fill_circle | ( | const Pointf & | center,
|  | float | radius,
|  | const Gradient & | gradient
| ) |  |

Gradient circle.

Parameters

  gc | = Graphic Context
  center | = Pointf
  radius | = value
  gradient | = Gradient

void clan::Canvas::fill_circle | ( | const Pointf & | center,
|  | const Pointf & | centergradient,
|  | float | radius,
|  | const Gradient & | gradient
| ) |  |

Gradient circle.

Parameters

  gc | = Graphic Context
  center | = Pointf
  centergradient | = Pointf
  radius | = value
  gradient | = Gradient

void clan::Canvas::fill_ellipse | ( | const Pointf & | center,
|  | float | radius_x,
|  | float | radius_y,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw a filled ellipse.

void clan::Canvas::fill_ellipse | ( | const Pointf & | center,
|  | float | radius_x,
|  | float | radius_y,
|  | const Gradient & | gradient
| ) |  |

Draw a gradient filled ellipse.

void clan::Canvas::fill_rect | ( | float | x1,
|  | float | y1,
|  | float | x2,
|  | float | y2,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw a filled box / rectangle.

void clan::Canvas::fill_rect | ( | const Pointf & | start,
|  | const Pointf & | end,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Fill.

Parameters

  gc | = Graphic Context
  start | = Pointf
  end | = Pointf
  color | = Colorf

void clan::Canvas::fill_rect | ( | const Rectf & | rect,
|  | const Colorf & | color
| ) |  |

Fill.

Parameters

  gc | = Graphic Context
  rect | = Rectf
  color | = Colorf

void clan::Canvas::fill_rect | ( | float | x1,
|  | float | y1,
|  | float | x2,
|  | float | y2,
|  | const Gradient & | color
| ) |  |

Gradient fill.

Parameters

  gc | = Graphic Context
  x1 | = value
  y1 | = value
  x2 | = value
  y2 | = value
  color | = Gradient

void clan::Canvas::fill_rect | ( | const Pointf & | start,
|  | const Pointf & | end,
|  | const Gradient & | gradient
| ) |  |

Gradient fill.

Parameters

  gc | = Graphic Context
  start | = Pointf
  end | = Pointf
  gradient | = Gradient

void clan::Canvas::fill_rect | ( | const Rectf & | rect,
|  | const Gradient & | gradient
| ) |  |

Gradient fill.

Parameters

  gc | = Graphic Context
  rect | = Rectf
  gradient | = Gradient

void clan::Canvas::fill_triangle | ( | const Pointf & | a,
|  | const Pointf & | b,
|  | const Pointf & | c,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw a triangle.

void clan::Canvas::fill_triangle | ( | const Trianglef & | dest_triangle,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw a triangle.

void clan::Canvas::fill_triangles | ( | const Vec2f * | triangle_positions,
|  | int | num_vertices,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const Vec2f * | triangle_positions,
|  | int | num_vertices,
|  | const Gradient & | gradient
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const Vec2f * | triangle_positions,
|  | const Colorf * | colors,
|  | int | num_vertices
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const std::vector< Vec2f > & | triangles,
|  | const Colorf * | colors
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const std::vector< Vec2f > & | triangles,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const std::vector< Vec2f > & | triangles,
|  | const Gradient & | gradient
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const Vec2f * | positions,
|  | const Vec2f * | texture_positions,
|  | int | num_vertices,
|  | const Texture2D & | texture,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const Vec2f * | positions,
|  | const Vec2f * | texture_positions,
|  | int | num_vertices,
|  | const Texture2D & | texture,
|  | const Colorf * | colors
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const std::vector< Vec2f > & | positions,
|  | const std::vector< Vec2f > & | texture_positions,
|  | const Texture2D & | texture,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const std::vector< Vec2f > & | positions,
|  | const std::vector< Vec2f > & | texture_positions,
|  | const Texture2D & | texture,
|  | const std::vector< Colorf > & | colors
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const std::vector< Vec2f > & | positions,
|  | const Texture2D & | texture,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const std::vector< Vec2f > & | positions,
|  | const Texture2D & | texture,
|  | const Rect & | texture_rect,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const Vec2f * | triangle_positions,
|  | int | num_vertices,
|  | const Texture2D & | texture,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const Vec2f * | triangle_positions,
|  | int | num_vertices,
|  | const Texture2D & | texture,
|  | const Rect & | texture_rect,
|  | const Colorf & | color = `Colorf::white`
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const std::vector< Vec2f > & | positions,
|  | const Texture2D & | texture,
|  | const Gradient & | gradient
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const std::vector< Vec2f > & | positions,
|  | const Texture2D & | texture,
|  | const Rect & | texture_rect,
|  | const Gradient & | gradient
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const Vec2f * | triangle_positions,
|  | int | num_vertices,
|  | const Texture2D & | texture,
|  | const Gradient & | gradient
| ) |  |

Draw triangles.

void clan::Canvas::fill_triangles | ( | const Vec2f * | triangle_positions,
|  | int | num_vertices,
|  | const Texture2D & | texture,
|  | const Rect & | texture_rect,
|  | const Gradient & | gradient
| ) |  |

Draw triangles.

virtual void clan::DisplayWindowProvider::flip | ( | int | interval | ) |
| pure virtual

Flip the window display buffers.

bool clan::PixelConverter::flip_vertical | ( |  | ) | const

Returns the flip vertical setting.

bool clan::ImageImportDescription::flip_vertical | ( |  | ) | const

Returns the flip vertical setting.

void clan::PixelBuffer::flip_vertical | ( |  | ) |

Flip the entire image vertically (turn it upside down)

virtual void clan::RenderBatcher::flush | ( | GraphicContext & | gc | ) |
| pure virtual

Flush render batcher contents.

Parameters

  gc | Graphic context to flush contents to.

void clan::Canvas::flush | ( |  | ) |

Flushes the render batcher currently active.

virtual void clan::GraphicContextProvider::flush | ( |  | ) |
| pure virtual

void clan::GraphicContext::flush | ( |  | ) |

Flush the command buffer.

std::function<PixelBuffer(PixelBuffer &)>& clan::ImageImportDescription::func_process | ( |  | ) |

User defined fine control of the pixel buffer.

Note, the output maybe different to the input, if desired
PixelBuffer func_process(PixelBuffer &input)

virtual void clan::TextureProvider::generate_mipmap | ( |  | ) |
| pure virtual

Generate the mipmap.

void clan::Texture::generate_mipmap | ( |  | ) |

Generate the mipmap.

float clan::PerlinNoise::get_amplitude | ( |  | ) | const

Get the amplitude of the perlin noise.

bool clan::RasterizerStateDescription::get_antialiased | ( |  | ) | const

int clan::Texture1DArray::get_array_size | ( |  | ) | const

Get the texture array size.

int clan::TextureCubeArray::get_array_size | ( |  | ) | const

Get the texture array size.

int clan::Texture2DArray::get_array_size | ( |  | ) | const

Returns the number of textures in the array.

virtual int clan::ProgramObjectProvider::get_attribute_location | ( | const std::string & | name | ) | const
| pure virtual

Returns the location of a named active attribute.

int clan::ProgramObject::get_attribute_location | ( | const std::string & | name | ) | const

Returns the location of a named active attribute.

Returns -1 when unknown

int clan::PixelBufferSet::get_base_level | ( |  | ) | const

Returns the lowest mip level specified in the set.

int clan::Texture::get_base_level | ( |  | ) | const

Get the texture base level.

virtual FrameBufferBindTarget clan::FrameBufferProvider::get_bind_target | ( |  | ) | const
| pure virtual

FrameBufferBindTarget clan::FrameBuffer::get_bind_target | ( |  | ) | const

Get the bind target of the framebuffer.

Returns
  The bind target

void clan::BlendStateDescription::get_blend_equation | ( | BlendEquation & | out_color,
|  | BlendEquation & | out_alpha
| ) |  | const

void clan::BlendStateDescription::get_blend_function | ( | BlendFunc & | out_src,
|  | BlendFunc & | out_dest,
|  | BlendFunc & | out_src_alpha,
|  | BlendFunc & | out_dest_alpha
| ) |  | const

unsigned int clan::PixelBuffer::get_bytes_per_block | ( |  | ) | const

Returns the number of bytes per compression block.

Returns
  Bytes per block. Exception thrown if not available (hint, use is_compressed() )

static unsigned int clan::PixelBuffer::get_bytes_per_block | ( | TextureFormat | texture_format | ) |
| static

Returns the number of bytes per compression block.

Returns
  Bytes per block. Exception thrown if not available (hint, use is_compressed() )

unsigned int clan::PixelBuffer::get_bytes_per_pixel | ( |  | ) | const

Returns the number of bytes per pixel.

Returns
  Bytes per pixel. Exception thrown if not available (hint, use is_compressed() )

static unsigned int clan::PixelBuffer::get_bytes_per_pixel | ( | TextureFormat | texture_format | ) |
| static

Returns the number of bytes per pixel.

Returns
  Bytes per pixel. Exception thrown if not available (hint, use is_compressed() )

virtual ClipZRange clan::GraphicContextProvider::get_clip_z_range | ( |  | ) | const
| pure virtual

Returns in what range clip space z values are clipped.

ClipZRange clan::GraphicContext::get_clip_z_range | ( |  | ) | const

Returns in what range clip space z values are clipped.

virtual PixelBuffer clan::DisplayWindowProvider::get_clipboard_image | ( |  | ) | const
| pure virtual

Returns the image stored in the clipboard.

virtual std::string clan::DisplayWindowProvider::get_clipboard_text | ( |  | ) | const
| pure virtual

Returns the text stored in the clipboard.

Rectf clan::Canvas::get_cliprect | ( |  | ) | const

Returns the current clipping rectangle.

void clan::BlendStateDescription::get_color_write | ( | bool & | out_red,
|  | bool & | out_green,
|  | bool & | out_blue,
|  | bool & | out_alpha
| ) |  | const

CompareFunction clan::Texture::get_compare_function | ( |  | ) | const

Get the texture compare function.

TextureCompareMode clan::Texture::get_compare_mode | ( |  | ) | const

Get the texture compare mode.

virtual bool clan::ShaderObjectProvider::get_compile_status | ( |  | ) | const
| pure virtual

Returns true if compile succeeded.

bool clan::RasterizerStateDescription::get_culled | ( |  | ) | const

static DisplayTarget clan::Display::get_current_target | ( |  | ) |
| static

Returns the currently selected display target.

virtual void* clan::TransferBufferProvider::get_data | ( |  | ) |
| pure virtual

Retrieves a pointer to the mapped buffer.

virtual void* clan::PixelBufferProvider::get_data | ( |  | ) |
| pure virtual

Retrieves a pointer to the mapped buffer.

void* clan::TransferBuffer::get_data | ( |  | ) |

Retrieves a pointer to the mapped buffer.

Referenced by clan::TransferVector< Type >::get_data().

template<typename Type >

Type* clan::PixelBufferLock< Type >::get_data | ( |  | ) |
| inline

template<typename Type>

Type* clan::TransferVector< Type >::get_data | ( |  | ) |
| inline

Retrieves a pointer to the mapped buffer.

References clan::TransferBuffer::get_data().

Referenced by clan::TransferVector< Type >::operator[]().

void* clan::PixelBuffer::get_data | ( |  | ) |

Returns a pointer to the beginning of the pixel buffer.

Referenced by clan::PixelBuffer::get_data_uint16(), clan::PixelBuffer::get_data_uint32(), clan::PixelBuffer::get_data_uint8(), and clan::PixelBufferLock< Type >::lock().

const void* clan::PixelBuffer::get_data | ( |  | ) | const

template<typename Type >

Type* clan::PixelBuffer::get_data | ( |  | ) |
| inline

References clan::PixelBuffer::get_data().

Referenced by clan::PixelBuffer::get_data().

template<typename Type >

const Type* clan::PixelBuffer::get_data | ( |  | ) | const
| inline

References clan::PixelBuffer::get_data().

Referenced by clan::PixelBuffer::get_data().

unsigned int clan::PixelBuffer::get_data_size | ( |  | ) | const

Returns the size in bytes of the image data.

Returns
  The data size

static unsigned int clan::PixelBuffer::get_data_size | ( | const Size & | size,
|  | TextureFormat | texture_format
| ) |  |
| static

Returns the size in bytes of the image data.

Returns
  The data size

unsigned short* clan::PixelBuffer::get_data_uint16 | ( |  | ) |
| inline

Returns a pointer to the beginning of the pixel buffer as 16 bit data.

References clan::PixelBuffer::get_data().

const unsigned short* clan::PixelBuffer::get_data_uint16 | ( |  | ) | const
| inline

References clan::PixelBuffer::get_data().

unsigned int* clan::PixelBuffer::get_data_uint32 | ( |  | ) |
| inline

Returns a pointer to the beginning of the pixel buffer as 32 bit data.

References clan::PixelBuffer::get_data().

const unsigned int* clan::PixelBuffer::get_data_uint32 | ( |  | ) | const
| inline

References clan::PixelBuffer::get_data().

unsigned char* clan::PixelBuffer::get_data_uint8 | ( |  | ) |
| inline

Returns a pointer to the beginning of the pixel buffer as 8 bit data.

References clan::PixelBuffer::get_data().

Referenced by clan::PixelBuffer::get_line().

const unsigned char* clan::PixelBuffer::get_data_uint8 | ( |  | ) | const
| inline

References clan::PixelBuffer::get_data().

int clan::Texture3D::get_depth | ( |  | ) | const

Get the texture depth.

CompareFunction clan::DepthStencilStateDescription::get_depth_compare_function | ( |  | ) | const

TextureDimensions clan::PixelBufferSet::get_dimensions | ( |  | ) | const

Returns the texture dimensions used by the image set.

float clan::Texture2DArray::get_dip_height | ( |  | ) | const
| inline

Returns the device independent height of this texture.

References clan::Texture2DArray::get_height(), and clan::Texture2DArray::get_pixel_ratio().

Referenced by clan::Texture2DArray::get_dip_size().

float clan::Texture2D::get_dip_height | ( |  | ) | const
| inline

Returns the device independent height of this texture.

References clan::Texture2D::get_height(), and clan::Texture2D::get_pixel_ratio().

Referenced by clan::Texture2D::get_dip_size().

float clan::PixelBuffer::get_dip_height | ( |  | ) | const
| inline

Returns the device independent height of this texture.

References clan::PixelBuffer::get_height(), and clan::PixelBuffer::get_pixel_ratio().

Referenced by clan::PixelBuffer::get_dip_size().

float clan::GraphicContext::get_dip_height | ( |  | ) | const
| inline

Calculates the device independent height of the context. Resolution Independence

References clan::GraphicContext::get_height(), and clan::GraphicContext::get_pixel_ratio().

Referenced by clan::GraphicContext::get_dip_size(), and clan::Canvas::get_height().

Sizef clan::Texture2DArray::get_dip_size | ( |  | ) | const
| inline

Returns the device independent size of this texture.

References clan::Texture2DArray::get_dip_height(), and clan::Texture2DArray::get_dip_width().

Sizef clan::Texture2D::get_dip_size | ( |  | ) | const
| inline

Returns the device independent size of this texture.

References clan::Texture2D::get_dip_height(), and clan::Texture2D::get_dip_width().

Sizef clan::PixelBuffer::get_dip_size | ( |  | ) | const
| inline

Returns the device independent size of this texture.

References clan::PixelBuffer::get_dip_height(), and clan::PixelBuffer::get_dip_width().

Sizef clan::GraphicContext::get_dip_size | ( |  | ) | const
| inline

Calculates the device independent dimensions of the context. Resolution Independence

References clan::GraphicContext::get_dip_height(), and clan::GraphicContext::get_dip_width().

Referenced by clan::Canvas::get_size().

float clan::Texture2DArray::get_dip_width | ( |  | ) | const
| inline

Returns the device independent width of this texture.

References clan::Texture2DArray::get_pixel_ratio(), and clan::Texture2DArray::get_width().

Referenced by clan::Texture2DArray::get_dip_size().

float clan::Texture2D::get_dip_width | ( |  | ) | const
| inline

Returns the device independent width of this texture.

References clan::Texture2D::get_pixel_ratio(), and clan::Texture2D::get_width().

Referenced by clan::Texture2D::get_dip_size().

float clan::PixelBuffer::get_dip_width | ( |  | ) | const
| inline

Returns the device independent width of this texture.

References clan::PixelBuffer::get_pixel_ratio(), and clan::PixelBuffer::get_width().

Referenced by clan::PixelBuffer::get_dip_size().

float clan::GraphicContext::get_dip_width | ( |  | ) | const
| inline

Calculates the device independent width of the context. Resolution Independence

References clan::GraphicContext::get_pixel_ratio(), and clan::GraphicContext::get_width().

Referenced by clan::GraphicContext::get_dip_size(), and clan::Canvas::get_width().

virtual Size clan::GraphicContextProvider::get_display_window_size | ( |  | ) | const
| pure virtual

Returns the current size of the display window.

bool clan::RasterizerStateDescription::get_enable_line_antialiasing | ( |  | ) | const

bool clan::RasterizerStateDescription::get_enable_scissor | ( |  | ) | const

CullMode clan::RasterizerStateDescription::get_face_cull_mode | ( |  | ) | const

FillMode clan::RasterizerStateDescription::get_face_fill_mode | ( |  | ) | const

TextureFormat clan::PixelBufferSet::get_format | ( |  | ) | const

Returns the internal texture format used by the image.

virtual TextureFormat clan::PixelBufferProvider::get_format | ( |  | ) | const
| pure virtual

Returns the pixel format.

TextureFormat clan::PerlinNoise::get_format | ( |  | ) | const

Get the format of the output pixelbuffer.

TextureFormat clan::PixelBuffer::get_format | ( |  | ) | const

Returns the pixel format.

FaceSide clan::RasterizerStateDescription::get_front_face | ( |  | ) | const

float clan::PixelConverter::get_gamma | ( |  | ) | const

Returns the gamma setting.

GraphicContext& clan::Canvas::get_gc | ( |  | ) | const

Get gc.

Returns
  Graphic Context

Referenced by clan::Canvas::get_height(), clan::Canvas::get_pixel_ratio(), clan::Canvas::get_size(), clan::Canvas::get_width(), and clan::Canvas::operator GraphicContext &().

virtual GraphicContext& clan::DisplayWindowProvider::get_gc | ( |  | ) |
| pure virtual

Returns the graphic context for the window.

static std::vector<GraphicContextProvider*>& clan::SharedGCData::get_gc_providers | ( | std::unique_ptr< std::unique_lock< std::recursive_mutex >> & | mutex_section | ) |
| static

Get the providers.

Parameters

  mutex_section | : Returns the mutex section for the provider lock

Returns
  NULL = None available

virtual Rect clan::DisplayWindowProvider::get_geometry | ( |  | ) | const
| pure virtual

Returns the position and size of the window frame.

virtual unsigned int clan::ProgramObjectProvider::get_handle | ( |  | ) | const
| pure virtual

Returns the OpenGL program object handle.

virtual unsigned int clan::ShaderObjectProvider::get_handle | ( |  | ) | const
| pure virtual

Returns the OpenGL shader handle.

virtual DisplayWindowHandle clan::DisplayWindowProvider::get_handle | ( |  | ) | const
| pure virtual

Returns an platform-specific internal display window handle object.

unsigned int clan::ShaderObject::get_handle | ( |  | ) | const

Returns the OpenGL shader handle.

unsigned int clan::ProgramObject::get_handle | ( |  | ) | const

Returns the OpenGL program object handle.

int clan::TextureCubeArray::get_height | ( |  | ) | const

Get the texture height.

int clan::Texture3D::get_height | ( |  | ) | const

Get the texture height.

int clan::PixelBufferSet::get_height | ( |  | ) | const

Returns the height of the image.

int clan::Texture2DArray::get_height | ( |  | ) | const

Retrieves the actual height of the texture in the display.

Referenced by clan::Texture2DArray::get_dip_height(), and clan::Texture2DArray::get_size().

int clan::Texture2D::get_height | ( |  | ) | const

Retrieves the actual height of the texture in the display.

Referenced by clan::Texture2D::get_dip_height(), and clan::Texture2D::get_size().

int clan::TextureCube::get_height | ( |  | ) | const

Get the texture height.

template<typename Type >

int clan::PixelBufferLock< Type >::get_height | ( |  | ) | const
| inline

float clan::Canvas::get_height | ( |  | ) | const
| inline

Returns the current height of the context.

References clan::GraphicContext::get_dip_height(), and clan::Canvas::get_gc().

int clan::PixelBuffer::get_height | ( |  | ) | const

Retrieves the actual height of the buffer.

Referenced by clan::PixelBuffer::get_dip_height(), clan::PixelBuffer::get_size(), and clan::PixelBufferLock< Type >::PixelBufferLock().

int clan::GraphicContext::get_height | ( |  | ) | const

Returns the current actual height of the context.

Referenced by clan::GraphicContext::get_dip_height().

virtual InputContext clan::DisplayWindowProvider::get_ic | ( |  | ) |
| pure virtual

Returns the input context for the window.

PixelBuffer clan::PixelBufferSet::get_image | ( | int | slice,
|  | int | level
| ) |  |

Returns the pixel buffer for a specific slice and level.

std::vector<PixelBuffer> clan::IconSet::get_images | ( |  | ) | const

Returns all the images in the icon set.

std::weak_ptr<Texture_Impl> clan::Texture::get_impl | ( |  | ) | const

Get the implementation weakptr.

This is used to assist is creating Texture caches internally within clanlib

virtual std::string clan::ProgramObjectProvider::get_info_log | ( |  | ) | const
| pure virtual

Returns the current info log for the program object.

virtual std::string clan::ShaderObjectProvider::get_info_log | ( |  | ) | const
| pure virtual

Get shader object's info log.

std::string clan::ShaderObject::get_info_log | ( |  | ) | const

Get shader object's info log.

std::string clan::ProgramObject::get_info_log | ( |  | ) | const

Returns the current info log for the program object.

bool clan::PixelConverter::get_input_is_ycrcb | ( |  | ) | const

Returns the JPEG JFIF YCrCb input setting.

Mat4f& clan::Canvas::get_inverse_transform | ( |  | ) |

Returns the inverse of the current effective transform matrix.

This is cached

void* clan::PixelBuffer::get_line | ( | int | line | ) |
| inline

Returns a pointer to the beginning of a specific line.

References clan::d, clan::PixelBuffer::get_data_uint8(), and clan::PixelBuffer::get_pitch().

Referenced by clan::PixelBuffer::get_line_uint16(), clan::PixelBuffer::get_line_uint32(), and clan::PixelBuffer::get_line_uint8().

const void* clan::PixelBuffer::get_line | ( | int | line | ) | const
| inline

References clan::d, clan::PixelBuffer::get_data_uint8(), and clan::PixelBuffer::get_pitch().

unsigned short* clan::PixelBuffer::get_line_uint16 | ( | int | line | ) |
| inline

Returns a pointer to the beginning of a specific line as 16 bit data.

References clan::PixelBuffer::get_line().

const unsigned short* clan::PixelBuffer::get_line_uint16 | ( | int | line | ) | const
| inline

References clan::PixelBuffer::get_line().

unsigned int* clan::PixelBuffer::get_line_uint32 | ( | int | line | ) |
| inline

Returns a pointer to the beginning of a specific line as 32 bit data.

References clan::PixelBuffer::get_line().

const unsigned int* clan::PixelBuffer::get_line_uint32 | ( | int | line | ) | const
| inline

References clan::PixelBuffer::get_line().

unsigned char* clan::PixelBuffer::get_line_uint8 | ( | int | line | ) |
| inline

Returns a pointer to the beginning of a specific line as 8 bit data.

References clan::PixelBuffer::get_line().

const unsigned char* clan::PixelBuffer::get_line_uint8 | ( | int | line | ) | const
| inline

References clan::PixelBuffer::get_line().

virtual bool clan::ProgramObjectProvider::get_link_status | ( |  | ) | const
| pure virtual

Returns true if the link succeeded.

template<typename Type >

int clan::PixelBufferLock< Type >::get_lock_count | ( |  | ) | const
| inline

Returns the amounts of recursive pixel_buffer locks performed by this section.

float clan::Texture::get_lod_bias | ( |  | ) | const

Get the level of detail bias constant.

LogicOp clan::BlendStateDescription::get_logic_op | ( |  | ) | const

TextureFilter clan::Texture::get_mag_filter | ( |  | ) | const

Get the texture magnification filter.

virtual int clan::GraphicContextProvider::get_major_version | ( |  | ) | const
| pure virtual

Returns the major version / feature level supported by the hardware.

For the OpenGL target, this returns the major OpenGL version the driver supports. For the Direct3D target, this returns the major feature level.

int clan::GraphicContext::get_major_version | ( |  | ) | const

Returns the major version / feature level supported by the hardware. For an OpenGL target, this returns the major OpenGL version the driver supports. For a Direct3D target, this returns the major feature level.

virtual int clan::GraphicContextProvider::get_max_attributes | ( |  | ) |
| pure virtual

Returns the maximum amount of attributes available.

int clan::PixelBufferSet::get_max_level | ( |  | ) | const

Returns the highest mip level specified in the set.

int clan::Texture::get_max_level | ( |  | ) | const

Get the texture max level.

float clan::Texture::get_max_lod | ( |  | ) | const

Get the maximum level of detail.

virtual Size clan::GraphicContextProvider::get_max_texture_size | ( |  | ) | const
| pure virtual

Returns the maximum size of a texture this graphic context supports.

It returns Size(0,0) if there is no known limitation to the max texture size.

Size clan::GraphicContext::get_max_texture_size | ( |  | ) | const

Retrieves the maximum size for a texture that this graphic context will allow. Size(0, 0) will be returned if there is no known limitation to the maximum texture size allowed for the context.

virtual Size clan::DisplayWindowProvider::get_maximum_size | ( | bool | client_area | ) | const
| pure virtual

Returns the maximum size of the window.

TextureFilter clan::Texture::get_min_filter | ( |  | ) | const

Get the texture minification filter.

float clan::Texture::get_min_lod | ( |  | ) | const

Get the minimum level of detail.

virtual Size clan::DisplayWindowProvider::get_minimum_size | ( | bool | client_area | ) | const
| pure virtual

Returns the minimum size of the window.

virtual int clan::GraphicContextProvider::get_minor_version | ( |  | ) | const
| pure virtual

Returns the major version / feature level supported by the hardware.

For the OpenGL target, this returns the minor OpenGL version the driver supports. For the Direct3D target, this returns the minor feature level.

int clan::GraphicContext::get_minor_version | ( |  | ) | const

Returns the minor version / feature level supported by the hardware. For an OpenGL target, this returns the minor OpenGL version the driver supports. For a Direct3D target, this returns the minor feature level.

int clan::PerlinNoise::get_octaves | ( |  | ) | const

Get the number of octaves of the perlin noise.

bool clan::RasterizerStateDescription::get_offset_fill | ( |  | ) | const

bool clan::RasterizerStateDescription::get_offset_line | ( |  | ) | const

bool clan::RasterizerStateDescription::get_offset_point | ( |  | ) | const

bool clan::PixelConverter::get_output_is_ycrcb | ( |  | ) | const

Returns the JPEG JFIF YCrCb output setting.

virtual int clan::PixelBufferProvider::get_pitch | ( |  | ) | const
| pure virtual

Retrieves the pitch of the mapped buffer. Use this after get_data()

template<typename Type >

int clan::PixelBufferLock< Type >::get_pitch | ( |  | ) | const
| inline

int clan::PixelBuffer::get_pitch | ( |  | ) | const

Returns the pitch (in bytes per scanline).

Referenced by clan::PixelBuffer::get_line(), and clan::PixelBufferLock< Type >::lock().

template<typename Type >

Type& clan::PixelBufferLock< Type >::get_pixel | ( | int | x,
|  | int | y
| ) |  |
| inline

References clan::y.

Colorf clan::PixelBuffer::get_pixel | ( | int | x,
|  | int | y
| ) |  |

Return color of pixel at the specified coordinates.

float clan::Texture2DArray::get_pixel_ratio | ( |  | ) | const

Retrieves the pixel ratio of this texture.

Returns
  The display pixel ratio set for this texture. A zero value implies that no pixel ratio has been set

Referenced by clan::Texture2DArray::get_dip_height(), and clan::Texture2DArray::get_dip_width().

float clan::Texture2D::get_pixel_ratio | ( |  | ) | const

Retrieves the pixel ratio of this texture.

Returns
  The display pixel ratio set for this texture. A zero value implies that no pixel ratio has been set

Referenced by clan::Texture2D::get_dip_height(), and clan::Texture2D::get_dip_width().

virtual float clan::GraphicContextProvider::get_pixel_ratio | ( |  | ) | const
| pure virtual

Physical pixels/dots per inch.

virtual float clan::DisplayWindowProvider::get_pixel_ratio | ( |  | ) | const
| pure virtual

Returns the display pixel ratio of the window. Resolution Independence

float clan::Canvas::get_pixel_ratio | ( |  | ) | const
| inline

Retrieves the display pixel ratio of the context. Resolution Independence

References clan::Canvas::get_gc(), and clan::GraphicContext::get_pixel_ratio().

float clan::PixelBuffer::get_pixel_ratio | ( |  | ) | const

Retrieves the pixel ratio of this texture.

Returns
  The display pixel ratio set for this texture. A zero value implies that no pixel ratio has been set

Referenced by clan::PixelBuffer::get_dip_height(), and clan::PixelBuffer::get_dip_width().

float clan::FrameBuffer::get_pixel_ratio | ( |  | ) | const

Retrieves the pixel ratio of this texture.

Returns
  The display pixel ratio set for this texture. A zero value implies that no pixel ratio has been set

float clan::GraphicContext::get_pixel_ratio | ( |  | ) | const

Retrieves the display pixel ratio of the context. Resolution Independence

Referenced by clan::GraphicContext::get_dip_height(), clan::GraphicContext::get_dip_width(), and clan::Canvas::get_pixel_ratio().

virtual PixelBuffer clan::TextureProvider::get_pixeldata | ( | GraphicContext & | gc,
|  | TextureFormat | texture_format,
|  | int | level
| ) |  | const
| pure virtual

Retrieve image data from texture.

PixelBuffer clan::Texture2D::get_pixeldata | ( | GraphicContext & | gc,
|  | int | level = `0`
| ) |  | const

Retrieve image data from texture.

PixelBuffer clan::Texture2D::get_pixeldata | ( | GraphicContext & | gc,
|  | TextureFormat | texture_format,
|  | int | level = `0`
| ) |  | const

Retrieve image data from this texture.

Parameters

  format | Output data format.
  level | Mipmap level of the texture to retrieve data from.

PixelBuffer clan::Canvas::get_pixeldata | ( | const Rect & | rect,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | bool | clamp = `true`
| ) |  |

Return the content of the read buffer into a pixel buffer.

PixelBuffer clan::Canvas::get_pixeldata | ( | TextureFormat | texture_format = `tf_rgba8`,
|  | bool | clamp = `true`
| ) |  |

Return the content of the read buffer into a pixel buffer.

virtual PixelBuffer clan::GraphicContextProvider::get_pixeldata | ( | const Rect & | rect,
|  | TextureFormat | texture_format,
|  | bool | clamp
| ) |  | const
| pure virtual

Return the content of the draw buffer into a pixel buffer.

PixelBuffer clan::GraphicContext::get_pixeldata | ( | const Rect & | rect,
|  | TextureFormat | texture_format = `tf_rgba8`,
|  | bool | clamp = `true`
| ) |  |

Return the content of the read buffer into a pixel buffer.

PixelBuffer clan::GraphicContext::get_pixeldata | ( | TextureFormat | texture_format = `tf_rgba8`,
|  | bool | clamp = `true`
| ) |  |

Return the content of the read buffer into a pixel buffer.

float clan::RasterizerStateDescription::get_point_fade_treshold_size | ( |  | ) | const

float clan::RasterizerStateDescription::get_point_size | ( |  | ) | const

PointSpriteOrigin clan::RasterizerStateDescription::get_point_sprite_origin | ( |  | ) | const

void clan::RasterizerStateDescription::get_polygon_offset | ( | float & | out_factor,
|  | float & | out_units
| ) |  | const

bool clan::PixelConverter::get_premultiply_alpha | ( |  | ) | const

Returns the premultiply alpha setting.

bool clan::ImageImportDescription::get_premultiply_alpha | ( |  | ) | const

Returns the premultiply alpha setting.

virtual ProgramObject clan::GraphicContextProvider::get_program_object | ( | StandardProgram | standard_program | ) | const
| pure virtual

Get a program object from the standard program specified.

ProgramObject clan::GraphicContext::get_program_object | ( |  | ) | const

Returns the currently selected program object.

const Mat4f& clan::Canvas::get_projection | ( |  | ) | const

Returns the current effective projection matrix.

DisplayTargetProvider* clan::DisplayTarget::get_provider | ( |  | ) |

Returns the provider for the display target.

RasterizerStateProvider* clan::RasterizerState::get_provider | ( |  | ) | const

DepthStencilStateProvider* clan::DepthStencilState::get_provider | ( |  | ) | const

BlendStateProvider* clan::BlendState::get_provider | ( |  | ) | const

static GraphicContextProvider* clan::SharedGCData::get_provider | ( | std::unique_ptr< std::unique_lock< std::recursive_mutex >> & | mutex_section | ) |
| static

Get a provider.

Parameters

  mutex_section | : Returns the mutex section for the provider lock

Returns
  NULL = None available

OcclusionQueryProvider* clan::OcclusionQuery::get_provider | ( |  | ) | const

Get Provider.

Returns
  provider

RenderBufferProvider* clan::RenderBuffer::get_provider | ( |  | ) | const

Get Provider.

Returns
  provider

StorageBufferProvider* clan::StorageBuffer::get_provider | ( |  | ) | const

Get Provider.

Returns
  provider

ElementArrayBufferProvider* clan::ElementArrayBuffer::get_provider | ( |  | ) | const

Get Provider.

Returns
  provider

VertexArrayBufferProvider* clan::VertexArrayBuffer::get_provider | ( |  | ) | const

Get Provider.

Returns
  provider

TransferBufferProvider* clan::TransferBuffer::get_provider | ( |  | ) | const

Get Provider.

Returns
  provider

UniformBufferProvider* clan::UniformBuffer::get_provider | ( |  | ) | const

Get Provider.

Returns
  provider

PrimitivesArrayProvider* clan::PrimitivesArray::get_provider | ( |  | ) | const

Returns the target provider for the primitives array.

FrameBufferProvider* clan::FrameBuffer::get_provider | ( |  | ) | const

Get Provider.

Returns
  provider

ShaderObjectProvider* clan::ShaderObject::get_provider | ( |  | ) | const

Get Provider.

Returns
  provider

TextureProvider* clan::Texture::get_provider | ( |  | ) | const

Get Provider.

Returns
  provider

ProgramObjectProvider* clan::ProgramObject::get_provider | ( |  | ) | const

Retrieves the provider.

PixelBufferProvider* clan::PixelBuffer::get_provider | ( |  | ) | const

Get Provider.

Returns
  provider

GraphicContextProvider* clan::GraphicContext::get_provider | ( |  | ) |

Returns the provider for this graphic context.

const GraphicContextProvider* clan::GraphicContext::get_provider | ( |  | ) | const

FrameBuffer clan::GraphicContext::get_read_frame_buffer | ( |  | ) | const

Returns the currently selected read frame buffer.

Returns
  The frame buffer. Use frame_buffer.is_null() to determine if the frame buffer was not selected

int clan::OcclusionQuery::get_result | ( |  | ) |

Returns the result of the occlusion query.

template<typename Type >

Type* clan::PixelBufferLock< Type >::get_row | ( | int | y | ) |
| inline

References clan::y.

std::vector<Rectf> clan::ScreenInfo::get_screen_geometries | ( | int & | primary_screen_index | ) | const

Returns the geometries of the attached screens and the index of the primary screen in the returned array.

virtual ShaderLanguage clan::GraphicContextProvider::get_shader_language | ( |  | ) | const
| pure virtual

Returns the shader language used.

ShaderLanguage clan::GraphicContext::get_shader_language | ( |  | ) | const

Returns the shader language used.

virtual std::string clan::ShaderObjectProvider::get_shader_source | ( |  | ) | const
| pure virtual

Get shader source code.

std::string clan::ShaderObject::get_shader_source | ( |  | ) | const

Get shader source code.

virtual ShaderType clan::ShaderObjectProvider::get_shader_type | ( |  | ) | const
| pure virtual

Gets the shader type.

ShaderType clan::ShaderObject::get_shader_type | ( |  | ) | const

Gets the shader type.

virtual std::vector<ShaderObject> clan::ProgramObjectProvider::get_shaders | ( |  | ) | const
| pure virtual

Returns the shaders used in this program.

std::vector<ShaderObject> clan::ProgramObject::get_shaders | ( |  | ) | const

Returns the shaders attached to the program object.

virtual Size clan::FrameBufferProvider::get_size | ( |  | ) | const
| pure virtual

int clan::Texture1DArray::get_size | ( |  | ) | const

Get the texture width.

virtual Size clan::PixelBufferProvider::get_size | ( |  | ) | const
| pure virtual

int clan::Texture1D::get_size | ( |  | ) | const

Get the texture width.

const Size& clan::RenderBuffer::get_size | ( |  | ) | const

Returns the render buffer size.

Size clan::TextureCubeArray::get_size | ( |  | ) | const

Get the texture size.

Vec3i clan::Texture3D::get_size | ( |  | ) | const

Get the texture size.

Size clan::Texture2DArray::get_size | ( |  | ) | const
| inline

Retrieves the actual size of the texture.

References clan::Texture2DArray::get_height(), and clan::Texture2DArray::get_width().

Size clan::Texture2D::get_size | ( |  | ) | const
| inline

Retrieves the actual size of the texture.

References clan::Texture2D::get_height(), and clan::Texture2D::get_width().

Size clan::TextureCube::get_size | ( |  | ) | const

Get the texture size.

Size clan::FrameBuffer::get_size | ( |  | ) | const

Get the minumum size of all the frame buffer attachments.

Returns
  size

Size clan::PerlinNoise::get_size | ( |  | ) | const

Get the size of the output pixelbuffer.

Sizef clan::Canvas::get_size | ( |  | ) | const
| inline

Returns the current size of the context.

References clan::GraphicContext::get_dip_size(), and clan::Canvas::get_gc().

Size clan::PixelBuffer::get_size | ( |  | ) | const
| inline

Retrieves the actual size of the buffer.

References clan::PixelBuffer::get_height(), and clan::PixelBuffer::get_width().

Size clan::GraphicContext::get_size | ( |  | ) | const

Returns the current actual size of the context.

int clan::PixelBufferSet::get_slice_count | ( |  | ) | const

Returns the number of depth/array/cube slices in the set.

void clan::DepthStencilStateDescription::get_stencil_compare_back | ( | CompareFunction & | out_back,
|  | int & | out_back_ref,
|  | int & | out_back_mask
| ) |  | const

void clan::DepthStencilStateDescription::get_stencil_compare_front | ( | CompareFunction & | out_front,
|  | int & | out_front_ref,
|  | int & | out_front_mask
| ) |  | const

void clan::DepthStencilStateDescription::get_stencil_op_back | ( | StencilOp & | out_fail_back,
|  | StencilOp & | out_pass_depth_fail_back,
|  | StencilOp & | out_pass_depth_pass_back
| ) |  | const

void clan::DepthStencilStateDescription::get_stencil_op_front | ( | StencilOp & | out_fail_front,
|  | StencilOp & | out_pass_depth_fail_front,
|  | StencilOp & | out_pass_depth_pass_front
| ) |  | const

void clan::DepthStencilStateDescription::get_stencil_write_mask | ( | unsigned char & | out_front_facing_mask,
|  | unsigned char & | out_back_facing_mask
| ) |  | const

virtual int clan::ProgramObjectProvider::get_storage_buffer_index | ( | const std::string & | name | ) | const
| pure virtual

Get the storage block index.

Returns -1 when the block index was not found

int clan::ProgramObject::get_storage_buffer_index | ( | const std::string & | name | ) | const

Get the storage buffer index.

Returns -1 when the block index was not found

Vec4i clan::PixelConverter::get_swizzle | ( |  | ) | const

Returns the input channel used for each output channel.

Texture clan::GraphicContext::get_texture | ( | int | index | ) | const

Retrieves the texture selected in this context with an index number.

Parameters

  index | The texture index number to retrieve. [0 to n]

Returns
  The texture on the specified index. Use Texture::is_null() to determine whether the texture has been selected by the context.

virtual TextureImageYAxis clan::GraphicContextProvider::get_texture_image_y_axis | ( |  | ) | const
| pure virtual

Returns the Y axis direction for viewports, clipping rects, textures and render targets.

TextureImageYAxis clan::GraphicContext::get_texture_image_y_axis | ( |  | ) | const

Returns the Y axis direction for viewports, clipping rects, textures and render targets.

std::vector<Texture> clan::GraphicContext::get_textures | ( |  | ) | const

Returns the textures currently selected in this context.

Returns
  A vector containing the selected textures. The vector may contain null (unselected) texture elements within it..

virtual std::string clan::DisplayWindowProvider::get_title | ( |  | ) | const
| pure virtual

Returns the maximum size of the window.

const Mat4f& clan::Canvas::get_transform | ( |  | ) | const

Returns the current effective transform matrix.

virtual int clan::ProgramObjectProvider::get_uniform_buffer_index | ( | const std::string & | block_name | ) | const
| pure virtual

Get the uniform block index.

Returns -1 when the block index was not found

int clan::ProgramObject::get_uniform_buffer_index | ( | const std::string & | block_name | ) | const

Get the uniform block index.

Returns -1 when the block index was not found

virtual int clan::ProgramObjectProvider::get_uniform_buffer_size | ( | int | block_index | ) | const
| pure virtual

Get the uniform block size.

int clan::ProgramObject::get_uniform_buffer_size | ( | const std::string & | block_name | ) | const

Get the uniform block size.

An exception is thrown of block_name was not found

Returns -1 when unknown

int clan::ProgramObject::get_uniform_buffer_size | ( | int | block_index | ) | const

Get the uniform block size.

virtual int clan::ProgramObjectProvider::get_uniform_location | ( | const std::string & | name | ) | const
| pure virtual

Returns the location of a named uniform variable.

int clan::ProgramObject::get_uniform_location | ( | const std::string & | name | ) | const

Returns the location of a named uniform variable.

Returns -1 when unknown

Referenced by clan::ProgramObject::set_uniform1f(), clan::ProgramObject::set_uniform1i(), clan::ProgramObject::set_uniform2b(), clan::ProgramObject::set_uniform2f(), clan::ProgramObject::set_uniform2i(), clan::ProgramObject::set_uniform2s(), clan::ProgramObject::set_uniform3b(), clan::ProgramObject::set_uniform3f(), clan::ProgramObject::set_uniform3i(), clan::ProgramObject::set_uniform3s(), clan::ProgramObject::set_uniform4b(), clan::ProgramObject::set_uniform4f(), clan::ProgramObject::set_uniform4i(), clan::ProgramObject::set_uniform4s(), clan::ProgramObject::set_uniform_matrix(), clan::ProgramObject::set_uniformfv(), and clan::ProgramObject::set_uniformiv().

virtual bool clan::ProgramObjectProvider::get_validate_status | ( |  | ) | const
| pure virtual

Returns true if validation succeeded.

virtual Rect clan::DisplayWindowProvider::get_viewport | ( |  | ) | const
| pure virtual

Returns the drawable area of the window.

int clan::TextureCubeArray::get_width | ( |  | ) | const

Get the texture width.

int clan::Texture3D::get_width | ( |  | ) | const

Get the texture width.

int clan::PixelBufferSet::get_width | ( |  | ) | const

Returns the width of the image.

int clan::Texture2DArray::get_width | ( |  | ) | const

Retrieves the actual width of the texture in the display.

Referenced by clan::Texture2DArray::get_dip_width(), and clan::Texture2DArray::get_size().

int clan::Texture2D::get_width | ( |  | ) | const

Retrieves the actual width of the texture in the display.

Referenced by clan::Texture2D::get_dip_width(), and clan::Texture2D::get_size().

int clan::TextureCube::get_width | ( |  | ) | const

Get the texture width.

template<typename Type >

int clan::PixelBufferLock< Type >::get_width | ( |  | ) | const
| inline

float clan::Canvas::get_width | ( |  | ) | const
| inline

Returns the current width of the context.

References clan::GraphicContext::get_dip_width(), and clan::Canvas::get_gc().

int clan::PixelBuffer::get_width | ( |  | ) | const

Retrieves the actual width of the buffer.

Referenced by clan::PixelBuffer::get_dip_width(), clan::PixelBuffer::get_size(), and clan::PixelBufferLock< Type >::PixelBufferLock().

int clan::GraphicContext::get_width | ( |  | ) | const

Returns the current actual width of the context.

Referenced by clan::GraphicContext::get_dip_width().

TextureWrapMode clan::Texture3D::get_wrap_mode_r | ( |  | ) | const

Get the texture wrap mode for the r coordinate.

TextureWrapMode clan::Texture1DArray::get_wrap_mode_s | ( |  | ) | const

Get the texture wrap mode for the s coordinate.

TextureWrapMode clan::Texture1D::get_wrap_mode_s | ( |  | ) | const

Get the texture wrap mode for the s coordinate.

TextureWrapMode clan::Texture3D::get_wrap_mode_s | ( |  | ) | const

Get the texture wrap mode for the s coordinate.

TextureWrapMode clan::Texture2DArray::get_wrap_mode_s | ( |  | ) | const

Get the texture wrap mode for the s coordinate.

TextureWrapMode clan::Texture2D::get_wrap_mode_s | ( |  | ) | const

Get the texture wrap mode for the s coordinate.

TextureWrapMode clan::Texture3D::get_wrap_mode_t | ( |  | ) | const

Get the texture wrap mode for the t coordinate.

TextureWrapMode clan::Texture2DArray::get_wrap_mode_t | ( |  | ) | const

Get the texture wrap mode for the t coordinate.

TextureWrapMode clan::Texture2D::get_wrap_mode_t | ( |  | ) | const

Get the texture wrap mode for the t coordinate.

FrameBuffer clan::GraphicContext::get_write_frame_buffer | ( |  | ) | const

Returns the currently selected write frame buffer.

Returns
  The frame buffer. Use frame_buffer.is_null() to determine if the frame buffer was not selected

Pointf clan::Canvas::grid_fit | ( | const Pointf & | pos | ) |

Snaps the point to the nearest pixel corner.

virtual bool clan::GraphicContextProvider::has_compute_shader_support | ( |  | ) | const
| pure virtual

Returns true if the hardware supports compute shaders.

This always returns true for OpenGL 4.3 or newer, or Direct3D 11.0 or newer. For Direct3D 10.0 and 10.1 the support for compute shaders is optional.

bool clan::GraphicContext::has_compute_shader_support | ( |  | ) | const

Returns `true` if the hardware supports compute shaders. This function will always returns true for OpenGL 4.3 or newer, or Direct3D 11.0 or newer. For Direct3D 10.0 and 10.1, the support for compute shaders is optional.

virtual bool clan::DisplayWindowProvider::has_focus | ( |  | ) | const
| pure virtual

Returns true if window has focus.

bool clan::PixelBuffer::has_transparency | ( |  | ) | const

Returns true if format has an alpha channel.

virtual void clan::DisplayWindowProvider::hide | ( |  | ) |
| pure virtual

Hides the window.

virtual void clan::DisplayWindowProvider::hide_system_cursor | ( |  | ) |
| pure virtual

Hides the mouse cursor.

bool clan::BlendStateDescription::is_blending_enabled | ( |  | ) | const

bool clan::ImageImportDescription::is_cached | ( |  | ) | const

Returns if this image should be cached.

virtual bool clan::DisplayWindowProvider::is_clipboard_image_available | ( |  | ) | const
| pure virtual

Returns true if an image is available in the clipboard.

virtual bool clan::DisplayWindowProvider::is_clipboard_text_available | ( |  | ) | const
| pure virtual

Returns true if text is available in the clipboard.

bool clan::PixelBuffer::is_compressed | ( |  | ) | const

Returns true if compressed.

static bool clan::PixelBuffer::is_compressed | ( | TextureFormat | texture_format | ) |
| static

Returns true if compressed.

bool clan::DepthStencilStateDescription::is_depth_test_enabled | ( |  | ) | const

bool clan::DepthStencilStateDescription::is_depth_write_enabled | ( |  | ) | const

virtual bool clan::GraphicContextProvider::is_frame_buffer_owner | ( | const FrameBuffer & | fb | ) |
| pure virtual

Returns true if this frame buffer object is owned by this graphic context.

bool clan::GraphicContext::is_frame_buffer_owner | ( | const FrameBuffer & | fb | ) |

Returns `true` if this frame buffer object is owned by this graphic context.

Frame buffer objects cannot be shared between graphic contexts. This function will verify if the frame buffer object belongs to this graphic context.

virtual bool clan::DisplayWindowProvider::is_fullscreen | ( |  | ) | const
| pure virtual

Returns true if the window is fullscreen.

virtual bool clan::PixelBufferProvider::is_gpu | ( |  | ) | const
| pure virtual

Returns true if this pixel buffer is a GPU based one.

bool clan::PixelBuffer::is_gpu | ( |  | ) | const

Returns true if this pixel buffer is a GPU based one.

Referenced by clan::PixelBufferLock< Type >::lock().

bool clan::BlendStateDescription::is_logic_op_enabled | ( |  | ) | const

virtual bool clan::DisplayWindowProvider::is_maximized | ( |  | ) | const
| pure virtual

Returns true if the window is maximized.

virtual bool clan::DisplayWindowProvider::is_minimized | ( |  | ) | const
| pure virtual

Returns true if the window is minimized.

bool clan::DepthStencilState::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::RasterizerState::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::ShaderEffect::is_null | ( |  | ) | const

bool clan::BlendState::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::OcclusionQuery::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::DisplayTarget::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::PixelBufferSet::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::RenderBuffer::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::StorageBuffer::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::TransferBuffer::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::ElementArrayBuffer::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::VertexArrayBuffer::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::UniformBuffer::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::PrimitivesArray::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::FrameBuffer::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::Canvas::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::PixelBuffer::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

Referenced by clan::PixelBufferLock< Type >::lock(), clan::PixelBufferLock< Type >::unlock(), and clan::PixelBufferLock< Type >::~PixelBufferLock().

bool clan::Texture::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

References clan::Texture::impl.

bool clan::ShaderObject::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::ProgramObject::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::GraphicContext::is_null | ( |  | ) | const
| inline

Returns true if this object is invalid.

bool clan::RasterizerStateDescription::is_point_size | ( |  | ) | const

virtual bool clan::GraphicContextProvider::is_primitives_array_owner | ( | const PrimitivesArray & | primitives_array | ) |
| pure virtual

Returns true if this primitives_array is owned by this graphic context.

bool clan::GraphicContext::is_primitives_array_owner | ( | const PrimitivesArray & | primitives_array | ) |

Returns true if this primitives array is owned by this graphic context.

Primitive array objects cannot be shared between graphic contexts. This function verifies that the primitives array belongs to this graphic context.

bool clan::Texture::is_resident | ( |  | ) | const

Returns true if texture is resident in texture memory.

bool clan::OcclusionQuery::is_result_ready | ( |  | ) |

Returns true if the GPU is ready to return the result.

bool clan::ImageImportDescription::is_srgb | ( |  | ) | const

Returns the sRGB setting.

bool clan::DepthStencilStateDescription::is_stencil_test_enabled | ( |  | ) | const

virtual bool clan::DisplayWindowProvider::is_visible | ( |  | ) | const
| pure virtual

Returns true if the window is visible.

virtual void clan::ProgramObjectProvider::link | ( |  | ) |
| pure virtual

Link program.

If the linking fails, get_link_status() will return false and get_info_log() will return the link log.

bool clan::ProgramObject::link | ( |  | ) |

Link program.

If the linking fails, get_info_log() will return the link log.

static ProgramObject clan::ProgramObject::load | ( | GraphicContext & | gc,
|  | const std::string & | resource_id,
|  | const XMLResourceDocument & | resman
| ) |  |
| static

Load.

Parameters

  gc | = Graphic Context
  resource_id | = String Ref
  resman | = Resource Manager

Returns
  Program Object

static ProgramObject clan::ProgramObject::load | ( | GraphicContext & | gc,
|  | const std::string & | vertex_fullname,
|  | const std::string & | fragment_fullname
| ) |  |
| static

Load.

Parameters

  gc | = Graphic Context
  vertex_fullname | = String Ref
  fragment_fullname | = String Ref

Returns
  Program Object

static ShaderObject clan::ShaderObject::load | ( | GraphicContext & | gc,
|  | const std::string & | resource_id,
|  | const XMLResourceDocument & | resources
| ) |  |
| static

Load.

Parameters

  gc | = Graphic Context
  resource_id | = String Ref
  resources | = Resource Manager

Returns
  Shader Object

static ProgramObject clan::ProgramObject::load | ( | GraphicContext & | gc,
|  | const std::string & | vertex_fullname,
|  | const std::string & | geometry_fullname,
|  | const std::string & | fragment_fullname
| ) |  |
| static

Load.

Parameters

  gc | = Graphic Context
  vertex_fullname | = String Ref
  geometry_fullname | = String Ref
  fragment_fullname | = String Ref

Returns
  Program Object

static ShaderObject clan::ShaderObject::load | ( | GraphicContext & | gc,
|  | ShaderType | type,
|  | const std::string & | filename,
|  | const FileSystem & | fs
| ) |  |
| static

Load.

Parameters

  gc | = Graphic Context
  type | = Shader Type
  filename | = String Ref
  directory | = Virtual Directory

Returns
  Shader Object

static ProgramObject clan::ProgramObject::load | ( | GraphicContext & | gc,
|  | const std::string & | vertex_filename,
|  | const std::string & | fragment_filename,
|  | const FileSystem & | fs
| ) |  |
| static

Load.

Parameters

  gc | = Graphic Context
  vertex_filename | = String Ref
  fragment_filename | = String Ref
  directory | = Virtual Directory

Returns
  Program Object

static ShaderObject clan::ShaderObject::load | ( | GraphicContext & | gc,
|  | ShaderType | type,
|  | const std::string & | fullname
| ) |  |
| static

Load.

Parameters

  gc | = Graphic Context
  type | = Shader Type
  fullname | = String Ref

Returns
  Shader Object

static Texture clan::Texture::load | ( | GraphicContext & | gc,
|  | const std::string & | id,
|  | const XMLResourceDocument & | doc,
|  | const ImageImportDescription & | import_desc = `ImageImportDescription()`
| ) |  |
| static

Loads a Texture from a XML resource definition.

static ProgramObject clan::ProgramObject::load | ( | GraphicContext & | gc,
|  | const std::string & | vertex_filename,
|  | const std::string & | geometry_filename,
|  | const std::string & | fragment_filename,
|  | const FileSystem & | fs
| ) |  |
| static

Load.

Parameters

  gc | = Graphic Context
  vertex_filename | = String Ref
  geometry_filename | = String Ref
  fragment_filename | = String Ref
  directory | = Virtual Directory

Returns
  Program Object

static ShaderObject clan::ShaderObject::load | ( | GraphicContext & | gc,
|  | ShaderType | type,
|  | IODevice & | file
| ) |  |
| static

Load.

Parameters

  gc | = Graphic Context
  type | = Shader Type
  file | = IODevice

Returns
  Shader Object

static ProgramObject clan::ProgramObject::load | ( | GraphicContext & | gc,
|  | IODevice & | vertex_file,
|  | IODevice & | fragment_file
| ) |  |
| static

Load.

Parameters

  gc | = Graphic Context
  vertex_file | = IODevice
  fragment_file | = IODevice

Returns
  Program Object

static ProgramObject clan::ProgramObject::load | ( | GraphicContext & | gc,
|  | IODevice & | vertex_file,
|  | IODevice & | geometry_file,
|  | IODevice & | fragment_file
| ) |  |
| static

Load.

Parameters

  gc | = Graphic Context
  vertex_file | = IODevice
  geometry_file | = IODevice
  fragment_file | = IODevice

Returns
  Program Object

static ShaderObject clan::ShaderObject::load_and_compile | ( | GraphicContext & | gc,
|  | ShaderType | type,
|  | const std::string & | filename,
|  | const FileSystem & | fs
| ) |  |
| static

Load and compile.

Parameters

  gc | = Graphic Context
  type | = Shader Type
  filename | = String Ref
  directory | = Virtual Directory

Returns
  Shader Object

static ShaderObject clan::ShaderObject::load_and_compile | ( | GraphicContext & | gc,
|  | ShaderType | type,
|  | const std::string & | filename
| ) |  |
| static

Load and compile.

Parameters

  gc | = Graphic Context
  type | = Shader Type
  filename | = String Ref

Returns
  Shader Object

static ShaderObject clan::ShaderObject::load_and_compile | ( | GraphicContext & | gc,
|  | ShaderType | type,
|  | IODevice & | file
| ) |  |
| static

Load and compile.

Parameters

  gc | = Graphic Context
  type | = Shader Type
  file | = IODevice

Returns
  Shader Object

static ProgramObject clan::ProgramObject::load_and_link | ( | GraphicContext & | gc,
|  | const std::string & | vertex_fullname,
|  | const std::string & | fragment_fullname
| ) |  |
| static

Load and link.

Parameters

  gc | = Graphic Context
  vertex_fullname | = String Ref
  fragment_fullname | = String Ref

Returns
  Program Object

static ProgramObject clan::ProgramObject::load_and_link | ( | GraphicContext & | gc,
|  | const std::string & | vertex_fullname,
|  | const std::string & | geometry_fullname,
|  | const std::string & | fragment_fullname
| ) |  |
| static

Load and link.

Parameters

  gc | = Graphic Context
  vertex_fullname | = String Ref
  geometry_fullname | = String Ref
  fragment_fullname | = String Ref

Returns
  Program Object

static ProgramObject clan::ProgramObject::load_and_link | ( | GraphicContext & | gc,
|  | const std::string & | vertex_filename,
|  | const std::string & | fragment_filename,
|  | const FileSystem & | fs
| ) |  |
| static

Load and link.

Parameters

  gc | = Graphic Context
  vertex_filename | = String Ref
  fragment_filename | = String Ref
  directory | = Virtual Directory

Returns
  Program Object

static ProgramObject clan::ProgramObject::load_and_link | ( | GraphicContext & | gc,
|  | const std::string & | vertex_filename,
|  | const std::string & | geometry_filename,
|  | const std::string & | fragment_filename,
|  | const FileSystem & | fs
| ) |  |
| static

Load and link.

Parameters

  gc | = Graphic Context
  vertex_filename | = String Ref
  geometry_filename | = String Ref
  fragment_filename | = String Ref
  directory | = Virtual Directory

Returns
  Program Object

static ProgramObject clan::ProgramObject::load_and_link | ( | GraphicContext & | gc,
|  | IODevice & | vertex_file,
|  | IODevice & | fragment_file
| ) |  |
| static

Load and link.

Parameters

  gc | = Graphic Context
  vertex_file | = IODevice
  fragment_file | = IODevice

Returns
  Program Object

static ProgramObject clan::ProgramObject::load_and_link | ( | GraphicContext & | gc,
|  | IODevice & | vertex_file,
|  | IODevice & | geometry_file,
|  | IODevice & | fragment_file
| ) |  |
| static

Load and link.

Parameters

  gc | = Graphic Context
  vertex_file | = IODevice
  geometry_file | = IODevice
  fragment_file | = IODevice

Returns
  Program Object

virtual void clan::TransferBufferProvider::lock | ( | GraphicContext & | gc,
|  | BufferAccess | access
| ) |  |
| pure virtual

Maps buffer into system memory.

virtual void clan::PixelBufferProvider::lock | ( | GraphicContext & | gc,
|  | BufferAccess | access
| ) |  |
| pure virtual

Maps buffer into system memory.

void clan::TransferBuffer::lock | ( | GraphicContext & | gc,
|  | BufferAccess | access
| ) |  |

Maps buffer into system memory.

template<typename Type >

void clan::PixelBufferLock< Type >::lock | ( | GraphicContext & | gc,
|  | BufferAccess | access
| ) |  |
| inline

Lock the gpu pixel_buffer.

References clan::PixelBuffer::get_data(), clan::PixelBuffer::get_pitch(), clan::PixelBuffer::is_null(), and clan::PixelBuffer::lock().

template<typename Type >

void clan::PixelBufferLock< Type >::lock | ( |  | ) |
| inline

Lock the system pixel_buffer.

References clan::PixelBuffer::get_data(), clan::PixelBuffer::get_pitch(), clan::PixelBuffer::is_gpu(), and clan::PixelBuffer::is_null().

Referenced by clan::PixelBufferLock< Type >::PixelBufferLock().

void clan::PixelBuffer::lock | ( | GraphicContext & | gc,
|  | BufferAccess | access
| ) |  |

Maps buffer into system memory.

Referenced by clan::PixelBufferLock< Type >::lock().

virtual void clan::RenderBatcher::matrix_changed | ( | const Mat4f & | modelview,
|  | const Mat4f & | projection,
|  | TextureImageYAxis | image_yaxis,
|  | float | pixel_ratio
| ) |  |
| pure virtual

Function to call when matrices are changed.

Parameters

  modelview | New wodel view matrix.
  projection | New projection matrix.
  image_yaxis | The image Y axis to use where `projection` is not used.
  pixel_ratio | The display pixel ratio to use when rendering.

virtual void clan::DisplayWindowProvider::maximize | ( |  | ) |
| pure virtual

Maximizes the window.

virtual void clan::DisplayWindowProvider::minimize | ( |  | ) |
| pure virtual

Minimizes the window.

void clan::Canvas::mult_transform | ( | const Mat4f & | matrix | ) |

Multiplies the passed matrix onto the transform matrix.

static BlendStateDescription clan::BlendStateDescription::opaque | ( |  | ) |
| static

clan::Canvas::operator GraphicContext & | ( |  | ) | const
| inline

References clan::Canvas::get_gc().

bool clan::Texture::operator!= | ( | const Texture & | other | ) | const
| inline

Inequality operator.

References clan::Texture::impl.

bool clan::GraphicContext::operator!= | ( | const GraphicContext & | other | ) | const
| inline

bool clan::BlendStateDescription::operator< | ( | const BlendStateDescription & | other | ) | const

bool clan::DepthStencilStateDescription::operator< | ( | const DepthStencilStateDescription & | other | ) | const

bool clan::RasterizerStateDescription::operator< | ( | const RasterizerStateDescription & | other | ) | const

bool clan::Texture::operator< | ( | const Texture & | other | ) | const
| inline

Less than operator.

References clan::Texture::impl.

bool clan::RenderBuffer::operator== | ( | const RenderBuffer & | other | ) | const

Equality operator.

bool clan::BlendStateDescription::operator== | ( | const BlendStateDescription & | other | ) | const

bool clan::StorageBuffer::operator== | ( | const StorageBuffer & | other | ) | const

Handle comparison operator.

bool clan::ElementArrayBuffer::operator== | ( | const ElementArrayBuffer & | other | ) | const

Handle comparison operator.

bool clan::VertexArrayBuffer::operator== | ( | const VertexArrayBuffer & | other | ) | const

Handle comparison operator.

bool clan::TransferBuffer::operator== | ( | const TransferBuffer & | other | ) | const

Handle comparison operator.

bool clan::UniformBuffer::operator== | ( | const UniformBuffer & | other | ) | const

Handle comparison operator.

bool clan::DepthStencilStateDescription::operator== | ( | const DepthStencilStateDescription & | other | ) | const

bool clan::FrameBuffer::operator== | ( | const FrameBuffer & | other | ) | const

Equality operator.

bool clan::RasterizerStateDescription::operator== | ( | const RasterizerStateDescription & | other | ) | const

bool clan::Texture::operator== | ( | const Texture & | other | ) | const
| inline

Equality operator.

References clan::Texture::impl.

bool clan::ShaderObject::operator== | ( | const ShaderObject & | other | ) | const

Handle comparison operator.

bool clan::ProgramObject::operator== | ( | const ProgramObject & | other | ) | const

Equality operator.

bool clan::GraphicContext::operator== | ( | const GraphicContext & | other | ) | const
| inline

template<typename Type>

Type& clan::TransferVector< Type >::operator[] | ( | int | index | ) |
| inline

References clan::TransferVector< Type >::get_data().

template<typename Type>

Type& clan::TransferVector< Type >::operator[] | ( | unsigned int | index | ) |
| inline

References clan::TransferVector< Type >::get_data().

void clan::Canvas::pop_cliprect | ( |  | ) |

Pop current clipping rectangle from the stack.

void clan::PixelBuffer::premultiply_alpha | ( |  | ) |

Multiply the RGB components by the Alpha component.

This is useful with certain blending functions

void clan::PixelBuffer::premultiply_gamma | ( | float | gamma | ) |

Multiply the RGB components by gamma value.

Calling this function with 2.2 gamma converts a sRGB image into linear space. To convert from linear to sRGB use 1.0/2.2

PixelBuffer clan::ImageImportDescription::process | ( | PixelBuffer & | image | ) | const

Process the pixel buffers depending of the chosen settings.

Note, the output may point to a different pixel buffer than the input
The input image may be written to.

void clan::Canvas::push_cliprect | ( | const Rectf & | rect | ) |

Push current clipping rectangle to stack.

If a rectangle is passed, it afterwards sets clipping rectangle to the union of the current rectangle and the passed rectangle.

void clan::Canvas::push_cliprect | ( |  | ) |

Push cliprect.

RasterizerStateDescription& clan::ShaderEffectDescription::rasterizer | ( |  | ) |

static void clan::SharedGCData::release_ref | ( |  | ) |
| static

Release ref.

static void clan::SharedGCData::remove_disposable | ( | DisposableObject * | disposable | ) |
| static

Remove disposable.

Parameters

  disposable | = Disposable Object

static void clan::SharedGCData::remove_provider | ( | GraphicContextProvider * | provider | ) |
| static

Remove a provider.

static void clan::Display::remove_target | ( | const DisplayTarget & | target | ) |
| static

Remove the target from the target list.

virtual void clan::DisplayWindowProvider::request_repaint | ( | const Rect & | rect | ) |
| pure virtual

Invalidates a region of a screen, causing a repaint.

void clan::Canvas::reset_blend_state | ( |  | ) |

Set active blend state.

void clan::GraphicContext::reset_blend_state | ( |  | ) |

Set active blend state.

void clan::Canvas::reset_cliprect | ( |  | ) |

Removes the set clipping rectangle and empties the cliprect stack.

void clan::Canvas::reset_depth_stencil_state | ( |  | ) |

Set active depth stencil state.

void clan::GraphicContext::reset_depth_stencil_state | ( |  | ) |

Set active depth stencil state.

virtual void clan::GraphicContextProvider::reset_frame_buffer | ( |  | ) |
| pure virtual

Set the rendering buffer back to the screen.

void clan::GraphicContext::reset_frame_buffer | ( |  | ) |

Resets the current frame buffer to be the initial frame buffer.

virtual void clan::GraphicContextProvider::reset_image_texture | ( | int | unit_index | ) |
| pure virtual

Remove texture from image unit.

void clan::GraphicContext::reset_image_texture | ( | int | unit_index | ) |

Remove texture from index.

Parameters

  unit_index | = 0 to x, the index of the texture

void clan::GraphicContext::reset_image_textures | ( |  | ) |

Remove all selected textures.

virtual void clan::GraphicContextProvider::reset_primitives_array | ( |  | ) |
| pure virtual

Reset the primitives arrays.

void clan::GraphicContext::reset_primitives_array | ( |  | ) |

Reset the primitives arrays.

virtual void clan::GraphicContextProvider::reset_primitives_elements | ( |  | ) |
| pure virtual

Resets current elements array buffer.

void clan::GraphicContext::reset_primitives_elements | ( |  | ) |

Resets current elements array buffer.

virtual void clan::GraphicContextProvider::reset_program_object | ( |  | ) |
| pure virtual

Remove active program object.

void clan::GraphicContext::reset_program_object | ( |  | ) |

Remove active program object.

void clan::Canvas::reset_rasterizer_state | ( |  | ) |

Set active rasterizer state.

void clan::GraphicContext::reset_rasterizer_state | ( |  | ) |

Set active rasterizer state.

virtual void clan::GraphicContextProvider::reset_scissor | ( |  | ) |
| pure virtual

Reset scissor.

void clan::GraphicContext::reset_scissor | ( |  | ) |

Removes the set clipping rectangle.

virtual void clan::GraphicContextProvider::reset_storage_buffer | ( | int | index | ) |
| pure virtual

Remove storage buffer from index.

void clan::GraphicContext::reset_storage_buffer | ( | int | index | ) |

Remove storage buffer from index.

virtual void clan::GraphicContextProvider::reset_texture | ( | int | unit_index | ) |
| pure virtual

Remove texture from unit.

void clan::GraphicContext::reset_texture | ( | int | unit_index | ) |

Remove texture from index.

Parameters

  unit_index | = 0 to x, the index of the texture

void clan::GraphicContext::reset_textures | ( |  | ) |

Remove all selected textures.

virtual void clan::GraphicContextProvider::reset_uniform_buffer | ( | int | index | ) |
| pure virtual

Remove uniform buffer from index.

void clan::GraphicContext::reset_uniform_buffer | ( | int | index | ) |

Remove uniform buffer from index.

static Resource<Texture> clan::Texture::resource | ( | GraphicContext & | gc,
|  | const std::string & | id,
|  | const ResourceManager & | resources
| ) |  |
| static

Retrieves a Texture resource from the resource manager.

Parameters

  gc | = Graphic Context
  resources | = Resource manager
  id | = id

virtual void clan::DisplayWindowProvider::restore | ( |  | ) |
| pure virtual

Restores the window.

virtual Point clan::DisplayWindowProvider::screen_to_client | ( | const Point & | screen | ) |
| pure virtual

Convert from screen coordinates to client coordinates.

void clan::PerlinNoise::set_amplitude | ( | float | amplitude = `1.0f` | ) |

Set the amplitude of the perlin noise.

If this function is not used, the amplitude defaults to 1.0f

Parameters

  amplitude | = The amplitude to set

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayBuffer & | buffer,
|  | int | size,
|  | VertexAttributeDataType | type,
|  | size_t | offset = `0`,
|  | int | stride = `0`,
|  | bool | normalize = `false`
| ) |  |

Referenced by clan::ShaderEffectDescription::set_attribute().

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< unsigned char > & | buffer,
|  | int | size,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_byte.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< char > & | buffer,
|  | int | size,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_byte.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< unsigned short > & | buffer,
|  | int | size,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_short.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< short > & | buffer,
|  | int | size,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_short.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< unsigned int > & | buffer,
|  | int | size,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_int.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< int > & | buffer,
|  | int | size,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_int.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< float > & | buffer,
|  | int | size,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_float.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< unsigned char > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_byte.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< signed char > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_byte.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< unsigned short > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_short.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< signed short > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_short.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< unsigned int > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_int.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< signed int > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_int.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< float > & | buffer
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_float.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec2ub > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_byte.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec2b > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_byte.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec2us > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_short.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec2s > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_short.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec2ui > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_int.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec2i > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_int.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec2f > & | buffer
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_float.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec3ub > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_byte.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec3b > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_byte.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec3us > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_short.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec3s > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_short.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec3ui > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_int.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec3i > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_int.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec3f > & | buffer
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_float.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec4ub > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_byte.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec4b > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_byte.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec4us > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_short.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec4s > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_short.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec4ui > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_unsigned_int.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec4i > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_int.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Vec4f > & | buffer
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_float.

void clan::ShaderEffectDescription::set_attribute | ( | std::string | name,
|  | VertexArrayVector< Colorf > & | buffer
| ) |  |
| inline

References clan::ShaderEffectDescription::set_attribute(), and clan::type_float.

void clan::ShaderEffectDescription::set_attribute_screen_quad | ( | std::string | name | ) |

void clan::ShaderEffectDescription::set_attribute_uv_quad | ( | std::string | name | ) |

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayBuffer & | buffer,
|  | int | size,
|  | VertexAttributeDataType | type,
|  | size_t | offset = `0`,
|  | int | stride = `0`,
|  | bool | normalize = `false`
| ) |  |

Set attributes.

Parameters

  index | = value
  buffer | = Vertex Array Buffer
  size | = value
  type | = Vertex Attribute Data Type
  offset | = void
  stride | = value
  normalize | = bool

Referenced by clan::PrimitivesArray::set_attributes().

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< unsigned char > & | buffer,
|  | int | size,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_byte.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< char > & | buffer,
|  | int | size,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_byte.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< unsigned short > & | buffer,
|  | int | size,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_short.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< short > & | buffer,
|  | int | size,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_short.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< unsigned int > & | buffer,
|  | int | size,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_int.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< int > & | buffer,
|  | int | size,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_int.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< float > & | buffer,
|  | int | size,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_float.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< unsigned char > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_byte.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< signed char > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_byte.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< unsigned short > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_short.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< signed short > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_short.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< unsigned int > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_int.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< signed int > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_int.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< float > & | buffer
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_float.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec2ub > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_byte.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec2b > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_byte.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec2us > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_short.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec2s > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_short.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec2ui > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_int.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec2i > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_int.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec2f > & | buffer
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_float.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec3ub > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_byte.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec3b > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_byte.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec3us > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_short.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec3s > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_short.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec3ui > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_int.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec3i > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_int.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec3f > & | buffer
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_float.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec4ub > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_byte.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec4b > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_byte.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec4us > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_short.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec4s > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_short.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec4ui > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_int.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec4i > & | buffer,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_int.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Vec4f > & | buffer
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_float.

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Colorf > & | buffer
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_float.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | unsigned char * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_byte.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | signed char * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_byte.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | unsigned short * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_short.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | signed short * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_short.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | unsigned int * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_int.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | signed int * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_int.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | float * | member_offset
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_float.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec2ub * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_byte.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec2b * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_byte.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec2us * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_short.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec2s * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_short.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec2ui * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_int.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec2i * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_int.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec2f * | member_offset
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_float.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec3ub * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_byte.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec3b * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_byte.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec3us * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_short.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec3s * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_short.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec3ui * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_int.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec3i * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_int.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec3f * | member_offset
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_float.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec4ub * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_byte.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec4b * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_byte.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec4us * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_short.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec4s * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_short.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec4ui * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_unsigned_int.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec4i * | member_offset,
|  | bool | normalize = `false`
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_int.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Vec4f * | member_offset
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_float.

template<typename Type >

void clan::PrimitivesArray::set_attributes | ( | int | index,
|  | VertexArrayVector< Type > & | buffer,
|  | Colorf * | member_offset
| ) |  |
| inline

References clan::PrimitivesArray::set_attributes(), and clan::type_float.

virtual void clan::TextureProvider::set_base_level | ( | int | base_level | ) |
| pure virtual

Sets the texture base level texture parameter.

void clan::Texture::set_base_level | ( | int | base_level | ) |

Sets the texture base level texture parameter.

void clan::Canvas::set_batcher | ( | RenderBatcher * | batcher | ) |

Specifies which render batcher is to be currently active.

If the render batcher is already active, nothing happens. If a different render batcher is currently active, it is flushed before the new batcher is made active.

virtual void clan::FrameBufferProvider::set_bind_target | ( | FrameBufferBindTarget | target | ) |
| pure virtual

void clan::FrameBuffer::set_bind_target | ( | FrameBufferBindTarget | target | ) |

Set the bind target of the framebuffer to either drawn to or read from.

Detach existing textures and renderbuffers before setting a new bind target

Parameters

  target | = Target

void clan::BlendStateDescription::set_blend_equation | ( | BlendEquation | color,
|  | BlendEquation | alpha
| ) |  |

Set the constant color used in the blend equations.

void clan::BlendStateDescription::set_blend_function | ( | BlendFunc | src,
|  | BlendFunc | dest,
|  | BlendFunc | src_alpha,
|  | BlendFunc | dest_alpha
| ) |  |

Set the blend functions.

void clan::Canvas::set_blend_state | ( | const BlendState & | state,
|  | const Colorf & | blend_color = `Colorf::white`,
|  | unsigned int | sample_mask = `0xffffffff`
| ) |  |

Set active blend state.

virtual void clan::GraphicContextProvider::set_blend_state | ( | BlendStateProvider * | state,
|  | const Colorf & | blend_color,
|  | unsigned int | sample_mask
| ) |  |
| pure virtual

Set active blend state.

void clan::GraphicContext::set_blend_state | ( | const BlendState & | state,
|  | const Colorf & | blend_color = `Colorf::white`,
|  | unsigned int | sample_mask = `0xffffffff`
| ) |  |

Set active blend state.

void clan::ImageImportDescription::set_cached | ( | bool | enable | ) |

Controls if this image can be cached.

(This defaults to true)

virtual void clan::DisplayWindowProvider::set_clipboard_image | ( | const PixelBuffer & | buf | ) |
| pure virtual

Stores an image in the clipboard.

virtual void clan::DisplayWindowProvider::set_clipboard_text | ( | const std::string & | text | ) |
| pure virtual

Stores text in the clipboard.

void clan::Canvas::set_cliprect | ( | const Rectf & | rect | ) |

Set the current clipping rectangle.

void clan::ShaderEffectDescription::set_compute_shader | ( | std::string | code,
|  | ShaderLanguage | language = `shader_glsl`
| ) |  |

void clan::RasterizerStateDescription::set_culled | ( | bool | value | ) |

Enables/disables polygon cull clipping.

void clan::DisplayTarget::set_current | ( |  | ) |

Set this display target to be the current target.

static void clan::Display::set_current_target | ( | const DisplayTarget & | target | ) |
| static

Sets the currently selected display target.

virtual void clan::DisplayWindowProvider::set_cursor | ( | CursorProvider * | cursor | ) |
| pure virtual

Sets the current cursor icon.

virtual void clan::DisplayWindowProvider::set_cursor | ( | StandardCursor | type | ) |
| pure virtual

Sets the current cursor icon.

void clan::ShaderEffectDescription::set_define | ( | std::string | name,
|  | std::string | value = `"1"`
| ) |  |

void clan::DepthStencilStateDescription::set_depth_compare_function | ( | CompareFunction | func | ) |

Set depth test function.

void clan::ShaderEffectDescription::set_depth_data | ( | RenderBuffer | buffer | ) |

void clan::ShaderEffectDescription::set_depth_data | ( | Texture | texture | ) |

virtual void clan::GraphicContextProvider::set_depth_range | ( | float | n,
|  | float | f
| ) |  |
| pure virtual

Specifies the depth range for all viewports.

virtual void clan::GraphicContextProvider::set_depth_range | ( | int | viewport,
|  | float | n,
|  | float | f
| ) |  |
| pure virtual

Specifies the depth range for the specified viewport.

void clan::GraphicContext::set_depth_range | ( | float | n,
|  | float | f
| ) |  |

Specifies the depth range for all viewports.

void clan::GraphicContext::set_depth_range | ( | int | viewport,
|  | float | n,
|  | float | f
| ) |  |

Specifies the depth range for the specified viewport.

void clan::Canvas::set_depth_stencil_state | ( | const DepthStencilState & | state,
|  | int | stencil_ref = `0`
| ) |  |

Set active depth stencil state.

virtual void clan::GraphicContextProvider::set_depth_stencil_state | ( | DepthStencilStateProvider * | state,
|  | int | stencil_ref
| ) |  |
| pure virtual

Set active depth stencil state.

void clan::GraphicContext::set_depth_stencil_state | ( | const DepthStencilState & | state,
|  | int | stencil_ref = `0`
| ) |  |

Set active depth stencil state.

virtual void clan::GraphicContextProvider::set_draw_buffer | ( | DrawBuffer | buffer | ) |
| pure virtual

void clan::GraphicContext::set_draw_buffer | ( | DrawBuffer | buffer | ) |

Set used draw buffer.

void clan::ShaderEffectDescription::set_draw_count | ( | int | count | ) |

void clan::ShaderEffectDescription::set_elements | ( | ElementArrayBuffer & | element_array,
|  | VertexAttributeDataType | indices_type
| ) |  |

Referenced by clan::ShaderEffectDescription::set_elements().

void clan::ShaderEffectDescription::set_elements | ( | ElementArrayVector< unsigned int > & | element_array | ) |
| inline

References clan::ShaderEffectDescription::set_elements(), and clan::type_unsigned_int.

void clan::ShaderEffectDescription::set_elements | ( | ElementArrayVector< unsigned short > & | element_array | ) |
| inline

References clan::ShaderEffectDescription::set_elements(), and clan::type_unsigned_short.

void clan::ShaderEffectDescription::set_elements | ( | ElementArrayVector< unsigned char > & | element_array | ) |
| inline

References clan::ShaderEffectDescription::set_elements(), and clan::type_unsigned_byte.

virtual void clan::DisplayWindowProvider::set_enabled | ( | bool | enable | ) |
| pure virtual

Enables or disables input into this window.

void clan::RasterizerStateDescription::set_face_cull_mode | ( | CullMode | value | ) |

Sets the polygon cull clipping mode.

void clan::RasterizerStateDescription::set_face_fill_mode | ( | FillMode | value | ) |

Sets the filling mode for polygons.

void clan::PixelConverter::set_flip_vertical | ( | bool | enable | ) |

Set the flip vertical setting.

This defaults to off.

void clan::ImageImportDescription::set_flip_vertical | ( | bool | enable | ) |

Set the flip vertical setting.

(This defaults to off)

void clan::PerlinNoise::set_format | ( | TextureFormat | texture_format = `tf_rgb8` | ) |

Set the format of the output pixelbuffer.

If this function is not used, the format defaults to tf_rgb8
These following formats are supported:
tf_rgba8, tf_rgb8, tf_r8, tf_r32f

Parameters

  format | = The specified format

void clan::ShaderEffectDescription::set_frag_data | ( | std::string | name,
|  | RenderBuffer | buffer
| ) |  |

void clan::ShaderEffectDescription::set_frag_data | ( | std::string | name,
|  | Texture | texture
| ) |  |

void clan::ShaderEffectDescription::set_frag_data_to_back_buffer | ( | std::string | name | ) |

void clan::ShaderEffectDescription::set_fragment_shader | ( | std::string | code,
|  | ShaderLanguage | language = `shader_glsl`
| ) |  |

virtual void clan::GraphicContextProvider::set_frame_buffer | ( | const FrameBuffer & | write_buffer,
|  | const FrameBuffer & | read_buffer
| ) |  |
| pure virtual

Set a frame buffer for off-screen rendering.

void clan::GraphicContext::set_frame_buffer | ( | const FrameBuffer & | write_buffer | ) |

Sets the current frame buffer.

void clan::GraphicContext::set_frame_buffer | ( | const FrameBuffer & | write_buffer,
|  | const FrameBuffer & | read_buffer
| ) |  |

void clan::RasterizerStateDescription::set_front_face | ( | FaceSide | value | ) |

Sets which side is the front side of a face.

void clan::PixelConverter::set_gamma | ( | float | gamma | ) |

Set the gamma applied when converting.

This defaults to 1.0 (off).

void clan::ShaderEffectDescription::set_glsl_version | ( | int | version = `330` | ) |

void clan::Texture1DArray::set_image | ( | GraphicContext & | context,
|  | int | array_index,
|  | PixelBuffer & | image,
|  | int | level = `0`
| ) |  |

Upload image to texture.

Parameters

  context | Graphic context to use for the request
  array_index | Index in the array
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::Texture1D::set_image | ( | GraphicContext & | context,
|  | PixelBuffer & | image,
|  | int | level = `0`
| ) |  |

Upload image to texture.

Parameters

  context | Graphic context to use for the request
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::ShaderEffectDescription::set_image | ( | std::string | name,
|  | Resource< Texture > | texture
| ) |  |

void clan::TextureCubeArray::set_image | ( | GraphicContext & | context,
|  | int | array_index,
|  | TextureCubeDirection | cube_direction,
|  | PixelBuffer & | image,
|  | int | level = `0`
| ) |  |

Upload image to texture.

Parameters

  context | Graphic context to use for the request
  array_index | Index in the array
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::PixelBufferSet::set_image | ( | int | slice,
|  | int | level,
|  | const PixelBuffer & | image
| ) |  |

Set the pixel buffer to be used for the specified slice and level.

void clan::TextureCube::set_image | ( | GraphicContext & | context,
|  | TextureCubeDirection | cube_direction,
|  | PixelBuffer & | image,
|  | int | level = `0`
| ) |  |

Upload image to texture.

Parameters

  context | Graphic context to use for the request
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::Texture3D::set_image | ( | GraphicContext & | context,
|  | PixelBuffer & | image,
|  | int | depth,
|  | int | level = `0`
| ) |  |

Upload image to texture.

Parameters

  context | Graphic context to use for the request
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::Texture2DArray::set_image | ( | GraphicContext & | context,
|  | int | array_index,
|  | const PixelBuffer & | image,
|  | int | level = `0`
| ) |  |

Upload image to this texture array.

Parameters

  context | Graphic context to use for the request.
  array_index | Index in the array to upload the image into.
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::Texture2D::set_image | ( | GraphicContext & | context,
|  | const PixelBuffer & | image,
|  | int | level = `0`
| ) |  |

Upload image to this texture.

Parameters

  context | Graphic context to use for the request.
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::PixelBuffer::set_image | ( | const PixelBuffer & | source | ) |

Copy source pixel buffer into this buffer, doing a format conversion if needed.

Parameters

  source | Source pixel buffer.

void clan::PixelBuffer::set_image | ( | const PixelBuffer & | source,
|  | PixelConverter & | converter
| ) |  |

Copy source pixel buffer into this buffer, doing a format conversion if needed.

Parameters

  source | Source pixel buffer.

virtual void clan::GraphicContextProvider::set_image_texture | ( | int | unit_index,
|  | const Texture & | texture
| ) |  |
| pure virtual

Select texture into image unit.

void clan::GraphicContext::set_image_texture | ( | int | unit_index,
|  | const Texture & | texture
| ) |  |

Select texture image into index.

Parameters

  unit_index | = 0 to x, the index of this texture
  texture | = The texture to select. This can be an empty texture Texture()

void clan::GraphicContext::set_image_texture | ( | std::vector< Texture > & | textures | ) |

Select texture images

Only textures units from 0 to textures.size()-1 are set.

Parameters

  textures | = The texture to select (placed at unit_index 0 to texture.size()-1). These may contain null textures

void clan::PixelConverter::set_input_is_ycrcb | ( | bool | enable | ) |

Converts from JPEG JFIF YCrCb.

virtual void clan::DisplayWindowProvider::set_large_icon | ( | const PixelBuffer & | image | ) |
| pure virtual

Sets the large icon used for this window.

virtual void clan::TextureProvider::set_lod_bias | ( | double | lod_bias | ) |
| pure virtual

Sets the level of detail bias constant.

void clan::Texture::set_lod_bias | ( | float | lod_bias | ) |

Sets the level of detail bias constant.

void clan::BlendStateDescription::set_logic_op | ( | LogicOp | op | ) |

Set logic operation. (clanGL only)

virtual void clan::TextureProvider::set_mag_filter | ( | TextureFilter | filter | ) |
| pure virtual

Set the magnification filter.

void clan::Texture::set_mag_filter | ( | TextureFilter | filter | ) |

Set the magnification filter.

void clan::Canvas::set_map_mode | ( | MapMode | mode | ) |

Set the projection mapping mode.

virtual void clan::TextureProvider::set_max_anisotropy | ( | float | v | ) |
| pure virtual

Set the maximum degree of anisotropy.

void clan::Texture::set_max_anisotropy | ( | float | max_anisotropy | ) |

Set the maximum degree of anisotropy.

virtual void clan::TextureProvider::set_max_level | ( | int | max_level | ) |
| pure virtual

Sets the texture max level texture parameter.

void clan::Texture::set_max_level | ( | int | max_level | ) |

Sets the texture max level texture parameter.

virtual void clan::TextureProvider::set_max_lod | ( | double | max_lod | ) |
| pure virtual

Set the maximum level of detail texture parameter.

void clan::Texture::set_max_lod | ( | float | max_lod | ) |

Set the maximum level of detail texture parameter.

virtual void clan::DisplayWindowProvider::set_maximum_size | ( | int | width,
|  | int | height,
|  | bool | client_area
| ) |  |
| pure virtual

Sets the maximum size allowed for this window when resizing.

Parameters

  width | Maximum width of the window.
  height | Maximum height of the window.
  client_area | Size includes the entire window frame?

virtual void clan::TextureProvider::set_min_filter | ( | TextureFilter | filter | ) |
| pure virtual

Set the minification filter.

void clan::Texture::set_min_filter | ( | TextureFilter | filter | ) |

Set the minification filter.

virtual void clan::TextureProvider::set_min_lod | ( | double | min_lod | ) |
| pure virtual

Set the minimum level of detail texture parameter.

void clan::Texture::set_min_lod | ( | float | min_lod | ) |

Set the minimum level of detail texture parameter.

virtual void clan::DisplayWindowProvider::set_minimum_size | ( | int | width,
|  | int | height,
|  | bool | client_area
| ) |  |
| pure virtual

Sets the minimum size allowed for this window when resizing.

Parameters

  width | Minimum width of the window.
  height | Minimum height of the window.
  client_area | Size includes the entire window frame?

void clan::PerlinNoise::set_octaves | ( | int | octaves = `1` | ) |

Set the number of octaves of the perlin noise.

If this function is not used, the octaves count defaults to 1

Parameters

  octaves | = The number of octaves to set

void clan::PixelConverter::set_output_is_ycrcb | ( | bool | enable | ) |

Converts to JPEG JFIF YCrCb.

void clan::PerlinNoise::set_permutations | ( | const unsigned char * | table,
|  | unsigned int | size = `256`
| ) |  |

Set the permutation table.

If this function is not used, this class uses rand() to create a permutation table instead

Parameters

  table | = The permutation table
  size | = The permutation table size (2,4,8,16,32,64,128,256). Usually 256 (the maximum) unless a lower periodic table is required

void clan::Texture2DArray::set_pixel_ratio | ( | float | ratio | ) |

Sets the display pixel ratio for this texture.

void clan::Texture2D::set_pixel_ratio | ( | float | ratio | ) |

Sets the display pixel ratio for this texture.

virtual void clan::DisplayWindowProvider::set_pixel_ratio | ( | float | ratio | ) |
| pure virtual

Sets the display pixel ratio of this window.

Parameters

  ratio | The new display pixel ratio to use on this window.

void clan::PixelBuffer::set_pixel_ratio | ( | float | ratio | ) |

Sets the display pixel ratio for this texture.

void clan::RasterizerStateDescription::set_point_fade_treshold_size | ( | float |  | ) |

Alpha fade point once minimum size treshold reached. Requires multisampling to be enabled. (clanGL only)

void clan::RasterizerStateDescription::set_point_size | ( | float |  | ) |

The default value is 1.0 (clanGL only)

void clan::RasterizerStateDescription::set_point_sprite_origin | ( | PointSpriteOrigin | origin | ) |

Sets the origin of texture point sprites. (clanGL only)

void clan::RasterizerStateDescription::set_polygon_offset | ( | float | factor,
|  | float | units
| ) |  |

Sets the offset factor.

virtual void clan::DisplayWindowProvider::set_position | ( | const Rect & | pos,
|  | bool | client_area
| ) |  |
| pure virtual

Sets the position and size of this window on the screen.

void clan::PixelConverter::set_premultiply_alpha | ( | bool | enable | ) |

Set the premultiply alpha setting.

This defaults to off.

void clan::ImageImportDescription::set_premultiply_alpha | ( | bool | enable | ) |

Set the premultiply alpha setting.

(This defaults to off)

virtual void clan::GraphicContextProvider::set_primitives_array | ( | const PrimitivesArray & | primitives_array | ) |
| pure virtual

Set the primitives array on the gc.

void clan::GraphicContext::set_primitives_array | ( | const PrimitivesArray & | array | ) |

Set the primitives array on the gc.

virtual void clan::GraphicContextProvider::set_primitives_elements | ( | ElementArrayBufferProvider * | array_provider | ) |
| pure virtual

Sets current elements array buffer.

void clan::GraphicContext::set_primitives_elements | ( | ElementArrayBuffer & | element_array | ) |

Sets current elements array buffer.

Referenced by clan::GraphicContext::set_primitives_elements().

template<typename Type >

void clan::GraphicContext::set_primitives_elements | ( | ElementArrayVector< Type > & | element_array | ) |
| inline

Sets current elements array buffer.

References clan::GraphicContext::set_primitives_elements().

void clan::Canvas::set_program_object | ( | StandardProgram | standard_program | ) |

Set active program object to the standard program specified.

virtual void clan::GraphicContextProvider::set_program_object | ( | StandardProgram | standard_program | ) |
| pure virtual

Set active program object to the standard program specified.

virtual void clan::GraphicContextProvider::set_program_object | ( | const ProgramObject & | program | ) |
| pure virtual

Set active program object.

Parameters

  program | = Program to set

void clan::GraphicContext::set_program_object | ( | StandardProgram | standard_program | ) |

Set active program object to the standard program specified.

void clan::GraphicContext::set_program_object | ( | const ProgramObject & | program | ) |

Set active program object.

Parameters

  program | = Program to set

void clan::Canvas::set_projection | ( | const Mat4f & | matrix | ) |

Set the projection matrix to be used in user projection map mode.

void clan::Canvas::set_rasterizer_state | ( | const RasterizerState & | state | ) |

Set active rasterizer state.

virtual void clan::GraphicContextProvider::set_rasterizer_state | ( | RasterizerStateProvider * | state | ) |
| pure virtual

Set active rasterizer state.

void clan::GraphicContext::set_rasterizer_state | ( | const RasterizerState & | state | ) |

Set active rasterizer state.

virtual void clan::GraphicContextProvider::set_scissor | ( | const Rect & | rect | ) |
| pure virtual

Set scissor.

void clan::GraphicContext::set_scissor | ( | const Rect & | rect,
|  | TextureImageYAxis | y_axis
| ) |  |

Set the current clipping rectangle.

void clan::PerlinNoise::set_size | ( | int | width = `256`,
|  | int | height = `256`
| ) |  |

Set the size of the output pixelbuffer.

If this function is not used, the size defaults to 256x256

Parameters

  width | = Output pixelbuffer width
  height | = Output pixelbuffer height

void clan::PerlinNoise::set_size | ( | const Size & | size | ) |

Set the size of the output pixelbuffer.

If this function is not used, the size defaults to 256x256

Parameters

  width | = Output pixelbuffer width
  height | = Output pixelbuffer height

virtual void clan::DisplayWindowProvider::set_size | ( | int | width,
|  | int | height,
|  | bool | client_area
| ) |  |
| pure virtual

Sets the size of this window.

Parameters

  width | Minimum width of the window.
  height | Minimum height of the window.
  client_area | Size includes the entire window frame?

virtual void clan::DisplayWindowProvider::set_small_icon | ( | const PixelBuffer & | image | ) |
| pure virtual

Sets the small icon used for this window.

void clan::ImageImportDescription::set_srgb | ( | bool | enable | ) |

Controls if the image is uploaded as a sRGB texture or not.

(This defaults to off)

void clan::DepthStencilStateDescription::set_stencil_compare_back | ( | CompareFunction | back,
|  | int | back_ref,
|  | int | back_mask
| ) |  |

Set stencil compare function.

void clan::DepthStencilStateDescription::set_stencil_compare_front | ( | CompareFunction | front,
|  | int | front_ref,
|  | int | front_mask
| ) |  |

Set stencil compare function.

void clan::ShaderEffectDescription::set_stencil_data | ( | RenderBuffer | buffer | ) |

void clan::ShaderEffectDescription::set_stencil_data | ( | Texture | texture | ) |

void clan::DepthStencilStateDescription::set_stencil_op_back | ( | StencilOp | fail_back,
|  | StencilOp | pass_depth_fail_back,
|  | StencilOp | pass_depth_pass_back
| ) |  |

Set stencil operations.

Set stencil failed test operations. Set stencil passed test operations. Set stencil passed depth test but failed stencil test operations.

void clan::DepthStencilStateDescription::set_stencil_op_front | ( | StencilOp | fail_front,
|  | StencilOp | pass_depth_fail_front,
|  | StencilOp | pass_depth_pass_front
| ) |  |

Set stencil operations.

Set stencil failed test operations. Set stencil passed test operations. Set stencil passed depth test but failed stencil test operations.

void clan::DepthStencilStateDescription::set_stencil_write_mask | ( | unsigned char | front_facing_mask,
|  | unsigned char | back_facing_mask
| ) |  |

Set stencil write masks.

void clan::ShaderEffectDescription::set_storage | ( | std::string | name,
|  | Resource< StorageBuffer > | values
| ) |  |

virtual void clan::GraphicContextProvider::set_storage_buffer | ( | int | index,
|  | const StorageBuffer & | buffer
| ) |  |
| pure virtual

Select storage buffer into index.

void clan::GraphicContext::set_storage_buffer | ( | int | index,
|  | const StorageBuffer & | buffer
| ) |  |

Select storage buffer into index.

virtual void clan::ProgramObjectProvider::set_storage_buffer_index | ( | int | buffer_index,
|  | int | bind_unit_index
| ) |  |
| pure virtual

void clan::ProgramObject::set_storage_buffer_index | ( | const std::string & | block_name,
|  | int | bind_index
| ) |  |

Sets the UniformBuffer.

void clan::ProgramObject::set_storage_buffer_index | ( | int | block_index,
|  | int | bind_index
| ) |  |

Sets the UniformBuffer.

void clan::Texture1D::set_subimage | ( | GraphicContext & | context,
|  | int | x,
|  | const PixelBuffer & | image,
|  | const int | src_x,
|  | const int | src_width,
|  | int | level = `0`
| ) |  |

Upload image to sub texture.

Parameters

  context | Graphic context to use for the request
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::Texture1DArray::set_subimage | ( | GraphicContext & | context,
|  | int | array_index,
|  | int | x,
|  | const PixelBuffer & | image,
|  | const int | src_x,
|  | const int | src_width,
|  | int | level = `0`
| ) |  |

Upload image to sub texture.

Parameters

  context | Graphic context to use for the request
  array_index | Index in the array
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::TextureCubeArray::set_subimage | ( | GraphicContext & | context,
|  | int | array_index,
|  | TextureCubeDirection | cube_direction,
|  | int | x,
|  | int | y,
|  | const PixelBuffer & | image,
|  | const Rect & | src_rect,
|  | int | level = `0`
| ) |  |

Upload image to sub texture.

Parameters

  context | Graphic context to use for the request
  array_index | Index in the array
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::TextureCube::set_subimage | ( | GraphicContext & | context,
|  | TextureCubeDirection | cube_direction,
|  | int | x,
|  | int | y,
|  | const PixelBuffer & | image,
|  | const Rect & | src_rect,
|  | int | level = `0`
| ) |  |

Upload image to sub texture.

Parameters

  context | Graphic context to use for the request
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::Texture3D::set_subimage | ( | GraphicContext & | context,
|  | int | x,
|  | int | y,
|  | int | z,
|  | const PixelBuffer & | image,
|  | const Rect & | src_rect,
|  | int | level = `0`
| ) |  |

Upload image to sub texture.

Parameters

  context | Graphic context to use for the request
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::TextureCubeArray::set_subimage | ( | GraphicContext & | context,
|  | int | array_index,
|  | TextureCubeDirection | cube_direction,
|  | const Point & | point,
|  | const PixelBuffer & | image,
|  | const Rect & | src_rect,
|  | int | level = `0`
| ) |  |

void clan::TextureCube::set_subimage | ( | GraphicContext & | context,
|  | TextureCubeDirection | cube_direction,
|  | const Point & | point,
|  | const PixelBuffer & | image,
|  | const Rect & | src_rect,
|  | int | level = `0`
| ) |  |

void clan::Texture2DArray::set_subimage | ( | GraphicContext & | context,
|  | int | array_index,
|  | int | x,
|  | int | y,
|  | const PixelBuffer & | image,
|  | const Rect & | src_rect,
|  | int | level = `0`
| ) |  |

Upload image to sub-texture.

Parameters

  context | Graphic context to use for the request.
  array_index | Index in the array to upload the image into.
  x | The horizontal point in the selected texture to write the new sub-texture image onto.
  y | The vertical point in the selected texture to write the sub-texture image onto.
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::Texture2D::set_subimage | ( | GraphicContext & | context,
|  | int | x,
|  | int | y,
|  | const PixelBuffer & | image,
|  | const Rect & | src_rect,
|  | int | level = `0`
| ) |  |

Upload image to sub-texture.

Parameters

  context | Graphic context to use for the request.
  x | The horizontal point in the texture to write the new sub-texture image onto.
  y | The vertical point in the texture to write the new sub-texture image onto.
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::Texture2DArray::set_subimage | ( | GraphicContext & | context,
|  | int | array_index,
|  | const Point & | point,
|  | const PixelBuffer & | image,
|  | const Rect & | src_rect,
|  | int | level = `0`
| ) |  |

Upload image to sub-texture.

Parameters

  context | Graphic context to use for the request.
  array_index | Index in the array to upload the image into.
  point | Point in the selected texture to write the new sub-texture image onto.
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::Texture2D::set_subimage | ( | GraphicContext & | context,
|  | const Point & | point,
|  | const PixelBuffer & | image,
|  | const Rect & | src_rect,
|  | int | level = `0`
| ) |  |

Upload image to sub-texture.

Parameters

  context | Graphic context to use for the request.
  point | Point in the texture to write the new sub-texture image. onto.
  image | Image to upload.
  level | Mipmap level-of-detail number.

void clan::PixelBuffer::set_subimage | ( | const PixelBuffer & | source,
|  | const Point & | dest_pos,
|  | const Rect & | src_rect
| ) |  |

Copy source pixel buffer into this buffer, doing a format conversion if needed.

Parameters

  source | Source pixel buffer.
  dest_rect | Destination position for copy.
  src_rect | Source rectangle for copy.

void clan::PixelBuffer::set_subimage | ( | const PixelBuffer & | source,
|  | const Point & | dest_pos,
|  | const Rect & | src_rect,
|  | PixelConverter & | converter
| ) |  |

Copy source pixel buffer into this buffer, doing a format conversion if needed.

Parameters

  source | Source pixel buffer.
  dest_rect | Destination position for copy.
  src_rect | Source rectangle for copy.

void clan::PixelConverter::set_swizzle | ( | int | red_source,
|  | int | green_source,
|  | int | blue_source,
|  | int | alpha_source
| ) |  |

Set the input channel used for each output channel.

Values 0-3 accepted. 0 = red, 1 = green, 2 = blue, 3 = alpha.

void clan::PixelConverter::set_swizzle | ( | const Vec4i & | swizzle | ) |

void clan::ShaderEffectDescription::set_texture | ( | std::string | name,
|  | Resource< Texture > | texture
| ) |  |

virtual void clan::GraphicContextProvider::set_texture | ( | int | unit_index,
|  | const Texture & | texture
| ) |  |
| pure virtual

Select texture into unit.

void clan::GraphicContext::set_texture | ( | int | unit_index,
|  | const Texture & | texture
| ) |  |

Select texture into index.

Parameters

  unit_index | = 0 to x, the index of this texture
  texture | = The texture to select. This can be an empty texture Texture()

virtual void clan::TextureProvider::set_texture_compare | ( | TextureCompareMode | mode,
|  | CompareFunction | func
| ) |  |
| pure virtual

Sets the texture compare mode and compare function texture parameters.

void clan::Texture::set_texture_compare | ( | TextureCompareMode | mode,
|  | CompareFunction | func
| ) |  |

Sets the texture compare mode and compare function texture parameters.

void clan::GraphicContext::set_textures | ( | std::vector< Texture > & | textures | ) |

Select textures

Only textures units from 0 to textures.size()-1 are set.

Parameters

  textures | = The texture to select (placed at unit_index 0 to texture.size()-1). These may contain null textures

virtual void clan::DisplayWindowProvider::set_title | ( | const std::string & | new_title | ) |
| pure virtual

Change window title.

void clan::Canvas::set_transform | ( | const Mat4f & | matrix | ) |

Sets the transform matrix to a new matrix.

virtual void clan::ProgramObjectProvider::set_uniform1f | ( | int | location,
|  | float | value_a
| ) |  |
| pure virtual

void clan::ProgramObject::set_uniform1f | ( | int | location,
|  | float | value_a
| ) |  |

void clan::ProgramObject::set_uniform1f | ( | const std::string & | name,
|  | float | value_a
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform1f().

Referenced by clan::ProgramObject::set_uniform1f().

virtual void clan::ProgramObjectProvider::set_uniform1i | ( | int | location,
|  | int | value_a
| ) |  |
| pure virtual

Set uniform variable(s).

void clan::ProgramObject::set_uniform1i | ( | int | location,
|  | int | value_a
| ) |  |

void clan::ProgramObject::set_uniform1i | ( | const std::string & | name,
|  | int | value_a
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform1i().

Referenced by clan::ProgramObject::set_uniform1i().

void clan::ProgramObject::set_uniform2b | ( | int | location,
|  | const Vec2b & | vec
| ) |  |
| inline

References clan::ProgramObject::set_uniform2i(), clan::Vec2< Type >::x, and clan::Vec2< Type >::y.

void clan::ProgramObject::set_uniform2b | ( | const std::string & | name,
|  | const Vec2b & | vec
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform2b().

Referenced by clan::ProgramObject::set_uniform2b().

virtual void clan::ProgramObjectProvider::set_uniform2f | ( | int | location,
|  | float | value_a,
|  | float | value_b
| ) |  |
| pure virtual

void clan::ProgramObject::set_uniform2f | ( | int | location,
|  | float | value_a,
|  | float | value_b
| ) |  |

void clan::ProgramObject::set_uniform2f | ( | int | location,
|  | const Vec2f & | vec
| ) |  |
| inline

References clan::ProgramObject::set_uniform2f(), clan::Vec2< Type >::x, and clan::Vec2< Type >::y.

Referenced by clan::ProgramObject::set_uniform2f().

void clan::ProgramObject::set_uniform2f | ( | const std::string & | name,
|  | float | value_a,
|  | float | value_b
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform2f().

Referenced by clan::ProgramObject::set_uniform2f().

void clan::ProgramObject::set_uniform2f | ( | const std::string & | name,
|  | const Vec2f & | vec
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform2f().

Referenced by clan::ProgramObject::set_uniform2f().

virtual void clan::ProgramObjectProvider::set_uniform2i | ( | int | location,
|  | int | value_a,
|  | int | value_b
| ) |  |
| pure virtual

void clan::ProgramObject::set_uniform2i | ( | int | location,
|  | int | value_a,
|  | int | value_b
| ) |  |

Referenced by clan::ProgramObject::set_uniform2b(), and clan::ProgramObject::set_uniform2s().

void clan::ProgramObject::set_uniform2i | ( | int | location,
|  | const Vec2i & | vec
| ) |  |
| inline

References clan::ProgramObject::set_uniform2i(), clan::Vec2< Type >::x, and clan::Vec2< Type >::y.

Referenced by clan::ProgramObject::set_uniform2i().

void clan::ProgramObject::set_uniform2i | ( | const std::string & | name,
|  | int | value_a,
|  | int | value_b
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform2i().

Referenced by clan::ProgramObject::set_uniform2i().

void clan::ProgramObject::set_uniform2i | ( | const std::string & | name,
|  | const Vec2i & | vec
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform2i().

Referenced by clan::ProgramObject::set_uniform2i().

void clan::ProgramObject::set_uniform2s | ( | int | location,
|  | const Vec2s & | vec
| ) |  |
| inline

References clan::ProgramObject::set_uniform2i(), clan::Vec2< Type >::x, and clan::Vec2< Type >::y.

void clan::ProgramObject::set_uniform2s | ( | const std::string & | name,
|  | const Vec2s & | vec
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform2s().

Referenced by clan::ProgramObject::set_uniform2s().

void clan::ProgramObject::set_uniform3b | ( | int | location,
|  | const Vec3b & | vec
| ) |  |
| inline

References clan::ProgramObject::set_uniform3i(), clan::Vec3< Type >::x, clan::Vec3< Type >::y, and clan::Vec3< Type >::z.

void clan::ProgramObject::set_uniform3b | ( | const std::string & | name,
|  | const Vec3b & | vec
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform3b().

Referenced by clan::ProgramObject::set_uniform3b().

virtual void clan::ProgramObjectProvider::set_uniform3f | ( | int | location,
|  | float | value_a,
|  | float | value_b,
|  | float | value_c
| ) |  |
| pure virtual

void clan::ProgramObject::set_uniform3f | ( | int | location,
|  | float | value_a,
|  | float | value_b,
|  | float | value_c
| ) |  |

void clan::ProgramObject::set_uniform3f | ( | int | location,
|  | const Vec3f & | vec
| ) |  |
| inline

References clan::ProgramObject::set_uniform3f(), clan::Vec3< Type >::x, clan::Vec3< Type >::y, and clan::Vec3< Type >::z.

Referenced by clan::ProgramObject::set_uniform3f().

void clan::ProgramObject::set_uniform3f | ( | const std::string & | name,
|  | float | value_a,
|  | float | value_b,
|  | float | value_c
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform3f().

Referenced by clan::ProgramObject::set_uniform3f().

void clan::ProgramObject::set_uniform3f | ( | const std::string & | name,
|  | const Vec3f & | vec
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform3f().

Referenced by clan::ProgramObject::set_uniform3f().

virtual void clan::ProgramObjectProvider::set_uniform3i | ( | int | location,
|  | int | value_a,
|  | int | value_b,
|  | int | value_c
| ) |  |
| pure virtual

void clan::ProgramObject::set_uniform3i | ( | int | location,
|  | int | value_a,
|  | int | value_b,
|  | int | value_c
| ) |  |

Referenced by clan::ProgramObject::set_uniform3b(), and clan::ProgramObject::set_uniform3s().

void clan::ProgramObject::set_uniform3i | ( | int | location,
|  | const Vec3i & | vec
| ) |  |
| inline

References clan::ProgramObject::set_uniform3i(), clan::Vec3< Type >::x, clan::Vec3< Type >::y, and clan::Vec3< Type >::z.

Referenced by clan::ProgramObject::set_uniform3i().

void clan::ProgramObject::set_uniform3i | ( | const std::string & | name,
|  | int | value_a,
|  | int | value_b,
|  | int | value_c
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform3i().

Referenced by clan::ProgramObject::set_uniform3i().

void clan::ProgramObject::set_uniform3i | ( | const std::string & | name,
|  | const Vec3i & | vec
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform3i().

Referenced by clan::ProgramObject::set_uniform3i().

void clan::ProgramObject::set_uniform3s | ( | int | location,
|  | const Vec3s & | vec
| ) |  |
| inline

References clan::ProgramObject::set_uniform3i(), clan::Vec3< Type >::x, clan::Vec3< Type >::y, and clan::Vec3< Type >::z.

void clan::ProgramObject::set_uniform3s | ( | const std::string & | name,
|  | const Vec3s & | vec
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform3s().

Referenced by clan::ProgramObject::set_uniform3s().

void clan::ProgramObject::set_uniform4b | ( | int | location,
|  | const Vec4b & | vec
| ) |  |
| inline

References clan::ProgramObject::set_uniform4i(), clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

void clan::ProgramObject::set_uniform4b | ( | const std::string & | name,
|  | const Vec4b & | vec
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform4b().

Referenced by clan::ProgramObject::set_uniform4b().

virtual void clan::ProgramObjectProvider::set_uniform4f | ( | int | location,
|  | float | value_a,
|  | float | value_b,
|  | float | value_c,
|  | float | value_d
| ) |  |
| pure virtual

void clan::ProgramObject::set_uniform4f | ( | int | location,
|  | float | value_a,
|  | float | value_b,
|  | float | value_c,
|  | float | value_d
| ) |  |

void clan::ProgramObject::set_uniform4f | ( | int | location,
|  | const Vec4f & | vec
| ) |  |
| inline

References clan::ProgramObject::set_uniform4f(), clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

Referenced by clan::ProgramObject::set_uniform4f().

void clan::ProgramObject::set_uniform4f | ( | const std::string & | name,
|  | float | value_a,
|  | float | value_b,
|  | float | value_c,
|  | float | value_d
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform4f().

Referenced by clan::ProgramObject::set_uniform4f().

void clan::ProgramObject::set_uniform4f | ( | const std::string & | name,
|  | const Vec4f & | vec
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform4f().

Referenced by clan::ProgramObject::set_uniform4f().

virtual void clan::ProgramObjectProvider::set_uniform4i | ( | int | location,
|  | int | value_a,
|  | int | value_b,
|  | int | value_c,
|  | int | value_d
| ) |  |
| pure virtual

void clan::ProgramObject::set_uniform4i | ( | int | location,
|  | int | value_a,
|  | int | value_b,
|  | int | value_c,
|  | int | value_d
| ) |  |

Referenced by clan::ProgramObject::set_uniform4b(), and clan::ProgramObject::set_uniform4s().

void clan::ProgramObject::set_uniform4i | ( | int | location,
|  | const Vec4i & | vec
| ) |  |
| inline

References clan::ProgramObject::set_uniform4i(), clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

Referenced by clan::ProgramObject::set_uniform4i().

void clan::ProgramObject::set_uniform4i | ( | const std::string & | name,
|  | int | value_a,
|  | int | value_b,
|  | int | value_c,
|  | int | value_d
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform4i().

Referenced by clan::ProgramObject::set_uniform4i().

void clan::ProgramObject::set_uniform4i | ( | const std::string & | name,
|  | const Vec4i & | vec
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform4i().

Referenced by clan::ProgramObject::set_uniform4i().

void clan::ProgramObject::set_uniform4s | ( | int | location,
|  | const Vec4s & | vec
| ) |  |
| inline

References clan::ProgramObject::set_uniform4i(), clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

void clan::ProgramObject::set_uniform4s | ( | const std::string & | name,
|  | const Vec4s & | vec
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform4s().

Referenced by clan::ProgramObject::set_uniform4s().

void clan::ShaderEffectDescription::set_uniform_block | ( | std::string | name,
|  | Resource< UniformBuffer > | values
| ) |  |

virtual void clan::GraphicContextProvider::set_uniform_buffer | ( | int | index,
|  | const UniformBuffer & | buffer
| ) |  |
| pure virtual

Select uniform buffer into index.

void clan::GraphicContext::set_uniform_buffer | ( | int | index,
|  | const UniformBuffer & | buffer
| ) |  |

Select uniform buffer into index.

virtual void clan::ProgramObjectProvider::set_uniform_buffer_index | ( | int | block_index,
|  | int | bind_index
| ) |  |
| pure virtual

void clan::ProgramObject::set_uniform_buffer_index | ( | const std::string & | block_name,
|  | int | bind_index
| ) |  |

Sets the UniformBuffer.

void clan::ProgramObject::set_uniform_buffer_index | ( | int | block_index,
|  | int | bind_index
| ) |  |

Sets the UniformBuffer.

virtual void clan::ProgramObjectProvider::set_uniform_matrix | ( | int | location,
|  | int | size,
|  | int | count,
|  | bool | transpose,
|  | const float * | data
| ) |  |
| pure virtual

void clan::ProgramObject::set_uniform_matrix | ( | int | location,
|  | int | size,
|  | int | count,
|  | bool | transpose,
|  | const float * | data
| ) |  |

void clan::ProgramObject::set_uniform_matrix | ( | int | location,
|  | const Mat2f & | matrix
| ) |  |
| inline

References clan::Mat2< Type >::matrix, and clan::ProgramObject::set_uniform_matrix().

Referenced by clan::ProgramObject::set_uniform_matrix().

void clan::ProgramObject::set_uniform_matrix | ( | int | location,
|  | const Mat3f & | matrix
| ) |  |
| inline

References clan::Mat3< Type >::matrix, and clan::ProgramObject::set_uniform_matrix().

Referenced by clan::ProgramObject::set_uniform_matrix().

void clan::ProgramObject::set_uniform_matrix | ( | int | location,
|  | const Mat4f & | matrix
| ) |  |
| inline

References clan::Mat4< Type >::matrix, and clan::ProgramObject::set_uniform_matrix().

Referenced by clan::ProgramObject::set_uniform_matrix().

void clan::ProgramObject::set_uniform_matrix | ( | int | location,
|  | int | count,
|  | const Mat2f * | matrix
| ) |  |
| inline

References clan::Mat2< Type >::matrix, and clan::ProgramObject::set_uniform_matrix().

Referenced by clan::ProgramObject::set_uniform_matrix().

void clan::ProgramObject::set_uniform_matrix | ( | int | location,
|  | int | count,
|  | const Mat3f * | matrix
| ) |  |
| inline

References clan::Mat3< Type >::matrix, and clan::ProgramObject::set_uniform_matrix().

Referenced by clan::ProgramObject::set_uniform_matrix().

void clan::ProgramObject::set_uniform_matrix | ( | int | location,
|  | int | count,
|  | const Mat4f * | matrix
| ) |  |
| inline

References clan::Mat4< Type >::matrix, and clan::ProgramObject::set_uniform_matrix().

Referenced by clan::ProgramObject::set_uniform_matrix().

void clan::ProgramObject::set_uniform_matrix | ( | const std::string & | name,
|  | int | size,
|  | int | count,
|  | bool | transpose,
|  | const float * | data
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform_matrix().

Referenced by clan::ProgramObject::set_uniform_matrix().

void clan::ProgramObject::set_uniform_matrix | ( | const std::string & | name,
|  | const Mat2f & | matrix
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform_matrix().

Referenced by clan::ProgramObject::set_uniform_matrix().

void clan::ProgramObject::set_uniform_matrix | ( | const std::string & | name,
|  | const Mat3f & | matrix
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform_matrix().

Referenced by clan::ProgramObject::set_uniform_matrix().

void clan::ProgramObject::set_uniform_matrix | ( | const std::string & | name,
|  | const Mat4f & | matrix
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform_matrix().

Referenced by clan::ProgramObject::set_uniform_matrix().

void clan::ProgramObject::set_uniform_matrix | ( | const std::string & | name,
|  | int | count,
|  | const Mat2f * | matrix
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform_matrix().

Referenced by clan::ProgramObject::set_uniform_matrix().

void clan::ProgramObject::set_uniform_matrix | ( | const std::string & | name,
|  | int | count,
|  | const Mat3f * | matrix
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform_matrix().

Referenced by clan::ProgramObject::set_uniform_matrix().

void clan::ProgramObject::set_uniform_matrix | ( | const std::string & | name,
|  | int | count,
|  | const Mat4f * | matrix
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniform_matrix().

Referenced by clan::ProgramObject::set_uniform_matrix().

virtual void clan::ProgramObjectProvider::set_uniformfv | ( | int | location,
|  | int | size,
|  | int | count,
|  | const float * | data
| ) |  |
| pure virtual

void clan::ProgramObject::set_uniformfv | ( | int | location,
|  | int | size,
|  | int | count,
|  | const float * | data
| ) |  |

void clan::ProgramObject::set_uniformfv | ( | int | location,
|  | int | count,
|  | const Vec2f * | data
| ) |  |
| inline

References clan::ProgramObject::set_uniformfv(), and clan::Vec2< Type >::x.

Referenced by clan::ProgramObject::set_uniformfv().

void clan::ProgramObject::set_uniformfv | ( | int | location,
|  | int | count,
|  | const Vec3f * | data
| ) |  |
| inline

References clan::ProgramObject::set_uniformfv(), and clan::Vec3< Type >::x.

Referenced by clan::ProgramObject::set_uniformfv().

void clan::ProgramObject::set_uniformfv | ( | int | location,
|  | int | count,
|  | const Vec4f * | data
| ) |  |
| inline

References clan::ProgramObject::set_uniformfv(), and clan::Vec4< Type >::x.

Referenced by clan::ProgramObject::set_uniformfv().

void clan::ProgramObject::set_uniformfv | ( | const std::string & | name,
|  | int | size,
|  | int | count,
|  | const float * | data
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniformfv().

Referenced by clan::ProgramObject::set_uniformfv().

void clan::ProgramObject::set_uniformfv | ( | const std::string & | name,
|  | int | count,
|  | const Vec2f * | data
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniformfv().

Referenced by clan::ProgramObject::set_uniformfv().

void clan::ProgramObject::set_uniformfv | ( | const std::string & | name,
|  | int | count,
|  | const Vec3f * | data
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniformfv().

Referenced by clan::ProgramObject::set_uniformfv().

void clan::ProgramObject::set_uniformfv | ( | const std::string & | name,
|  | int | count,
|  | const Vec4f * | data
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniformfv().

Referenced by clan::ProgramObject::set_uniformfv().

virtual void clan::ProgramObjectProvider::set_uniformiv | ( | int | location,
|  | int | size,
|  | int | count,
|  | const int * | data
| ) |  |
| pure virtual

void clan::ProgramObject::set_uniformiv | ( | int | location,
|  | int | size,
|  | int | count,
|  | const int * | data
| ) |  |

void clan::ProgramObject::set_uniformiv | ( | int | location,
|  | int | count,
|  | const Vec2i * | data
| ) |  |
| inline

References clan::ProgramObject::set_uniformiv(), and clan::Vec2< Type >::x.

Referenced by clan::ProgramObject::set_uniformiv().

void clan::ProgramObject::set_uniformiv | ( | int | location,
|  | int | count,
|  | const Vec3i * | data
| ) |  |
| inline

References clan::ProgramObject::set_uniformiv(), and clan::Vec3< Type >::x.

Referenced by clan::ProgramObject::set_uniformiv().

void clan::ProgramObject::set_uniformiv | ( | int | location,
|  | int | count,
|  | const Vec4i * | data
| ) |  |
| inline

References clan::ProgramObject::set_uniformiv(), and clan::Vec4< Type >::x.

Referenced by clan::ProgramObject::set_uniformiv().

void clan::ProgramObject::set_uniformiv | ( | const std::string & | name,
|  | int | size,
|  | int | count,
|  | const int * | data
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniformiv().

Referenced by clan::ProgramObject::set_uniformiv().

void clan::ProgramObject::set_uniformiv | ( | const std::string & | name,
|  | int | count,
|  | const Vec2i * | data
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniformiv().

Referenced by clan::ProgramObject::set_uniformiv().

void clan::ProgramObject::set_uniformiv | ( | const std::string & | name,
|  | int | count,
|  | const Vec3i * | data
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniformiv().

Referenced by clan::ProgramObject::set_uniformiv().

void clan::ProgramObject::set_uniformiv | ( | const std::string & | name,
|  | int | count,
|  | const Vec4i * | data
| ) |  |
| inline

References clan::ProgramObject::get_uniform_location(), and clan::ProgramObject::set_uniformiv().

Referenced by clan::ProgramObject::set_uniformiv().

void clan::ShaderEffectDescription::set_vertex_shader | ( | std::string | code,
|  | ShaderLanguage | language = `shader_glsl`
| ) |  |

virtual void clan::GraphicContextProvider::set_viewport | ( | const Rectf & | viewport | ) |
| pure virtual

Set the viewport to be used in user projection map mode.

virtual void clan::GraphicContextProvider::set_viewport | ( | int | index,
|  | const Rectf & | viewport
| ) |  |
| pure virtual

Set the specified viewport to be used in user projection map mode.

void clan::GraphicContext::set_viewport | ( | const Rectf & | viewport | ) |

Set the viewport to be used in user projection map mode.

Parameters

  viewport | = The viewport to set

void clan::GraphicContext::set_viewport | ( | int | index,
|  | const Rectf & | viewport
| ) |  |

Set the specified viewport to be used in user projection map mode.

Parameters

  index | = The viewport index (0 to x)
  viewport | = The viewport to set

void clan::Texture1D::set_wrap_mode | ( | TextureWrapMode | wrap_s | ) |

void clan::Texture1DArray::set_wrap_mode | ( | TextureWrapMode | wrap_s | ) |

virtual void clan::TextureProvider::set_wrap_mode | ( | TextureWrapMode | wrap_s,
|  | TextureWrapMode | wrap_t,
|  | TextureWrapMode | wrap_r
| ) |  |
| pure virtual

Set the texture wrapping mode.

virtual void clan::TextureProvider::set_wrap_mode | ( | TextureWrapMode | wrap_s,
|  | TextureWrapMode | wrap_t
| ) |  |
| pure virtual

void clan::Texture3D::set_wrap_mode | ( | TextureWrapMode | wrap_s,
|  | TextureWrapMode | wrap_t,
|  | TextureWrapMode | wrap_r
| ) |  |

Set the texture wrapping mode.

virtual void clan::TextureProvider::set_wrap_mode | ( | TextureWrapMode | wrap_s | ) |
| pure virtual

void clan::Texture2DArray::set_wrap_mode | ( | TextureWrapMode | wrap_s,
|  | TextureWrapMode | wrap_t
| ) |  |

void clan::Texture2D::set_wrap_mode | ( | TextureWrapMode | wrap_s,
|  | TextureWrapMode | wrap_t
| ) |  |

virtual void clan::DisplayWindowProvider::show | ( | bool | activate | ) |
| pure virtual

Displays the window in its current size and position.

virtual void clan::DisplayWindowProvider::show_system_cursor | ( |  | ) |
| pure virtual

Shows the mouse cursor.

virtual Signal<void(const Size &)>& clan::GraphicContextProvider::sig_window_resized | ( |  | ) |
| pure virtual

Get the window resized signal.

void clan::DisplayTarget::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::PixelBufferSet::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::OcclusionQuery::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::RenderBuffer::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::StorageBuffer::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::TransferBuffer::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::VertexArrayBuffer::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::ElementArrayBuffer::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::UniformBuffer::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::PrimitivesArray::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::FrameBuffer::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::Canvas::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::PixelBuffer::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::Texture::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::ShaderObject::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::ProgramObject::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

void clan::GraphicContext::throw_if_null | ( |  | ) | const

Throw an exception if this object is invalid.

PixelBuffer clan::PixelBuffer::to_cpu | ( | GraphicContext & | gc | ) |

Downloads the pixel buffer to CPU memory.

If the pixel buffer is already in CPU memory the function returns the current pixel buffer.

PixelBuffer clan::PixelBuffer::to_format | ( | TextureFormat | texture_format | ) | const

Converts current buffer to a new pixel format and returns the result.

PixelBuffer clan::PixelBuffer::to_format | ( | TextureFormat | texture_format,
|  | PixelConverter & | converter
| ) |  | const

Converts current buffer to a new pixel format and returns the result.

PixelBuffer clan::PixelBuffer::to_gpu | ( | GraphicContext & | gc | ) |

Uploads the pixel buffer to GPU memory.

If the pixel buffer is already in GPU memory the function returns the current pixel buffer.

Texture1D clan::Texture::to_texture_1d | ( |  | ) | const

Dynamic cast to Texture1D.

Texture1DArray clan::Texture::to_texture_1d_array | ( |  | ) | const

Dynamic cast to Texture1DArray.

Texture2D clan::Texture::to_texture_2d | ( |  | ) | const

Dynamic cast to Texture2D.

Texture2DArray clan::Texture::to_texture_2d_array | ( |  | ) | const

Dynamic cast to Texture2DArray.

Texture3D clan::Texture::to_texture_3d | ( |  | ) | const

Dynamic cast to Texture3D.

TextureCube clan::Texture::to_texture_cube | ( |  | ) | const

Dynamic cast to TextureCube.

TextureCubeArray clan::Texture::to_texture_cube_array | ( |  | ) | const

Dynamic cast to TextureCubeArray.

virtual void clan::TransferBufferProvider::unlock | ( |  | ) |
| pure virtual

Unmaps buffer.

virtual void clan::PixelBufferProvider::unlock | ( |  | ) |
| pure virtual

Unmaps element buffer.

void clan::TransferBuffer::unlock | ( |  | ) |

Unmaps buffer.

template<typename Type >

void clan::PixelBufferLock< Type >::unlock | ( |  | ) |
| inline

Unlock pixel_buffer.

References clan::PixelBuffer::is_null(), and clan::PixelBuffer::unlock().

void clan::PixelBuffer::unlock | ( |  | ) |

Unmaps element buffer.

Referenced by clan::PixelBufferLock< Type >::unlock(), and clan::PixelBufferLock< Type >::~PixelBufferLock().

virtual void clan::DisplayWindowProvider::update | ( | const Rect & | rect | ) |
| pure virtual

Copy a region of the backbuffer to the frontbuffer.

virtual void clan::StorageBufferProvider::upload_data | ( | GraphicContext & | gc,
|  | const void * | data,
|  | int | size
| ) |  |
| pure virtual

Uploads data to storages buffer.

The size specified must match the size of the buffer and is only included to help guard against buffer overruns.

virtual void clan::VertexArrayBufferProvider::upload_data | ( | GraphicContext & | gc,
|  | int | offset,
|  | const void * | data,
|  | int | size
| ) |  |
| pure virtual

Uploads data to vertex array buffer.

virtual void clan::UniformBufferProvider::upload_data | ( | GraphicContext & | gc,
|  | const void * | data,
|  | int | size
| ) |  |
| pure virtual

Uploads data to uniforms buffer.

The size specified must match the size of the buffer and is only included to help guard against buffer overruns.

virtual void clan::ElementArrayBufferProvider::upload_data | ( | GraphicContext & | gc,
|  | const void * | data,
|  | int | size
| ) |  |
| pure virtual

Uploads data to element array buffer.

The size specified must match the size of the buffer and is only included to help guard against buffer overruns.

virtual void clan::TransferBufferProvider::upload_data | ( | GraphicContext & | gc,
|  | int | offset,
|  | const void * | data,
|  | int | size
| ) |  |
| pure virtual

Uploads data to buffer.

template<typename Type>

void clan::ElementArrayVector< Type >::upload_data | ( | GraphicContext & | gc,
|  | const Type * | data,
|  | int | size
| ) |  |
| inline

Uploads data to element array buffer.

The size specified must match the size of the buffer and is only included to help guard against buffer overruns.

References clan::ElementArrayBuffer::upload_data().

template<typename Type >

void clan::StorageVector< Type >::upload_data | ( | GraphicContext & | gc,
|  | const Type * | data,
|  | int | size
| ) |  |
| inline

Uploads data to storage buffer.

The size specified must match the size of the buffer and is only included to help guard against buffer overruns.

References clan::StorageBuffer::upload_data().

template<typename Type >

void clan::UniformVector< Type >::upload_data | ( | GraphicContext & | gc,
|  | const Type * | data,
|  | int | size
| ) |  |
| inline

Uploads data to uniforms buffer.

The size specified must match the size of the buffer and is only included to help guard against buffer overruns.

References clan::UniformBuffer::upload_data().

virtual void clan::PixelBufferProvider::upload_data | ( | GraphicContext & | gc,
|  | const Rect & | dest_rect,
|  | const void * | data
| ) |  |
| pure virtual

Uploads data to buffer.

void clan::VertexArrayBuffer::upload_data | ( | GraphicContext & | gc,
|  | int | offset,
|  | const void * | data,
|  | int | size
| ) |  |

Uploads data to vertex array buffer.

Referenced by clan::VertexArrayVector< Type >::upload_data().

template<typename Type>

void clan::VertexArrayVector< Type >::upload_data | ( | GraphicContext & | gc,
|  | int | offset,
|  | const Type * | data,
|  | int | size
| ) |  |
| inline

Uploads data to vertex array buffer.

References clan::VertexArrayBuffer::upload_data().

void clan::StorageBuffer::upload_data | ( | GraphicContext & | gc,
|  | const void * | data,
|  | int | size
| ) |  |

Uploads data to storage buffer.

The size specified must match the size of the buffer and is only included to help guard against buffer overruns.

Referenced by clan::StorageVector< Type >::upload_data().

void clan::ElementArrayBuffer::upload_data | ( | GraphicContext & | gc,
|  | const void * | data,
|  | int | size
| ) |  |

Uploads data to element array buffer.

The size specified must match the size of the buffer and is only included to help guard against buffer overruns.

Referenced by clan::ElementArrayVector< Type >::upload_data().

template<typename Type >

void clan::StorageVector< Type >::upload_data | ( | GraphicContext & | gc,
|  | const std::vector< Type > & | data
| ) |  |
| inline

Uploads data to storage buffer.

References clan::StorageBuffer::upload_data().

template<typename Type>

void clan::ElementArrayVector< Type >::upload_data | ( | GraphicContext & | gc,
|  | const std::vector< Type > & | data
| ) |  |
| inline

Uploads data to element array buffer.

References clan::ElementArrayBuffer::upload_data().

template<typename Type >

void clan::UniformVector< Type >::upload_data | ( | GraphicContext & | gc,
|  | const std::vector< Type > & | data
| ) |  |
| inline

Uploads data to uniforms buffer.

References clan::UniformBuffer::upload_data().

template<typename Type>

void clan::TransferVector< Type >::upload_data | ( | GraphicContext & | gc,
|  | int | offset,
|  | const Type * | data,
|  | int | size
| ) |  |
| inline

Uploads data to transfer buffer.

References clan::TransferBuffer::upload_data().

template<typename Type>

void clan::VertexArrayVector< Type >::upload_data | ( | GraphicContext & | gc,
|  | int | offset,
|  | const std::vector< Type > & | data
| ) |  |
| inline

Uploads data to vertex array buffer.

References clan::VertexArrayBuffer::upload_data().

void clan::UniformBuffer::upload_data | ( | GraphicContext & | gc,
|  | const void * | data,
|  | int | size
| ) |  |

Uploads data to uniforms buffer.

The size specified must match the size of the buffer and is only included to help guard against buffer overruns.

Referenced by clan::UniformVector< Type >::upload_data().

void clan::TransferBuffer::upload_data | ( | GraphicContext & | gc,
|  | int | offset,
|  | const void * | data,
|  | int | size
| ) |  |

Uploads data to transfer buffer.

Referenced by clan::TransferVector< Type >::upload_data().

template<typename Type>

void clan::TransferVector< Type >::upload_data | ( | GraphicContext & | gc,
|  | int | offset,
|  | const std::vector< Type > & | data
| ) |  |
| inline

Uploads data to transfer buffer.

References clan::TransferBuffer::upload_data().

void clan::PixelBuffer::upload_data | ( | GraphicContext & | gc,
|  | const Rect & | dest_rect,
|  | const void * | data
| ) |  |

Uploads data to buffer.

virtual void clan::ProgramObjectProvider::validate | ( |  | ) |
| pure virtual

Validate program.

If the validation fails, get_validate_status() will return false and get_info_log() will return the validation log.

bool clan::ProgramObject::validate | ( |  | ) |

Validate program.

If the validation fails, get_info_log() will return the validation log.

## Variable Documentation

std::function<bool()> clan::DisplayWindowSite::func_minimize_clicked

Minimize button is clicked callback function.

std::function<void(Rectf &)> clan::DisplayWindowSite::func_window_resize

Window resize callback function.

std::shared_ptr<Texture_Impl> clan::Texture::impl
| protected

Referenced by clan::Texture::is_null(), clan::Texture::operator!=(), clan::Texture::operator<(), and clan::Texture::operator==().

const float clan::pixelcenter_constant = 0.375f

Signal<void()> clan::DisplayWindowSite::sig_got_focus

Obtained focus signal.

Signal<void()> clan::DisplayWindowSite::sig_lost_focus

Lost focus signal.

Signal<void(const Rectf &)> clan::DisplayWindowSite::sig_paint

Paint signal.

Signal<void(float, float)> clan::DisplayWindowSite::sig_resize

Resize signal.

Signal<void()> clan::DisplayWindowSite::sig_window_close

Window close signal.

Signal<void()> clan::DisplayWindowSite::sig_window_destroy

Window destroy signal.

Signal<void()> clan::DisplayWindowSite::sig_window_maximized

Window maximized signal.

Signal<void()> clan::DisplayWindowSite::sig_window_minimized

Window minimized signal.

Signal<void()> clan::DisplayWindowSite::sig_window_moved

Window moved signal.

Signal<void()> clan::DisplayWindowSite::sig_window_restored

Window restored signal.

## Friends

friend class DisplayTarget_Impl
| friend

friend class Font_DrawFlat
| friend

friend class Font_DrawScaled
| friend

friend class Font_DrawSubPixel
| friend

friend class Font_Impl
| friend

friend class Image
| friend

friend class OpenGL
| friend

friend class Path
| friend

friend class PixelBuffer_Impl
| friend

friend class ShaderEffect
| friend

friend class Sprite_Impl
| friend

friend class Texture2DArray
| friend