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...
 

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< HalfFloatclan::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< Vec2bclan::PixelBufferLock2b
 
typedef PixelBufferLock< Vec2dclan::PixelBufferLock2d
 
typedef PixelBufferLock< Vec2fclan::PixelBufferLock2f
 
typedef PixelBufferLock< Vec2hfclan::PixelBufferLock2hf
 
typedef PixelBufferLock< Vec2iclan::PixelBufferLock2i
 
typedef PixelBufferLock< Vec2sclan::PixelBufferLock2s
 
typedef PixelBufferLock< Vec2ubclan::PixelBufferLock2ub
 
typedef PixelBufferLock< Vec2uiclan::PixelBufferLock2ui
 
typedef PixelBufferLock< Vec2usclan::PixelBufferLock2us
 
typedef PixelBufferLock< Vec3bclan::PixelBufferLock3b
 
typedef PixelBufferLock< Vec3dclan::PixelBufferLock3d
 
typedef PixelBufferLock< Vec3fclan::PixelBufferLock3f
 
typedef PixelBufferLock< Vec3hfclan::PixelBufferLock3hf
 
typedef PixelBufferLock< Vec3iclan::PixelBufferLock3i
 
typedef PixelBufferLock< Vec3sclan::PixelBufferLock3s
 
typedef PixelBufferLock< Vec3ubclan::PixelBufferLock3ub
 
typedef PixelBufferLock< Vec3uiclan::PixelBufferLock3ui
 
typedef PixelBufferLock< Vec3usclan::PixelBufferLock3us
 
typedef PixelBufferLock< Vec4bclan::PixelBufferLock4b
 
typedef PixelBufferLock< Vec4dclan::PixelBufferLock4d
 
typedef PixelBufferLock< Vec4fclan::PixelBufferLock4f
 
typedef PixelBufferLock< Vec4hfclan::PixelBufferLock4hf
 
typedef PixelBufferLock< Vec4iclan::PixelBufferLock4i
 
typedef PixelBufferLock< Vec4sclan::PixelBufferLock4s
 
typedef PixelBufferLock< Vec4ubclan::PixelBufferLock4ub
 
typedef PixelBufferLock< Vec4uiclan::PixelBufferLock4ui
 
typedef PixelBufferLock< Vec4usclan::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 GraphicContextProviderclan::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...
 
GraphicContextclan::Canvas::get_gc () const
 Get gc. More...
 
const Mat4fclan::Canvas::get_transform () const
 Returns the current effective transform matrix. More...
 
Mat4fclan::Canvas::get_inverse_transform ()
 Returns the inverse of the current effective transform matrix. More...
 
const Mat4fclan::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

DisplayTargetProviderclan::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< PixelBufferclan::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...
 
PixelBufferProviderclan::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...
 
BlendStateProviderclan::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...
 
DepthStencilStateProviderclan::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...
 
ElementArrayBufferProviderclan::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...
 
FrameBufferProviderclan::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< Textureclan::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
 
GraphicContextProviderclan::GraphicContext::get_provider ()
 Returns the provider for this graphic context. More...
 
const GraphicContextProviderclan::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...
 
OcclusionQueryProviderclan::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...
 
PrimitivesArrayProviderclan::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...
 
ProgramObjectProviderclan::ProgramObject::get_provider () const
 Retrieves the provider. More...
 
unsigned int clan::ProgramObject::get_handle () const
 Returns the OpenGL program object handle. More...
 
std::vector< ShaderObjectclan::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...
 
RasterizerStateProviderclan::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 Sizeclan::RenderBuffer::get_size () const
 Returns the render buffer size. More...
 
RenderBufferProviderclan::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...
 
ShaderObjectProviderclan::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...
 
StorageBufferProviderclan::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< Textureclan::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...
 
TextureProviderclan::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...
 
TransferBufferProviderclan::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...
 
UniformBufferProviderclan::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...
 
VertexArrayBufferProviderclan::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< Rectfclan::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)
 
RasterizerStateDescriptionclan::ShaderEffectDescription::rasterizer ()
 
BlendStateDescriptionclan::ShaderEffectDescription::blend ()
 
DepthStencilStateDescriptionclan::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 DisplayWindowProviderclan::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 GraphicContextclan::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 CursorProviderclan::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 TextureProviderclan::GraphicContextProvider::alloc_texture (TextureDimensions texture_dimensions)=0
 Allocate texture provider for this gc. More...
 
virtual OcclusionQueryProviderclan::GraphicContextProvider::alloc_occlusion_query ()=0
 Allocate occlusion query provider of this gc. More...
 
virtual ProgramObjectProviderclan::GraphicContextProvider::alloc_program_object ()=0
 Allocate program object provider of this gc. More...
 
virtual ShaderObjectProviderclan::GraphicContextProvider::alloc_shader_object ()=0
 Allocate shader object provider of this gc. More...
 
virtual FrameBufferProviderclan::GraphicContextProvider::alloc_frame_buffer ()=0
 Allocate frame buffer provider for this gc. More...
 
virtual RenderBufferProviderclan::GraphicContextProvider::alloc_render_buffer ()=0
 Allocate render buffer provider for this gc. More...
 
virtual VertexArrayBufferProviderclan::GraphicContextProvider::alloc_vertex_array_buffer ()=0
 Allocate vertex array buffer provider for this gc. More...
 
virtual UniformBufferProviderclan::GraphicContextProvider::alloc_uniform_buffer ()=0
 Allocate uniform buffer provider for this gc. More...
 
virtual StorageBufferProviderclan::GraphicContextProvider::alloc_storage_buffer ()=0
 Allocate storage buffer provider for this gc. More...
 
virtual ElementArrayBufferProviderclan::GraphicContextProvider::alloc_element_array_buffer ()=0
 Allocate element array buffer provider for this gc. More...
 
virtual TransferBufferProviderclan::GraphicContextProvider::alloc_transfer_buffer ()=0
 Allocate transfer buffer provider for this gc. More...
 
virtual PixelBufferProviderclan::GraphicContextProvider::alloc_pixel_buffer ()=0
 Allocate pixel buffer provider for this gc. More...
 
virtual PrimitivesArrayProviderclan::GraphicContextProvider::alloc_primitives_array ()=0
 Allocate primitives array provider for this gc. More...
 
virtual std::shared_ptr< RasterizerStateProviderclan::GraphicContextProvider::create_rasterizer_state (const RasterizerStateDescription &desc)=0
 Retrieve rasterizer state object. More...
 
virtual std::shared_ptr< BlendStateProviderclan::GraphicContextProvider::create_blend_state (const BlendStateDescription &desc)=0
 Retrieve blend state object. More...
 
virtual std::shared_ptr< DepthStencilStateProviderclan::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< ShaderObjectclan::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 TextureProviderclan::TextureProvider::create_view (TextureDimensions texture_dimensions, TextureFormat texture_format, int min_level, int num_levels, int min_layer, int num_layers)=0
 \breif 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

◆ cl_offsetof

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

Typedef Documentation

◆ PixelBufferLock1b

◆ PixelBufferLock1d

◆ PixelBufferLock1f

◆ PixelBufferLock1hf

◆ PixelBufferLock1i

◆ PixelBufferLock1s

◆ PixelBufferLock1ub

typedef PixelBufferLock<unsigned char> clan::PixelBufferLock1ub

◆ PixelBufferLock1ui

◆ PixelBufferLock1us

typedef PixelBufferLock<unsigned short> clan::PixelBufferLock1us

◆ PixelBufferLock2b

◆ PixelBufferLock2d

◆ PixelBufferLock2f

◆ PixelBufferLock2hf

◆ PixelBufferLock2i

◆ PixelBufferLock2s

◆ PixelBufferLock2ub

◆ PixelBufferLock2ui

◆ PixelBufferLock2us

◆ PixelBufferLock3b

◆ PixelBufferLock3d

◆ PixelBufferLock3f

◆ PixelBufferLock3hf

◆ PixelBufferLock3i

◆ PixelBufferLock3s

◆ PixelBufferLock3ub

◆ PixelBufferLock3ui

◆ PixelBufferLock3us

◆ PixelBufferLock4b

◆ PixelBufferLock4d

◆ PixelBufferLock4f

◆ PixelBufferLock4hf

◆ PixelBufferLock4i

◆ PixelBufferLock4s

◆ PixelBufferLock4ub

◆ PixelBufferLock4ui

◆ PixelBufferLock4us

◆ PixelBufferLockAny

typedef PixelBufferLock<unsigned char> clan::PixelBufferLockAny

Enumeration Type Documentation

◆ BlendEquation

Blending equations.

Enumerator
equation_add 
equation_subtract 
equation_reverse_subtract 
equation_min 
equation_max 

◆ 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)

◆ BufferAccess

Array Buffer access enum.

Enumerator
access_read_only 
access_write_only 
access_read_write 
access_write_discard 

◆ 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 

◆ CompareFunction

Compare functions.

Enumerator
compare_lequal 
compare_gequal 
compare_less 
compare_greater 
compare_equal 
compare_notequal 
compare_always 
compare_never 

◆ CullMode

Polygon culling modes.

Enumerator
cull_front 
cull_back 
cull_front_and_back 

◆ 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 

◆ FaceSide

Front face modes.

Enumerator
face_clockwise 
face_counter_clockwise 

◆ FillMode

Polygon filling modes.

Enumerator
fill_point 
fill_line 
fill_polygon 

◆ FrameBufferBindTarget

Framebuffer bind target.

Enumerator
framebuffer_draw 
framebuffer_read 

◆ 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 

◆ MapMode

Mapping modes.

Enumerator
map_2d_upper_left 
map_2d_lower_left 
map_user_projection 

◆ 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.

◆ PointSpriteOrigin

Point Sprite Origin.

Enumerator
origin_upper_left 
origin_lower_left 

◆ PrimitivesType

Primitive types.

Enumerator
type_points 
type_line_strip 
type_line_loop 
type_lines 
type_triangle_strip 
type_triangle_fan 
type_triangles 

◆ ShaderLanguage

Shader language used.

Enumerator
shader_glsl 
shader_hlsl 
shader_fixed_function 
num_shader_languages 

◆ ShaderType

Shader Type.

Enumerator
shadertype_vertex 
shadertype_geometry 
shadertype_fragment 
shadertype_tess_evaluation 
shadertype_tess_control 
shadertype_compute 
shadertype_num_types 

◆ StandardProgram

Standard Program.

Enumerator
program_color_only 
program_single_texture 
program_sprite 
program_path 

◆ StencilOp

Stencil operations.

Enumerator
stencil_keep 
stencil_zero 
stencil_replace 
stencil_incr 
stencil_decr 
stencil_invert 
stencil_incr_wrap 
stencil_decr_wrap 

◆ TextureCompareMode

Texture compare modes.

Enumerator
comparemode_none 
comparemode_compare_r_to_texture 

◆ 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 

◆ TextureDimensions

Texture dimensions.

Enumerator
texture_1d 
texture_1d_array 
texture_2d 
texture_2d_array 
texture_3d 
texture_cube 
texture_cube_array 

◆ TextureFilter

Texture filters.

Enumerator
filter_nearest 
filter_linear 
filter_nearest_mipmap_nearest 
filter_nearest_mipmap_linear 
filter_linear_mipmap_nearest 
filter_linear_mipmap_linear 

◆ 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 

◆ 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.

◆ 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 

◆ TextureWrapMode

Texture coordinate wrapping modes.

Enumerator
wrap_clamp_to_edge 
wrap_repeat 
wrap_mirrored_repeat 

◆ VertexAttributeDataType

Primitives array description.

Enumerator
type_unsigned_byte 
type_unsigned_short 
type_unsigned_int 
type_byte 
type_short 
type_int 
type_float 

Function Documentation

◆ BlendState() [1/2]

clan::BlendState::BlendState ( )

Constructs a null instance.

◆ BlendState() [2/2]

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

Constructs a Texture.

Parameters
context= Graphic context
desc= Blend state description

◆ BlendStateDescription()

clan::BlendStateDescription::BlendStateDescription ( )

◆ Canvas() [1/3]

clan::Canvas::Canvas ( )

Constructs a null instance.

◆ Canvas() [2/3]

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

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

◆ Canvas() [3/3]

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

Constructs a Canvas.

◆ DepthStencilState() [1/2]

clan::DepthStencilState::DepthStencilState ( )

Constructs a null instance.

◆ DepthStencilState() [2/2]

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

Constructs a Texture.

Parameters
context= Graphic context
desc= DepthStencil state description

◆ DepthStencilStateDescription()

clan::DepthStencilStateDescription::DepthStencilStateDescription ( )

◆ DisplayTarget()

clan::DisplayTarget::DisplayTarget ( DisplayTargetProvider provider)

Constructs a DisplayTarget.

Parameters
provider= Display Target Provider

◆ ElementArrayBuffer() [1/3]

clan::ElementArrayBuffer::ElementArrayBuffer ( )

Constructs a null instance.

◆ ElementArrayBuffer() [2/3]

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

◆ ElementArrayBuffer() [3/3]

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

Constructs a ElementArrayBuffer.

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

◆ ElementArrayVector() [1/4]

template<typename Type >
clan::ElementArrayVector< Type >::ElementArrayVector ( )
inline

Constructs a null instance.

◆ ElementArrayVector() [2/4]

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

◆ ElementArrayVector() [3/4]

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

◆ ElementArrayVector() [4/4]

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

◆ FrameBuffer() [1/2]

clan::FrameBuffer::FrameBuffer ( )

Constructs a null instance.

◆ FrameBuffer() [2/2]

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

◆ GraphicContext() [1/2]

clan::GraphicContext::GraphicContext ( )

Constructs a null instance.

◆ GraphicContext() [2/2]

clan::GraphicContext::GraphicContext ( GraphicContextProvider provider)

Constructs a new graphic context from a provider.

Parameters
provider= Graphic Context Provider

◆ IconSet()

clan::IconSet::IconSet ( )

Constructs an icon set.

◆ ImageImportDescription()

clan::ImageImportDescription::ImageImportDescription ( )

Constructs a image import description with default values.

◆ OcclusionQuery() [1/2]

clan::OcclusionQuery::OcclusionQuery ( )

Constructs a null instance.

◆ OcclusionQuery() [2/2]

clan::OcclusionQuery::OcclusionQuery ( GraphicContext context)

Constructs an occlusion query object.

◆ PerlinNoise()

clan::PerlinNoise::PerlinNoise ( )

Constructor.

◆ PixelBuffer() [1/6]

clan::PixelBuffer::PixelBuffer ( )

Constructs a null instance.

◆ PixelBuffer() [2/6]

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

Constructs a PixelBuffer.

Parameters
filename= String Ref
dir= Virtual Directory

◆ PixelBuffer() [3/6]

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

Constructs a PixelBuffer.

Parameters
fullname= String Ref

◆ PixelBuffer() [4/6]

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

◆ PixelBuffer() [5/6]

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

Constructs a PixelBuffer.

Parameters
file= IODevice
image_type= String

◆ PixelBuffer() [6/6]

clan::PixelBuffer::PixelBuffer ( PixelBufferProvider provider)

Constructs a PixelBuffer.

Parameters
provider= Font Provider

◆ PixelBufferLock() [1/2]

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

◆ PixelBufferLock() [2/2]

template<typename Type >
clan::PixelBufferLock< Type >::PixelBufferLock ( PixelBuffer pixel_buffer,
bool  lock_pixelbuffer = true 
)
inline

◆ PixelBufferSet() [1/3]

clan::PixelBufferSet::PixelBufferSet ( )

Constructs a null instance.

◆ PixelBufferSet() [2/3]

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

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

◆ PixelBufferSet() [3/3]

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.

◆ PixelConverter()

clan::PixelConverter::PixelConverter ( )

Constructs a pixel format converter.

◆ PrimitivesArray() [1/2]

clan::PrimitivesArray::PrimitivesArray ( )

Construct a null instance.

◆ PrimitivesArray() [2/2]

clan::PrimitivesArray::PrimitivesArray ( GraphicContext gc)

Constructs a PrimitivesArray.

Parameters
gc= Graphic Context

◆ ProgramObject() [1/4]

clan::ProgramObject::ProgramObject ( )

Construct a null instance.

◆ ProgramObject() [2/4]

clan::ProgramObject::ProgramObject ( GraphicContext gc)

Constructs a ProgramObject.

Parameters
gc= Graphic Context

◆ ProgramObject() [3/4]

clan::ProgramObject::ProgramObject ( GraphicContextProvider gc_provider)

Constructs a ProgramObject.

Parameters
gc_provider= Graphic Context Provider

◆ ProgramObject() [4/4]

clan::ProgramObject::ProgramObject ( ProgramObjectProvider provider)

Constructs a ProgramObject.

Parameters
provider= Font Provider

◆ RasterizerState() [1/2]

clan::RasterizerState::RasterizerState ( )

Constructs a null instance.

◆ RasterizerState() [2/2]

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

Constructs a Texture.

Parameters
context= Graphic context
desc= Rasterizer state description

◆ RasterizerStateDescription()

clan::RasterizerStateDescription::RasterizerStateDescription ( )

◆ RenderBuffer() [1/2]

clan::RenderBuffer::RenderBuffer ( )

Constructs a null instance.

◆ RenderBuffer() [2/2]

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

◆ ScreenInfo()

clan::ScreenInfo::ScreenInfo ( )

Constructs a ScreenInfo object.

◆ ShaderEffect() [1/2]

clan::ShaderEffect::ShaderEffect ( )

Constructs a null instance.

◆ ShaderEffect() [2/2]

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

Constructs a shader effect.

Parameters
descriptionShader effect description.
gcGraphics context in which to create the shader effect.

◆ ShaderEffectDescription()

clan::ShaderEffectDescription::ShaderEffectDescription ( )

◆ ShaderObject() [1/6]

clan::ShaderObject::ShaderObject ( )

Constructs a null instance.

◆ ShaderObject() [2/6]

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

Constructs an OpenGL shader.

Parameters
typeShader type. Can be shadertype_vertex or shadertype_fragment.
sourceShader source code, in OpenGL Shader Language (GLSL).
gcGraphics context in which to create the shader object

◆ ShaderObject() [3/6]

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

◆ ShaderObject() [4/6]

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

Constructs a ShaderObject.

◆ ShaderObject() [5/6]

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

◆ ShaderObject() [6/6]

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

◆ StorageBuffer() [1/3]

clan::StorageBuffer::StorageBuffer ( )

Constructs a null instance.

◆ StorageBuffer() [2/3]

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

◆ StorageBuffer() [3/3]

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

◆ StorageVector() [1/4]

template<typename Type >
clan::StorageVector< Type >::StorageVector ( )
inline

Constructs a null instance.

◆ StorageVector() [2/4]

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

◆ StorageVector() [3/4]

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

◆ StorageVector() [4/4]

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

◆ Texture() [1/4]

clan::Texture::Texture ( )

Constructs a null instance.

◆ Texture() [2/4]

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

Constructs a texture from an implementation.

Parameters
impl= The implementation

◆ Texture() [3/4]

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

Constructs a texture as described in a pixelbuffer set.

◆ Texture() [4/4]

clan::Texture::Texture ( TextureProvider provider)

Constructs a texture from a texture provider.

Parameters
provider= The provider

◆ Texture1D() [1/5]

clan::Texture1D::Texture1D ( )

Constructs a null instance.

◆ Texture1D() [2/5]

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

Constructs a texture from an implementation.

Parameters
impl= The implementation

◆ Texture1D() [3/5]

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

◆ Texture1D() [4/5]

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

◆ Texture1D() [5/5]

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

◆ Texture1DArray() [1/3]

clan::Texture1DArray::Texture1DArray ( )

Constructs a null instance.

◆ Texture1DArray() [2/3]

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

Constructs a texture from an implementation.

Parameters
impl= The implementation

◆ Texture1DArray() [3/3]

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

◆ Texture2D() [1/9]

clan::Texture2D::Texture2D ( )

Constructs a null instance.

◆ Texture2D() [2/9]

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

Constructs a texture from an implementation.

Parameters
implThe Texture object implementation.

◆ Texture2D() [3/9]

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

◆ Texture2D() [4/9]

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

◆ Texture2D() [5/9]

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

Constructs a new Texture object.

Parameters
contextGraphic context to construct the texture on.
sizeSize of the new texture.
formatData format of the new texture.
levelsNumber of mipmap levels for the new texture. Setting this to 0 enables all levels.

◆ Texture2D() [6/9]

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

◆ Texture2D() [7/9]

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

◆ Texture2D() [8/9]

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

Constructs a new Texture object.

Parameters
contextGraphic context to construct the texture on.
widthWidth of the new texture.
heightHeight of the new texture.
formatData format of the new texture.
levelsNumber of mipmap levels for the new texture. Setting this to 0 enables all levels.

◆ Texture2D() [9/9]

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

◆ Texture2DArray() [1/4]

clan::Texture2DArray::Texture2DArray ( )

Constructs a null instance.

◆ Texture2DArray() [2/4]

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

Constructs a texture from an implementation.

Parameters
implThe Texture object implementation.

◆ Texture2DArray() [3/4]

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
contextGraphic context to construct the texture on.
sizeSize of the new texture.
array_sizeNumber of textures to allocate in this array.
formatData format of the new texture.
levelsNumber of mipmap levels for the new texture. Setting this to 0 enables all levels.

◆ Texture2DArray() [4/4]

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
contextGraphic context to construct the texture on.
widthWidth of the new texture.
heightHeight of the new texture.
array_sizeNumber of textures to allocate in this array.
formatData format of the new texture.
levelsNumber of mipmap levels for the new texture. Setting this to 0 enables all levels.

◆ Texture3D() [1/4]

clan::Texture3D::Texture3D ( )

Constructs a null instance.

◆ Texture3D() [2/4]

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

Constructs a texture from an implementation.

Parameters
impl= The implementation

◆ Texture3D() [3/4]

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

◆ Texture3D() [4/4]

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

◆ TextureCube() [1/4]

clan::TextureCube::TextureCube ( )

Constructs a null instance.

◆ TextureCube() [2/4]

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

Constructs a texture from an implementation.

Parameters
impl= The implementation

◆ TextureCube() [3/4]

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

◆ TextureCube() [4/4]

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

◆ TextureCubeArray() [1/4]

clan::TextureCubeArray::TextureCubeArray ( )

Constructs a null instance.

◆ TextureCubeArray() [2/4]

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

Constructs a texture from an implementation.

Parameters
impl= The implementation

◆ TextureCubeArray() [3/4]

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

◆ TextureCubeArray() [4/4]

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

◆ TransferBuffer() [1/3]

clan::TransferBuffer::TransferBuffer ( )

Constructs a null instance.

◆ TransferBuffer() [2/3]

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

◆ TransferBuffer() [3/3]

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

◆ TransferTexture() [1/4]

clan::TransferTexture::TransferTexture ( )

Constructs a null instance.

◆ TransferTexture() [2/4]

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

◆ TransferTexture() [3/4]

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

◆ TransferTexture() [4/4]

clan::TransferTexture::TransferTexture ( PixelBufferProvider provider)

Constructs a GPU Transfer Buffer.

Parameters
provider= Font Provider

◆ TransferVector() [1/5]

template<typename Type >
clan::TransferVector< Type >::TransferVector ( )
inline

Constructs a null instance.

◆ TransferVector() [2/5]

template<typename Type >
clan::TransferVector< Type >::TransferVector ( const TransferBuffer transfer_buffer)
inlineexplicit

Constructs a TransferVector from an existing buffer.

◆ TransferVector() [3/5]

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

◆ TransferVector() [4/5]

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

◆ TransferVector() [5/5]

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

◆ UniformBuffer() [1/4]

clan::UniformBuffer::UniformBuffer ( )

Constructs a null instance.

◆ UniformBuffer() [2/4]

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

◆ UniformBuffer() [3/4]

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

◆ UniformBuffer() [4/4]

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

◆ UniformVector() [1/4]

template<typename Type >
clan::UniformVector< Type >::UniformVector ( )
inline

Constructs a null instance.

◆ UniformVector() [2/4]

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

◆ UniformVector() [3/4]

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

◆ UniformVector() [4/4]

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

◆ VertexArrayBuffer() [1/3]

clan::VertexArrayBuffer::VertexArrayBuffer ( )

Constructs a null instance.

◆ VertexArrayBuffer() [2/3]

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

◆ VertexArrayBuffer() [3/3]

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

Constructs a VertexArrayBuffer.

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

◆ VertexArrayVector() [1/5]

template<typename Type >
clan::VertexArrayVector< Type >::VertexArrayVector ( )
inline

Constructs a null instance.

◆ VertexArrayVector() [2/5]

template<typename Type >
clan::VertexArrayVector< Type >::VertexArrayVector ( const VertexArrayBuffer buffer)
inlineexplicit

Constructs a VertexArrayBuffer using an existing VertexArrayBuffer.

◆ VertexArrayVector() [3/5]

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

◆ VertexArrayVector() [4/5]

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

◆ VertexArrayVector() [5/5]

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

◆ ~BlendStateProvider()

virtual clan::BlendStateProvider::~BlendStateProvider ( )
inlinevirtual

◆ ~Canvas()

clan::Canvas::~Canvas ( )

◆ ~CursorProvider()

virtual clan::CursorProvider::~CursorProvider ( )
inlinevirtual

◆ ~DepthStencilStateProvider()

virtual clan::DepthStencilStateProvider::~DepthStencilStateProvider ( )
inlinevirtual

◆ ~DisplayTarget()

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

◆ ~DisplayTargetProvider()

virtual clan::DisplayTargetProvider::~DisplayTargetProvider ( )
inlinevirtual

◆ ~DisplayWindowProvider()

virtual clan::DisplayWindowProvider::~DisplayWindowProvider ( )
inlinevirtual

◆ ~ElementArrayBuffer()

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

◆ ~ElementArrayBufferProvider()

virtual clan::ElementArrayBufferProvider::~ElementArrayBufferProvider ( )
inlinevirtual

◆ ~FrameBufferProvider()

virtual clan::FrameBufferProvider::~FrameBufferProvider ( )
inlinevirtual

◆ ~GraphicContext()

clan::GraphicContext::~GraphicContext ( )

◆ ~GraphicContextProvider()

virtual clan::GraphicContextProvider::~GraphicContextProvider ( )
inlinevirtual

◆ ~ImageImportDescription()

clan::ImageImportDescription::~ImageImportDescription ( )

◆ ~OcclusionQuery()

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

◆ ~PerlinNoise()

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

Destructor.

◆ ~PixelBuffer()

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

◆ ~PixelBufferLock()

template<typename Type >
clan::PixelBufferLock< Type >::~PixelBufferLock ( )
inline

◆ ~PixelBufferProvider()

virtual clan::PixelBufferProvider::~PixelBufferProvider ( )
inlinevirtual

◆ ~PixelConverter()

clan::PixelConverter::~PixelConverter ( )

◆ ~PrimitivesArray()

clan::PrimitivesArray::~PrimitivesArray ( )

◆ ~PrimitivesArrayProvider()

virtual clan::PrimitivesArrayProvider::~PrimitivesArrayProvider ( )
inlinevirtual

◆ ~ProgramObject()

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

◆ ~ProgramObjectProvider()

virtual clan::ProgramObjectProvider::~ProgramObjectProvider ( )
inlinevirtual

◆ ~RasterizerStateProvider()

virtual clan::RasterizerStateProvider::~RasterizerStateProvider ( )
inlinevirtual

◆ ~RenderBatcher()

virtual clan::RenderBatcher::~RenderBatcher ( )
inlinevirtual

◆ ~RenderBufferProvider()

virtual clan::RenderBufferProvider::~RenderBufferProvider ( )
inlinevirtual

◆ ~ShaderObject()

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

◆ ~ShaderObjectProvider()

virtual clan::ShaderObjectProvider::~ShaderObjectProvider ( )
inlinevirtual

◆ ~StorageBufferProvider()

virtual clan::StorageBufferProvider::~StorageBufferProvider ( )
inlinevirtual

◆ ~Texture()

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

◆ ~TextureProvider()

virtual clan::TextureProvider::~TextureProvider ( )
inlinevirtual

◆ ~TransferBuffer()

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

◆ ~TransferBufferProvider()

virtual clan::TransferBufferProvider::~TransferBufferProvider ( )
inlinevirtual

◆ ~TransferTexture()

clan::TransferTexture::~TransferTexture ( )

◆ ~UniformBufferProvider()

virtual clan::UniformBufferProvider::~UniformBufferProvider ( )
inlinevirtual

◆ ~VertexArrayBuffer()

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

◆ ~VertexArrayBufferProvider()

virtual clan::VertexArrayBufferProvider::~VertexArrayBufferProvider ( )
inlinevirtual

◆ add_border()

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.

◆ add_disposable()

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

Add disposable.

Parameters
disposable= Disposable Object

◆ add_image()

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

Adds an image to the icon set.

◆ add_provider()

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

Add a provider.

◆ add_ref()

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

Add ref.

◆ alloc_display_window()

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

Allocates a display window provider.

◆ alloc_element_array_buffer()

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

Allocate element array buffer provider for this gc.

◆ alloc_frame_buffer()

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

Allocate frame buffer provider for this gc.

◆ alloc_occlusion_query()

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

Allocate occlusion query provider of this gc.

◆ alloc_pixel_buffer()

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

Allocate pixel buffer provider for this gc.

◆ alloc_primitives_array()

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

Allocate primitives array provider for this gc.

◆ alloc_program_object()

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

Allocate program object provider of this gc.

◆ alloc_render_buffer()

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

Allocate render buffer provider for this gc.

◆ alloc_shader_object()

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

Allocate shader object provider of this gc.

◆ alloc_storage_buffer()

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

Allocate storage buffer provider for this gc.

◆ alloc_texture()

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

Allocate texture provider for this gc.

◆ alloc_transfer_buffer()

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

Allocate transfer buffer provider for this gc.

◆ alloc_uniform_buffer()

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

Allocate uniform buffer provider for this gc.

◆ alloc_vertex_array_buffer()

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

Allocate vertex array buffer provider for this gc.

◆ attach() [1/2]

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

Add shader to program object.

◆ attach() [2/2]

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

Add shader to program object.

◆ attach_color() [1/14]

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

Attach color buffer.

Parameters
attachment_index= value
render_buffer= Render Buffer

◆ attach_color() [2/14]

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

◆ attach_color() [3/14]

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

◆ attach_color() [4/14]

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

◆ attach_color() [5/14]

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

◆ attach_color() [6/14]

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

◆ attach_color() [7/14]

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

◆ attach_color() [8/14]

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

◆ attach_color() [9/14]

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

◆ attach_color() [10/14]

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

◆ attach_color() [11/14]

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

◆ attach_color() [12/14]

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

◆ attach_color() [13/14]

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

◆ attach_color() [14/14]

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

◆ attach_depth() [1/6]

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

◆ attach_depth() [2/6]

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

◆ attach_depth() [3/6]

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

◆ attach_depth() [4/6]

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

◆ attach_depth() [5/6]

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

◆ attach_depth() [6/6]

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

◆ attach_depth_stencil() [1/6]

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

◆ attach_depth_stencil() [2/6]

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

◆ attach_depth_stencil() [3/6]

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

◆ attach_depth_stencil() [4/6]

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

◆ attach_depth_stencil() [5/6]

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

◆ attach_depth_stencil() [6/6]

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

◆ attach_stencil() [1/6]

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

◆ attach_stencil() [2/6]

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

◆ attach_stencil() [3/6]

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

◆ attach_stencil() [4/6]

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

◆ attach_stencil() [5/6]

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

◆ attach_stencil() [6/6]

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

◆ begin()

void clan::OcclusionQuery::begin ( )

Start occlusion query.

◆ bind_attribute_location() [1/2]

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

Bind attribute to specific location.

This function must be called before linking.

◆ bind_attribute_location() [2/2]

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.

◆ bind_frag_data_location() [1/2]

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.

◆ bind_frag_data_location() [2/2]

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.

◆ blend() [1/2]

BlendStateDescription& clan::ShaderEffectDescription::blend ( )

◆ blend() [2/2]

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

◆ bring_to_front()

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

Raise window on top of other windows.

◆ capture_mouse()

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

Capture/Release the mouse.

◆ clear() [1/3]

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

Clears the whole context using the specified color.

◆ clear() [2/3]

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

Clears the whole context using the specified color.

◆ clear() [3/3]

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

Clears the whole context using the specified color.

◆ clear_depth() [1/3]

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

Clear the depth buffer.

Parameters
valuevalue to clear to. Range 0.0 - 1.0.

◆ clear_depth() [2/3]

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

Clear the depth buffer.

Parameters
valuevalue to clear to. Range 0.0 - 1.0.

◆ clear_depth() [3/3]

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

Clear the depth buffer

Parameters
valuevalue to clear to. Range 0.0 - 1.0.

◆ clear_stencil() [1/3]

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

Clear the stencil buffer.

Parameters
valuevalue to clear to.

◆ clear_stencil() [2/3]

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

Clear the stencil buffer.

Parameters
valuevalue to clear to.

◆ clear_stencil() [3/3]

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

Clear the stencil buffer

Parameters
valuevalue to clear to.

◆ client_to_screen()

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

Convert from window client coordinates to screen coordinates.

◆ clone() [1/4]

DepthStencilStateDescription clan::DepthStencilStateDescription::clone ( ) const

◆ clone() [2/4]

RasterizerStateDescription clan::RasterizerStateDescription::clone ( ) const

◆ clone() [3/4]

BlendStateDescription clan::BlendStateDescription::clone ( ) const

◆ clone() [4/4]

GraphicContext clan::GraphicContext::clone ( ) const

Create a new default graphic context cloned with this one.

◆ compile() [1/2]

bool clan::ShaderObject::compile ( )

Compile program.

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

◆ compile() [2/2]

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

Compile program.

◆ convert()

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.

◆ copy() [1/2]

PixelBuffer clan::PixelBuffer::copy ( ) const

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

◆ copy() [2/2]

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

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

◆ copy_from() [1/13]

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.

◆ copy_from() [2/13]

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.

◆ copy_from() [3/13]

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.

◆ copy_from() [4/13]

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.

◆ copy_from() [5/13]

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.

◆ copy_from() [6/13]

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().

◆ copy_from() [7/13]

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().

◆ copy_from() [8/13]

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().

◆ copy_from() [9/13]

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().

◆ copy_from() [10/13]

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().

◆ copy_from() [11/13]

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().

◆ copy_from() [12/13]

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().

◆ copy_from() [13/13]

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().

◆ copy_image_from() [1/4]

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

◆ copy_image_from() [2/4]

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

Copy image data from a graphic context.

◆ copy_image_from() [3/4]

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

◆ copy_image_from() [4/4]

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.

◆ copy_subimage_from() [1/3]

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

◆ copy_subimage_from() [2/3]

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.

◆ copy_subimage_from() [3/3]

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.

◆ copy_to() [1/12]

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.

◆ copy_to() [2/12]

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.

◆ copy_to() [3/12]

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.

◆ copy_to() [4/12]

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.

◆ copy_to() [5/12]

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().

◆ copy_to() [6/12]

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().

◆ copy_to() [7/12]

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().

◆ copy_to() [8/12]

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().

◆ copy_to() [9/12]

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().

◆ copy_to() [10/12]

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().

◆ copy_to() [11/12]

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().

◆ copy_to() [12/12]

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().

◆ create() [1/20]

Canvas clan::Canvas::create ( )

Create a copy of a canvas.

◆ create() [2/20]

GraphicContext clan::GraphicContext::create ( ) const

Create a new default graphic context compatible with this one.

◆ create() [3/20]

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

◆ create() [4/20]

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

Create.

Parameters
data= void
size= value
usage= Buffer Usage

◆ create() [5/20]

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

◆ create() [6/20]

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

Creates window, assigning site and description to provider.

◆ create() [7/20]

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

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

◆ create() [8/20]

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

Constructs a element array buffer.

◆ create() [9/20]

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

Constructs a vertex array buffer.

◆ create() [10/20]

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

Constructs a array buffer.

◆ create() [11/20]

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

Constructs a vertex array buffer.

◆ create() [12/20]

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

Constructs a vertex array buffer.

◆ create() [13/20]

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

Create texture.

◆ create() [14/20]

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.

◆ create() [15/20]

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

Creates a shader object.

◆ create() [16/20]

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

Create.

Parameters
type= Shader Type
vector= std

◆ create() [17/20]

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

Creates a shader object.

◆ create() [18/20]

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

Create.

Parameters
data= void
size= value
usage= Buffer Usage

◆ create() [19/20]

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

Create.

Parameters
data= void
size= value
usage= Buffer Usage

◆ create() [20/20]

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

Create.

Parameters
data= void
size= value
usage= Buffer Usage

◆ create_2d_view()

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

Creates a 2D texture view.

◆ create_blend_state()

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

Retrieve blend state object.

◆ create_cursor()

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

Creates a new custom cursor.

◆ create_depth_stencil_state()

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

Retrieve depth-stencil state object.

◆ create_noise1d()

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

◆ create_noise2d()

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

◆ create_noise3d()

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

◆ create_noise4d()

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

◆ create_rasterizer_state()

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

Retrieve rasterizer state object.

◆ create_view()

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

\breif Creates a texture view for this texture

◆ create_win32_icon()

DataBuffer clan::IconSet::create_win32_icon ( )

Generates a Windows .ICO format icon from the set.

◆ depth_stencil()

DepthStencilStateDescription& clan::ShaderEffectDescription::depth_stencil ( )

◆ detach() [1/2]

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

Remove shader from program object.

◆ detach() [2/2]

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

Remove shader from program object.

◆ detach_color() [1/2]

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

Detach color buffer.

Parameters
attachment_index= value
texture= Texture
level= value
zoffset= value

◆ detach_color() [2/2]

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

Detach color buffer.

Parameters
color_buffer= value
texture= Texture
level= value
zoffset= value

◆ detach_depth() [1/2]

void clan::FrameBuffer::detach_depth ( )

◆ detach_depth() [2/2]

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

◆ detach_depth_stencil() [1/2]

void clan::FrameBuffer::detach_depth_stencil ( )

◆ detach_depth_stencil() [2/2]

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

◆ detach_stencil() [1/2]

void clan::FrameBuffer::detach_stencil ( )

◆ detach_stencil() [2/2]

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

◆ dispatch() [1/3]

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

◆ dispatch() [2/3]

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

Execute a compute shader.

◆ dispatch() [3/3]

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

Execute a compute shader.

◆ draw()

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

◆ draw_box() [1/3]

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

◆ draw_box() [2/3]

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

Box.

Parameters
gc= Graphic Context
rect= Rectf
color= Colorf

◆ draw_box() [3/3]

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

Draw a box / rectangle.

◆ draw_line() [1/3]

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

◆ draw_line() [2/3]

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

◆ draw_line() [3/3]

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

Draw a line.

◆ draw_line_strip()

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

Line Strip.

◆ draw_lines() [1/2]

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.

◆ draw_lines() [2/2]

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

Lines.

◆ draw_point() [1/2]

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

Point.

Parameters
gc= Graphic Context
point= Pointf
color= Colorf

◆ draw_point() [2/2]

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

Draw a point.

◆ draw_primitives() [1/2]

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

Draw primitives on gc.

◆ draw_primitives() [2/2]

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

Draw primitives on gc.

◆ draw_primitives_array() [1/3]

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

Draws primitives from the current assigned primitives array.

◆ draw_primitives_array() [2/3]

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

◆ draw_primitives_array() [3/3]

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

Draws primitives from the current assigned primitives array.

◆ draw_primitives_array_instanced() [1/2]

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

◆ draw_primitives_array_instanced() [2/2]

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.

◆ draw_primitives_elements() [1/7]

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

◆ draw_primitives_elements() [2/7]

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

◆ draw_primitives_elements() [3/7]

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.

◆ draw_primitives_elements() [4/7]

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.

◆ draw_primitives_elements() [5/7]

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.

◆ draw_primitives_elements() [6/7]

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().

◆ draw_primitives_elements() [7/7]

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

◆ draw_primitives_elements_instanced() [1/7]

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

◆ draw_primitives_elements_instanced() [2/7]

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

◆ draw_primitives_elements_instanced() [3/7]

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.

◆ draw_primitives_elements_instanced() [4/7]

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.

◆ draw_primitives_elements_instanced() [5/7]

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.

◆ draw_primitives_elements_instanced() [6/7]

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().

◆ draw_primitives_elements_instanced() [7/7]

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

◆ enable_alpha_channel()

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_rectWindow blur area. If its size is 0, the area of the entire window will be used.

◆ enable_antialiased()

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

Enables/disables anti-aliasing. (clanGL only)

◆ enable_blending()

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

Enable/Disable blending.

◆ enable_color_write()

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

Enable/disable writing to the color buffer.

◆ enable_depth_test()

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

Enables/disables depth testing.

◆ enable_depth_write()

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

Enables/disables depth writing.

◆ enable_line_antialiasing()

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

Setting to true enables line antialiasing.

Initially antialiasing of lines is disabled.

◆ enable_logic_op()

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

Enable/disable logic op. (clanGL only)

◆ enable_offset_fill()

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

Enables/disables polygon offsetting.

◆ enable_offset_line()

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

Enables/disables line offsetting.

◆ enable_offset_point()

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

Enables/disables point offsetting.

◆ enable_point_size()

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

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

◆ enable_scissor()

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

Enables/disables if clipping rects are used.

◆ enable_stencil_test()

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

Enables/disables stencil testing.

◆ end()

void clan::OcclusionQuery::end ( )

Finish occlusion query.

◆ extend_frame_into_client_area()

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.

◆ fill_circle() [1/4]

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

◆ fill_circle() [2/4]

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

◆ fill_circle() [3/4]

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

◆ fill_circle() [4/4]

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

Draw a circle.

◆ fill_ellipse() [1/2]

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

Draw a filled ellipse.

◆ fill_ellipse() [2/2]

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

Draw a gradient filled ellipse.

◆ fill_rect() [1/6]

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

◆ fill_rect() [2/6]

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

◆ fill_rect() [3/6]

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

Fill.

Parameters
gc= Graphic Context
rect= Rectf
color= Colorf

◆ fill_rect() [4/6]

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

Gradient fill.

Parameters
gc= Graphic Context
rect= Rectf
gradient= Gradient

◆ fill_rect() [5/6]

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

Draw a filled box / rectangle.

◆ fill_rect() [6/6]

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

◆ fill_triangle() [1/2]

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

Draw a triangle.

◆ fill_triangle() [2/2]

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

Draw a triangle.

◆ fill_triangles() [1/18]

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.

◆ fill_triangles() [2/18]

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.

◆ fill_triangles() [3/18]

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

Draw triangles.

◆ fill_triangles() [4/18]

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

Draw triangles.

◆ fill_triangles() [5/18]

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

Draw triangles.

◆ fill_triangles() [6/18]

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

Draw triangles.

◆ fill_triangles() [7/18]

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

Draw triangles.

◆ fill_triangles() [8/18]

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

Draw triangles.

◆ fill_triangles() [9/18]

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

Draw triangles.

◆ fill_triangles() [10/18]

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.

◆ fill_triangles() [11/18]

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

Draw triangles.

◆ fill_triangles() [12/18]

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

Draw triangles.

◆ fill_triangles() [13/18]

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

Draw triangles.

◆ fill_triangles() [14/18]

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

Draw triangles.

◆ fill_triangles() [15/18]

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

Draw triangles.

◆ fill_triangles() [16/18]

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

Draw triangles.

◆ fill_triangles() [17/18]

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.

◆ fill_triangles() [18/18]

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

Draw triangles.

◆ flip()

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

Flip the window display buffers.

◆ flip_vertical() [1/3]

void clan::PixelBuffer::flip_vertical ( )

Flip the entire image vertically (turn it upside down)

◆ flip_vertical() [2/3]

bool clan::PixelConverter::flip_vertical ( ) const

Returns the flip vertical setting.

◆ flip_vertical() [3/3]

bool clan::ImageImportDescription::flip_vertical ( ) const

Returns the flip vertical setting.

◆ flush() [1/4]

void clan::Canvas::flush ( )

Flushes the render batcher currently active.

◆ flush() [2/4]

void clan::GraphicContext::flush ( )

Flush the command buffer.

◆ flush() [3/4]

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

◆ flush() [4/4]

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

Flush render batcher contents.

Parameters
gcGraphic context to flush contents to.

◆ func_process()

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)

◆ generate_mipmap() [1/2]

void clan::Texture::generate_mipmap ( )

Generate the mipmap.

◆ generate_mipmap() [2/2]

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

Generate the mipmap.

◆ get_amplitude()

float clan::PerlinNoise::get_amplitude ( ) const

Get the amplitude of the perlin noise.

◆ get_antialiased()

bool clan::RasterizerStateDescription::get_antialiased ( ) const

◆ get_array_size() [1/3]

int clan::Texture1DArray::get_array_size ( ) const

Get the texture array size.

◆ get_array_size() [2/3]

int clan::TextureCubeArray::get_array_size ( ) const

Get the texture array size.

◆ get_array_size() [3/3]

int clan::Texture2DArray::get_array_size ( ) const

Returns the number of textures in the array.

◆ get_attribute_location() [1/2]

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

Returns the location of a named active attribute.

Returns -1 when unknown

◆ get_attribute_location() [2/2]

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

Returns the location of a named active attribute.

◆ get_base_level() [1/2]

int clan::PixelBufferSet::get_base_level ( ) const

Returns the lowest mip level specified in the set.

◆ get_base_level() [2/2]

int clan::Texture::get_base_level ( ) const

Get the texture base level.

◆ get_bind_target() [1/2]

FrameBufferBindTarget clan::FrameBuffer::get_bind_target ( ) const

Get the bind target of the framebuffer.

Returns
The bind target

◆ get_bind_target() [2/2]

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

◆ get_blend_equation()

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

◆ get_blend_function()

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

◆ get_bytes_per_block() [1/2]

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() )

◆ get_bytes_per_block() [2/2]

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() )

◆ get_bytes_per_pixel() [1/2]

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() )

◆ get_bytes_per_pixel() [2/2]

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() )

◆ get_clip_z_range() [1/2]

ClipZRange clan::GraphicContext::get_clip_z_range ( ) const

Returns in what range clip space z values are clipped.

◆ get_clip_z_range() [2/2]

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

Returns in what range clip space z values are clipped.

◆ get_clipboard_image()

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

Returns the image stored in the clipboard.

◆ get_clipboard_text()

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

Returns the text stored in the clipboard.

◆ get_cliprect()

Rectf clan::Canvas::get_cliprect ( ) const

Returns the current clipping rectangle.

◆ get_color_write()

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

◆ get_compare_function()

CompareFunction clan::Texture::get_compare_function ( ) const

Get the texture compare function.

◆ get_compare_mode()

TextureCompareMode clan::Texture::get_compare_mode ( ) const

Get the texture compare mode.

◆ get_compile_status()

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

Returns true if compile succeeded.

◆ get_culled()

bool clan::RasterizerStateDescription::get_culled ( ) const

◆ get_current_target()

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

Returns the currently selected display target.

◆ get_data() [1/9]

void* clan::TransferBuffer::get_data ( )

Retrieves a pointer to the mapped buffer.

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

◆ get_data() [2/9]

template<typename Type >
Type* clan::PixelBufferLock< Type >::get_data ( )
inline

◆ get_data() [3/9]

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[]().

◆ get_data() [4/9]

void* clan::PixelBuffer::get_data ( )

◆ get_data() [5/9]

template<typename Type >
Type* clan::PixelBuffer::get_data ( )
inline

◆ get_data() [6/9]

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

◆ get_data() [7/9]

template<typename Type >
const Type* clan::PixelBuffer::get_data ( ) const
inline

◆ get_data() [8/9]

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

Retrieves a pointer to the mapped buffer.

◆ get_data() [9/9]

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

Retrieves a pointer to the mapped buffer.

◆ get_data_size() [1/2]

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

Returns the size in bytes of the image data.

Returns
The data size

◆ get_data_size() [2/2]

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

◆ get_data_uint16() [1/2]

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().

◆ get_data_uint16() [2/2]

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

◆ get_data_uint32() [1/2]

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().

◆ get_data_uint32() [2/2]

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

◆ get_data_uint8() [1/2]

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().

◆ get_data_uint8() [2/2]

const unsigned char* clan::PixelBuffer::get_data_uint8 ( ) const
inline

◆ get_depth()

int clan::Texture3D::get_depth ( ) const

Get the texture depth.

◆ get_depth_compare_function()

CompareFunction clan::DepthStencilStateDescription::get_depth_compare_function ( ) const

◆ get_dimensions()

TextureDimensions clan::PixelBufferSet::get_dimensions ( ) const

Returns the texture dimensions used by the image set.

◆ get_dip_height() [1/4]

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().

◆ get_dip_height() [2/4]

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().

◆ get_dip_height() [3/4]

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().

◆ get_dip_height() [4/4]

float clan::GraphicContext::get_dip_height ( ) const
inline

Calculates the device independent height of the context. \seealso 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().

◆ get_dip_size() [1/4]

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().

◆ get_dip_size() [2/4]

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().

◆ get_dip_size() [3/4]

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().

◆ get_dip_size() [4/4]

Sizef clan::GraphicContext::get_dip_size ( ) const
inline

Calculates the device independent dimensions of the context. \seealso Resolution Independence

References clan::GraphicContext::get_dip_height(), and clan::GraphicContext::get_dip_width().

Referenced by clan::Canvas::get_size().

◆ get_dip_width() [1/4]

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().

◆ get_dip_width() [2/4]

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().

◆ get_dip_width() [3/4]

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().

◆ get_dip_width() [4/4]

float clan::GraphicContext::get_dip_width ( ) const
inline

Calculates the device independent width of the context. \seealso 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().

◆ get_display_window_size()

virtual Size clan::GraphicContextProvider::get_display_window_size ( ) const
pure virtual

Returns the current size of the display window.

◆ get_enable_line_antialiasing()

bool clan::RasterizerStateDescription::get_enable_line_antialiasing ( ) const

◆ get_enable_scissor()

bool clan::RasterizerStateDescription::get_enable_scissor ( ) const

◆ get_face_cull_mode()

CullMode clan::RasterizerStateDescription::get_face_cull_mode ( ) const

◆ get_face_fill_mode()

FillMode clan::RasterizerStateDescription::get_face_fill_mode ( ) const

◆ get_format() [1/4]

TextureFormat clan::PixelBufferSet::get_format ( ) const

Returns the internal texture format used by the image.

◆ get_format() [2/4]

TextureFormat clan::PerlinNoise::get_format ( ) const

Get the format of the output pixelbuffer.

◆ get_format() [3/4]

TextureFormat clan::PixelBuffer::get_format ( ) const

Returns the pixel format.

◆ get_format() [4/4]

virtual TextureFormat clan::PixelBufferProvider::get_format ( ) const
pure virtual

Returns the pixel format.

◆ get_front_face()

FaceSide clan::RasterizerStateDescription::get_front_face ( ) const

◆ get_gamma()

float clan::PixelConverter::get_gamma ( ) const

Returns the gamma setting.

◆ get_gc() [1/2]

◆ get_gc() [2/2]

virtual GraphicContext& clan::DisplayWindowProvider::get_gc ( )
pure virtual

Returns the graphic context for the window.

◆ get_gc_providers()

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

◆ get_geometry()

virtual Rect clan::DisplayWindowProvider::get_geometry ( ) const
pure virtual

Returns the position and size of the window frame.

◆ get_handle() [1/5]

unsigned int clan::ShaderObject::get_handle ( ) const

Returns the OpenGL shader handle.

◆ get_handle() [2/5]

unsigned int clan::ProgramObject::get_handle ( ) const

Returns the OpenGL program object handle.

◆ get_handle() [3/5]

virtual unsigned int clan::ProgramObjectProvider::get_handle ( ) const
pure virtual

Returns the OpenGL program object handle.

◆ get_handle() [4/5]

virtual unsigned int clan::ShaderObjectProvider::get_handle ( ) const
pure virtual

Returns the OpenGL shader handle.

◆ get_handle() [5/5]

virtual DisplayWindowHandle clan::DisplayWindowProvider::get_handle ( ) const
pure virtual

Returns an platform-specific internal display window handle object.

◆ get_height() [1/10]

int clan::TextureCubeArray::get_height ( ) const

Get the texture height.

◆ get_height() [2/10]

int clan::Texture3D::get_height ( ) const

Get the texture height.

◆ get_height() [3/10]

int clan::PixelBufferSet::get_height ( ) const

Returns the height of the image.

◆ get_height() [4/10]

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().

◆ get_height() [5/10]

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().

◆ get_height() [6/10]

int clan::TextureCube::get_height ( ) const

Get the texture height.

◆ get_height() [7/10]

template<typename Type >
int clan::PixelBufferLock< Type >::get_height ( ) const
inline

◆ get_height() [8/10]

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().

◆ get_height() [9/10]

int clan::PixelBuffer::get_height ( ) const

◆ get_height() [10/10]

int clan::GraphicContext::get_height ( ) const

Returns the current actual height of the context.

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

◆ get_ic()

virtual InputContext clan::DisplayWindowProvider::get_ic ( )
pure virtual

Returns the input context for the window.

◆ get_image()

PixelBuffer clan::PixelBufferSet::get_image ( int  slice,
int  level 
)

Returns the pixel buffer for a specific slice and level.

◆ get_images()

std::vector<PixelBuffer> clan::IconSet::get_images ( ) const

Returns all the images in the icon set.

◆ get_impl()

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

◆ get_info_log() [1/4]

std::string clan::ShaderObject::get_info_log ( ) const

Get shader object's info log.

◆ get_info_log() [2/4]

std::string clan::ProgramObject::get_info_log ( ) const

Returns the current info log for the program object.

◆ get_info_log() [3/4]

virtual std::string clan::ProgramObjectProvider::get_info_log ( ) const
pure virtual

Returns the current info log for the program object.

◆ get_info_log() [4/4]

virtual std::string clan::ShaderObjectProvider::get_info_log ( ) const
pure virtual

Get shader object's info log.

◆ get_input_is_ycrcb()

bool clan::PixelConverter::get_input_is_ycrcb ( ) const

Returns the JPEG JFIF YCrCb input setting.

◆ get_inverse_transform()

Mat4f& clan::Canvas::get_inverse_transform ( )

Returns the inverse of the current effective transform matrix.

This is cached

◆ get_line() [1/2]

void* clan::PixelBuffer::get_line ( int  line)
inline

◆ get_line() [2/2]

const void* clan::PixelBuffer::get_line ( int  line) const
inline

◆ get_line_uint16() [1/2]

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().

◆ get_line_uint16() [2/2]

const unsigned short* clan::PixelBuffer::get_line_uint16 ( int  line) const
inline

◆ get_line_uint32() [1/2]

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().

◆ get_line_uint32() [2/2]

const unsigned int* clan::PixelBuffer::get_line_uint32 ( int  line) const
inline

◆ get_line_uint8() [1/2]

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().

◆ get_line_uint8() [2/2]

const unsigned char* clan::PixelBuffer::get_line_uint8 ( int  line) const
inline

◆ get_link_status()

virtual bool clan::ProgramObjectProvider::get_link_status ( ) const
pure virtual

Returns true if the link succeeded.

◆ get_lock_count()

template<typename Type >
int clan::PixelBufferLock< Type >::get_lock_count ( ) const
inline

Returns the amounts of recursive pixel_buffer locks performed by this section.

◆ get_lod_bias()

float clan::Texture::get_lod_bias ( ) const

Get the level of detail bias constant.

◆ get_logic_op()

LogicOp clan::BlendStateDescription::get_logic_op ( ) const

◆ get_mag_filter()

TextureFilter clan::Texture::get_mag_filter ( ) const

Get the texture magnification filter.

◆ get_major_version() [1/2]

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.

◆ get_major_version() [2/2]

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.

◆ get_max_attributes()

virtual int clan::GraphicContextProvider::get_max_attributes ( )
pure virtual

Returns the maximum amount of attributes available.

◆ get_max_level() [1/2]

int clan::PixelBufferSet::get_max_level ( ) const

Returns the highest mip level specified in the set.

◆ get_max_level() [2/2]

int clan::Texture::get_max_level ( ) const

Get the texture max level.

◆ get_max_lod()

float clan::Texture::get_max_lod ( ) const

Get the maximum level of detail.

◆ get_max_texture_size() [1/2]

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.

◆ get_max_texture_size() [2/2]

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.

◆ get_maximum_size()

virtual Size clan::DisplayWindowProvider::get_maximum_size ( bool  client_area) const
pure virtual

Returns the maximum size of the window.

◆ get_min_filter()

TextureFilter clan::Texture::get_min_filter ( ) const

Get the texture minification filter.

◆ get_min_lod()

float clan::Texture::get_min_lod ( ) const

Get the minimum level of detail.

◆ get_minimum_size()

virtual Size clan::DisplayWindowProvider::get_minimum_size ( bool  client_area) const
pure virtual

Returns the minimum size of the window.

◆ get_minor_version() [1/2]

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.

◆ get_minor_version() [2/2]

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.

◆ get_octaves()

int clan::PerlinNoise::get_octaves ( ) const

Get the number of octaves of the perlin noise.

◆ get_offset_fill()

bool clan::RasterizerStateDescription::get_offset_fill ( ) const

◆ get_offset_line()

bool clan::RasterizerStateDescription::get_offset_line ( ) const

◆ get_offset_point()

bool clan::RasterizerStateDescription::get_offset_point ( ) const

◆ get_output_is_ycrcb()

bool clan::PixelConverter::get_output_is_ycrcb ( ) const

Returns the JPEG JFIF YCrCb output setting.

◆ get_pitch() [1/3]

template<typename Type >
int clan::PixelBufferLock< Type >::get_pitch ( ) const
inline

◆ get_pitch() [2/3]

int clan::PixelBuffer::get_pitch ( ) const

Returns the pitch (in bytes per scanline).

Referenced by clan::PixelBuffer::get_line(), and clan::PixelBufferLock< Type >::lock().

◆ get_pitch() [3/3]

virtual int clan::PixelBufferProvider::get_pitch ( ) const
pure virtual

Retrieves the pitch of the mapped buffer. Use this after get_data()

◆ get_pixel() [1/2]

template<typename Type >
Type& clan::PixelBufferLock< Type >::get_pixel ( int  x,
int  y 
)
inline

References clan::x, and clan::y.

◆ get_pixel() [2/2]

Colorf clan::PixelBuffer::get_pixel ( int  x,
int  y 
)

Return color of pixel at the specified coordinates.

◆ get_pixel_ratio() [1/8]

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().

◆ get_pixel_ratio() [2/8]

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().

◆ get_pixel_ratio() [3/8]

float clan::Canvas::get_pixel_ratio ( ) const
inline

Retrieves the display pixel ratio of the context. \seealso Resolution Independence

References clan::Canvas::get_gc(), and clan::GraphicContext::get_pixel_ratio().

◆ get_pixel_ratio() [4/8]

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().

◆ get_pixel_ratio() [5/8]

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

◆ get_pixel_ratio() [6/8]

float clan::GraphicContext::get_pixel_ratio ( ) const

Retrieves the display pixel ratio of the context. \seealso Resolution Independence

Referenced by clan::GraphicContext::get_dip_height(), clan::GraphicContext::get_dip_width(), and clan::Canvas::get_pixel_ratio().

◆ get_pixel_ratio() [7/8]

virtual float clan::GraphicContextProvider::get_pixel_ratio ( ) const
pure virtual

Physical pixels/dots per inch.

◆ get_pixel_ratio() [8/8]

virtual float clan::DisplayWindowProvider::get_pixel_ratio ( ) const
pure virtual

Returns the display pixel ratio of the window. \seealso Resolution Independence

◆ get_pixeldata() [1/8]

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.

◆ get_pixeldata() [2/8]

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.

◆ get_pixeldata() [3/8]

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.

◆ get_pixeldata() [4/8]

PixelBuffer clan::Texture2D::get_pixeldata ( GraphicContext gc,
int  level = 0 
) const

Retrieve image data from texture.

◆ get_pixeldata() [5/8]

virtual PixelBuffer clan::TextureProvider::get_pixeldata ( GraphicContext gc,
TextureFormat  texture_format,
int  level 
) const
pure virtual

Retrieve image data from texture.

◆ get_pixeldata() [6/8]

PixelBuffer clan::Texture2D::get_pixeldata ( GraphicContext gc,
TextureFormat  texture_format,
int  level = 0 
) const

Retrieve image data from this texture.

Parameters
formatOutput data format.
levelMipmap level of the texture to retrieve data from.

◆ get_pixeldata() [7/8]

PixelBuffer clan::Canvas::get_pixeldata ( TextureFormat  texture_format = tf_rgba8,
bool  clamp = true 
)

Return the content of the read buffer into a pixel buffer.

◆ get_pixeldata() [8/8]

PixelBuffer clan::GraphicContext::get_pixeldata ( TextureFormat  texture_format = tf_rgba8,
bool  clamp = true 
)

Return the content of the read buffer into a pixel buffer.

◆ get_point_fade_treshold_size()

float clan::RasterizerStateDescription::get_point_fade_treshold_size ( ) const

◆ get_point_size()

float clan::RasterizerStateDescription::get_point_size ( ) const

◆ get_point_sprite_origin()

PointSpriteOrigin clan::RasterizerStateDescription::get_point_sprite_origin ( ) const

◆ get_polygon_offset()

void clan::RasterizerStateDescription::get_polygon_offset ( float &  out_factor,
float &  out_units 
) const

◆ get_premultiply_alpha() [1/2]

bool clan::PixelConverter::get_premultiply_alpha ( ) const

Returns the premultiply alpha setting.

◆ get_premultiply_alpha() [2/2]

bool clan::ImageImportDescription::get_premultiply_alpha ( ) const

Returns the premultiply alpha setting.

◆ get_program_object() [1/2]

ProgramObject clan::GraphicContext::get_program_object ( ) const

Returns the currently selected program object.

◆ get_program_object() [2/2]

virtual ProgramObject clan::GraphicContextProvider::get_program_object ( StandardProgram  standard_program) const
pure virtual

Get a program object from the standard program specified.

◆ get_projection()

const Mat4f& clan::Canvas::get_projection ( ) const

Returns the current effective projection matrix.

◆ get_provider() [1/20]

DisplayTargetProvider* clan::DisplayTarget::get_provider ( )

Returns the provider for the display target.

◆ get_provider() [2/20]

GraphicContextProvider* clan::GraphicContext::get_provider ( )

Returns the provider for this graphic context.

◆ get_provider() [3/20]

RasterizerStateProvider* clan::RasterizerState::get_provider ( ) const

◆ get_provider() [4/20]

DepthStencilStateProvider* clan::DepthStencilState::get_provider ( ) const

◆ get_provider() [5/20]

BlendStateProvider* clan::BlendState::get_provider ( ) const

◆ get_provider() [6/20]

OcclusionQueryProvider* clan::OcclusionQuery::get_provider ( ) const

Get Provider.

Returns
provider

◆ get_provider() [7/20]

RenderBufferProvider* clan::RenderBuffer::get_provider ( ) const

Get Provider.

Returns
provider

◆ get_provider() [8/20]

StorageBufferProvider* clan::StorageBuffer::get_provider ( ) const

Get Provider.

Returns
provider

◆ get_provider() [9/20]

ElementArrayBufferProvider* clan::ElementArrayBuffer::get_provider ( ) const

Get Provider.

Returns
provider

◆ get_provider() [10/20]

VertexArrayBufferProvider* clan::VertexArrayBuffer::get_provider ( ) const

Get Provider.

Returns
provider

◆ get_provider() [11/20]

TransferBufferProvider* clan::TransferBuffer::get_provider ( ) const

Get Provider.

Returns
provider

◆ get_provider() [12/20]

UniformBufferProvider* clan::UniformBuffer::get_provider ( ) const

Get Provider.

Returns
provider

◆ get_provider() [13/20]

PrimitivesArrayProvider* clan::PrimitivesArray::get_provider ( ) const

Returns the target provider for the primitives array.

◆ get_provider() [14/20]

FrameBufferProvider* clan::FrameBuffer::get_provider ( ) const

Get Provider.

Returns
provider

◆ get_provider() [15/20]

ShaderObjectProvider* clan::ShaderObject::get_provider ( ) const

Get Provider.

Returns
provider

◆ get_provider() [16/20]

TextureProvider* clan::Texture::get_provider ( ) const

Get Provider.

Returns
provider

◆ get_provider() [17/20]

ProgramObjectProvider* clan::ProgramObject::get_provider ( ) const

Retrieves the provider.

◆ get_provider() [18/20]

PixelBufferProvider* clan::PixelBuffer::get_provider ( ) const

Get Provider.

Returns
provider

◆ get_provider() [19/20]

const GraphicContextProvider* clan::GraphicContext::get_provider ( ) const

◆ get_provider() [20/20]

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

◆ get_read_frame_buffer()

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

◆ get_result()

int clan::OcclusionQuery::get_result ( )

Returns the result of the occlusion query.

◆ get_row()

template<typename Type >
Type* clan::PixelBufferLock< Type >::get_row ( int  y)
inline

References clan::y.

◆ get_screen_geometries()

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.

◆ get_shader_language() [1/2]

ShaderLanguage clan::GraphicContext::get_shader_language ( ) const

Returns the shader language used.

◆ get_shader_language() [2/2]

virtual ShaderLanguage clan::GraphicContextProvider::get_shader_language ( ) const
pure virtual

Returns the shader language used.

◆ get_shader_source() [1/2]

std::string clan::ShaderObject::get_shader_source ( ) const

Get shader source code.

◆ get_shader_source() [2/2]

virtual std::string clan::ShaderObjectProvider::get_shader_source ( ) const
pure virtual

Get shader source code.

◆ get_shader_type() [1/2]

ShaderType clan::ShaderObject::get_shader_type ( ) const

Gets the shader type.

◆ get_shader_type() [2/2]

virtual ShaderType clan::ShaderObjectProvider::get_shader_type ( ) const
pure virtual

Gets the shader type.

◆ get_shaders() [1/2]

std::vector<ShaderObject> clan::ProgramObject::get_shaders ( ) const

Returns the shaders attached to the program object.

◆ get_shaders() [2/2]

virtual std::vector<ShaderObject> clan::ProgramObjectProvider::get_shaders ( ) const
pure virtual

Returns the shaders used in this program.

◆ get_size() [1/15]

int clan::Texture1DArray::get_size ( ) const

Get the texture width.

◆ get_size() [2/15]

int clan::Texture1D::get_size ( ) const

Get the texture width.

◆ get_size() [3/15]

const Size& clan::RenderBuffer::get_size ( ) const

Returns the render buffer size.

◆ get_size() [4/15]

Size clan::TextureCubeArray::get_size ( ) const

Get the texture size.

◆ get_size() [5/15]

Vec3i clan::Texture3D::get_size ( ) const

Get the texture size.

◆ get_size() [6/15]

Size clan::Texture2DArray::get_size ( ) const
inline

Retrieves the actual size of the texture.

References clan::Texture2DArray::get_height(), and clan::Texture2DArray::get_width().

◆ get_size() [7/15]

Size clan::Texture2D::get_size ( ) const
inline

Retrieves the actual size of the texture.

References clan::Texture2D::get_height(), and clan::Texture2D::get_width().

◆ get_size() [8/15]

Size clan::TextureCube::get_size ( ) const

Get the texture size.

◆ get_size() [9/15]

Size clan::FrameBuffer::get_size ( ) const

Get the minumum size of all the frame buffer attachments.

Returns
size

◆ get_size() [10/15]

Size clan::PerlinNoise::get_size ( ) const

Get the size of the output pixelbuffer.

◆ get_size() [11/15]

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().

◆ get_size() [12/15]

Size clan::PixelBuffer::get_size ( ) const
inline

Retrieves the actual size of the buffer.

References clan::PixelBuffer::get_height(), and clan::PixelBuffer::get_width().

◆ get_size() [13/15]

Size clan::GraphicContext::get_size ( ) const

Returns the current actual size of the context.

◆ get_size() [14/15]

virtual Size clan::FrameBufferProvider::get_size ( ) const
pure virtual

◆ get_size() [15/15]

virtual Size clan::PixelBufferProvider::get_size ( ) const
pure virtual

◆ get_slice_count()

int clan::PixelBufferSet::get_slice_count ( ) const

Returns the number of depth/array/cube slices in the set.

◆ get_stencil_compare_back()

void clan::DepthStencilStateDescription::get_stencil_compare_back ( CompareFunction out_back,
int &  out_back_ref,
int &  out_back_mask 
) const

◆ get_stencil_compare_front()

void clan::DepthStencilStateDescription::get_stencil_compare_front ( CompareFunction out_front,
int &  out_front_ref,
int &  out_front_mask 
) const

◆ get_stencil_op_back()

void clan::DepthStencilStateDescription::get_stencil_op_back ( StencilOp out_fail_back,
StencilOp out_pass_depth_fail_back,
StencilOp out_pass_depth_pass_back 
) const

◆ get_stencil_op_front()

void clan::DepthStencilStateDescription::get_stencil_op_front ( StencilOp out_fail_front,
StencilOp out_pass_depth_fail_front,
StencilOp out_pass_depth_pass_front 
) const

◆ get_stencil_write_mask()

void clan::DepthStencilStateDescription::get_stencil_write_mask ( unsigned char &  out_front_facing_mask,
unsigned char &  out_back_facing_mask 
) const

◆ get_storage_buffer_index() [1/2]

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

◆ get_storage_buffer_index() [2/2]

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

◆ get_swizzle()

Vec4i clan::PixelConverter::get_swizzle ( ) const

Returns the input channel used for each output channel.

◆ get_texture()

Texture clan::GraphicContext::get_texture ( int  index) const

Retrieves the texture selected in this context with an index number.

Parameters
indexThe 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.

◆ get_texture_image_y_axis() [1/2]

TextureImageYAxis clan::GraphicContext::get_texture_image_y_axis ( ) const

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

◆ get_texture_image_y_axis() [2/2]

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.

◆ get_textures()

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..

◆ get_title()

virtual std::string clan::DisplayWindowProvider::get_title ( ) const
pure virtual

Returns the maximum size of the window.

◆ get_transform()

const Mat4f& clan::Canvas::get_transform ( ) const

Returns the current effective transform matrix.

◆ get_uniform_buffer_index() [1/2]

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

◆ get_uniform_buffer_index() [2/2]

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

◆ get_uniform_buffer_size() [1/3]

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

◆ get_uniform_buffer_size() [2/3]

int clan::ProgramObject::get_uniform_buffer_size ( int  block_index) const

Get the uniform block size.

◆ get_uniform_buffer_size() [3/3]

virtual int clan::ProgramObjectProvider::get_uniform_buffer_size ( int  block_index) const
pure virtual

Get the uniform block size.

◆ get_uniform_location() [1/2]

◆ get_uniform_location() [2/2]

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

Returns the location of a named uniform variable.

◆ get_validate_status()

virtual bool clan::ProgramObjectProvider::get_validate_status ( ) const
pure virtual

Returns true if validation succeeded.

◆ get_viewport()

virtual Rect clan::DisplayWindowProvider::get_viewport ( ) const
pure virtual

Returns the drawable area of the window.

◆ get_width() [1/10]

int clan::TextureCubeArray::get_width ( ) const

Get the texture width.

◆ get_width() [2/10]

int clan::Texture3D::get_width ( ) const

Get the texture width.

◆ get_width() [3/10]

int clan::PixelBufferSet::get_width ( ) const

Returns the width of the image.

◆ get_width() [4/10]

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().

◆ get_width() [5/10]

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().

◆ get_width() [6/10]

int clan::TextureCube::get_width ( ) const

Get the texture width.

◆ get_width() [7/10]

template<typename Type >
int clan::PixelBufferLock< Type >::get_width ( ) const
inline

◆ get_width() [8/10]

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().

◆ get_width() [9/10]

int clan::PixelBuffer::get_width ( ) const

◆ get_width() [10/10]

int clan::GraphicContext::get_width ( ) const

Returns the current actual width of the context.

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

◆ get_wrap_mode_r()

TextureWrapMode clan::Texture3D::get_wrap_mode_r ( ) const

Get the texture wrap mode for the r coordinate.

◆ get_wrap_mode_s() [1/5]

TextureWrapMode clan::Texture1DArray::get_wrap_mode_s ( ) const

Get the texture wrap mode for the s coordinate.

◆ get_wrap_mode_s() [2/5]

TextureWrapMode clan::Texture1D::get_wrap_mode_s ( ) const

Get the texture wrap mode for the s coordinate.

◆ get_wrap_mode_s() [3/5]

TextureWrapMode clan::Texture3D::get_wrap_mode_s ( ) const

Get the texture wrap mode for the s coordinate.

◆ get_wrap_mode_s() [4/5]

TextureWrapMode clan::Texture2DArray::get_wrap_mode_s ( ) const

Get the texture wrap mode for the s coordinate.

◆ get_wrap_mode_s() [5/5]

TextureWrapMode clan::Texture2D::get_wrap_mode_s ( ) const

Get the texture wrap mode for the s coordinate.

◆ get_wrap_mode_t() [1/3]

TextureWrapMode clan::Texture3D::get_wrap_mode_t ( ) const

Get the texture wrap mode for the t coordinate.

◆ get_wrap_mode_t() [2/3]

TextureWrapMode clan::Texture2DArray::get_wrap_mode_t ( ) const

Get the texture wrap mode for the t coordinate.

◆ get_wrap_mode_t() [3/3]

TextureWrapMode clan::Texture2D::get_wrap_mode_t ( ) const

Get the texture wrap mode for the t coordinate.

◆ get_write_frame_buffer()

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

◆ grid_fit()

Pointf clan::Canvas::grid_fit ( const Pointf pos)

Snaps the point to the nearest pixel corner.

◆ has_compute_shader_support() [1/2]

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.

◆ has_compute_shader_support() [2/2]

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.

◆ has_focus()

virtual bool clan::DisplayWindowProvider::has_focus ( ) const
pure virtual

Returns true if window has focus.

◆ has_transparency()

bool clan::PixelBuffer::has_transparency ( ) const

Returns true if format has an alpha channel.

◆ hide()

virtual void clan::DisplayWindowProvider::hide ( )
pure virtual

Hides the window.

◆ hide_system_cursor()

virtual void clan::DisplayWindowProvider::hide_system_cursor ( )
pure virtual

Hides the mouse cursor.

◆ is_blending_enabled()

bool clan::BlendStateDescription::is_blending_enabled ( ) const

◆ is_cached()

bool clan::ImageImportDescription::is_cached ( ) const

Returns if this image should be cached.

◆ is_clipboard_image_available()

virtual bool clan::DisplayWindowProvider::is_clipboard_image_available ( ) const
pure virtual

Returns true if an image is available in the clipboard.

◆ is_clipboard_text_available()

virtual bool clan::DisplayWindowProvider::is_clipboard_text_available ( ) const
pure virtual

Returns true if text is available in the clipboard.

◆ is_compressed() [1/2]

bool clan::PixelBuffer::is_compressed ( ) const

Returns true if compressed.

◆ is_compressed() [2/2]

static bool clan::PixelBuffer::is_compressed ( TextureFormat  texture_format)
static

Returns true if compressed.

◆ is_depth_test_enabled()

bool clan::DepthStencilStateDescription::is_depth_test_enabled ( ) const

◆ is_depth_write_enabled()

bool clan::DepthStencilStateDescription::is_depth_write_enabled ( ) const

◆ is_frame_buffer_owner() [1/2]

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.

◆ is_frame_buffer_owner() [2/2]

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.

◆ is_fullscreen()

virtual bool clan::DisplayWindowProvider::is_fullscreen ( ) const
pure virtual

Returns true if the window is fullscreen.

◆ is_gpu() [1/2]

bool clan::PixelBuffer::is_gpu ( ) const

Returns true if this pixel buffer is a GPU based one.

Referenced by clan::PixelBufferLock< Type >::lock().

◆ is_gpu() [2/2]

virtual bool clan::PixelBufferProvider::is_gpu ( ) const
pure virtual

Returns true if this pixel buffer is a GPU based one.

◆ is_logic_op_enabled()

bool clan::BlendStateDescription::is_logic_op_enabled ( ) const

◆ is_maximized()

virtual bool clan::DisplayWindowProvider::is_maximized ( ) const
pure virtual

Returns true if the window is maximized.

◆ is_minimized()

virtual bool clan::DisplayWindowProvider::is_minimized ( ) const
pure virtual

Returns true if the window is minimized.

◆ is_null() [1/21]

bool clan::DepthStencilState::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [2/21]

bool clan::RasterizerState::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [3/21]

bool clan::ShaderEffect::is_null ( ) const

◆ is_null() [4/21]

bool clan::BlendState::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [5/21]

bool clan::DisplayTarget::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [6/21]

bool clan::OcclusionQuery::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [7/21]

bool clan::PixelBufferSet::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [8/21]

bool clan::RenderBuffer::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [9/21]

bool clan::StorageBuffer::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [10/21]

bool clan::TransferBuffer::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [11/21]

bool clan::ElementArrayBuffer::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [12/21]

bool clan::VertexArrayBuffer::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [13/21]

bool clan::UniformBuffer::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [14/21]

bool clan::PrimitivesArray::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [15/21]

bool clan::FrameBuffer::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [16/21]

bool clan::Canvas::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [17/21]

bool clan::PixelBuffer::is_null ( ) const
inline

◆ is_null() [18/21]

bool clan::Texture::is_null ( ) const
inline

Returns true if this object is invalid.

References clan::Texture::impl.

◆ is_null() [19/21]

bool clan::ShaderObject::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [20/21]

bool clan::ProgramObject::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_null() [21/21]

bool clan::GraphicContext::is_null ( ) const
inline

Returns true if this object is invalid.

◆ is_point_size()

bool clan::RasterizerStateDescription::is_point_size ( ) const

◆ is_primitives_array_owner() [1/2]

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.

◆ is_primitives_array_owner() [2/2]

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.

◆ is_resident()

bool clan::Texture::is_resident ( ) const

Returns true if texture is resident in texture memory.

◆ is_result_ready()

bool clan::OcclusionQuery::is_result_ready ( )

Returns true if the GPU is ready to return the result.

◆ is_srgb()

bool clan::ImageImportDescription::is_srgb ( ) const

Returns the sRGB setting.

◆ is_stencil_test_enabled()

bool clan::DepthStencilStateDescription::is_stencil_test_enabled ( ) const

◆ is_visible()

virtual bool clan::DisplayWindowProvider::is_visible ( ) const
pure virtual

Returns true if the window is visible.

◆ link() [1/2]

bool clan::ProgramObject::link ( )

Link program.

If the linking fails, get_info_log() will return the link log.

◆ link() [2/2]

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.

◆ load() [1/12]

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.

◆ load() [2/12]

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

◆ load() [3/12]

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

◆ load() [4/12]

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

◆ load() [5/12]

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

◆ load() [6/12]

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

◆ load() [7/12]

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

◆ load() [8/12]

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

◆ load() [9/12]

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

◆ load() [10/12]

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

◆ load() [11/12]

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

◆ load() [12/12]

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

◆ load_and_compile() [1/3]

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

◆ load_and_compile() [2/3]

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

◆ load_and_compile() [3/3]

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

◆ load_and_link() [1/6]

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

◆ load_and_link() [2/6]

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

◆ load_and_link() [3/6]

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

◆ load_and_link() [4/6]

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

◆ load_and_link() [5/6]

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

◆ load_and_link() [6/6]

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

◆ lock() [1/6]

template<typename Type >
void clan::PixelBufferLock< Type >::lock ( )
inline

◆ lock() [2/6]

void clan::TransferBuffer::lock ( GraphicContext gc,
BufferAccess  access 
)

Maps buffer into system memory.

◆ lock() [3/6]

template<typename Type >
void clan::PixelBufferLock< Type >::lock ( GraphicContext gc,
BufferAccess  access 
)
inline

◆ lock() [4/6]

void clan::PixelBuffer::lock ( GraphicContext gc,
BufferAccess  access 
)

Maps buffer into system memory.

Referenced by clan::PixelBufferLock< Type >::lock().

◆ lock() [5/6]

virtual void clan::TransferBufferProvider::lock ( GraphicContext gc,
BufferAccess  access 
)
pure virtual

Maps buffer into system memory.

◆ lock() [6/6]

virtual void clan::PixelBufferProvider::lock ( GraphicContext gc,
BufferAccess  access 
)
pure virtual

Maps buffer into system memory.

◆ matrix_changed()

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
modelviewNew wodel view matrix.
projectionNew projection matrix.
image_yaxisThe image Y axis to use where projection is not used.
pixel_ratioThe display pixel ratio to use when rendering.

◆ maximize()

virtual void clan::DisplayWindowProvider::maximize ( )
pure virtual

Maximizes the window.

◆ minimize()

virtual void clan::DisplayWindowProvider::minimize ( )
pure virtual

Minimizes the window.

◆ mult_transform()

void clan::Canvas::mult_transform ( const Mat4f matrix)

Multiplies the passed matrix onto the transform matrix.

◆ opaque()

static BlendStateDescription clan::BlendStateDescription::opaque ( )
static

◆ operator GraphicContext &()

clan::Canvas::operator GraphicContext & ( ) const
inline

◆ operator!=() [1/2]

bool clan::GraphicContext::operator!= ( const GraphicContext other) const
inline

◆ operator!=() [2/2]

bool clan::Texture::operator!= ( const Texture other) const
inline

Inequality operator.

References clan::Texture::impl.

◆ operator<() [1/4]

bool clan::BlendStateDescription::operator< ( const BlendStateDescription other) const

◆ operator<() [2/4]

bool clan::DepthStencilStateDescription::operator< ( const DepthStencilStateDescription other) const

◆ operator<() [3/4]

bool clan::RasterizerStateDescription::operator< ( const RasterizerStateDescription other) const

◆ operator<() [4/4]

bool clan::Texture::operator< ( const Texture other) const
inline

Less than operator.

References clan::Texture::impl.

◆ operator==() [1/14]

bool clan::BlendStateDescription::operator== ( const BlendStateDescription other) const

◆ operator==() [2/14]

bool clan::DepthStencilStateDescription::operator== ( const DepthStencilStateDescription other) const

◆ operator==() [3/14]

bool clan::ElementArrayBuffer::operator== ( const ElementArrayBuffer other) const

Handle comparison operator.

◆ operator==() [4/14]

bool clan::FrameBuffer::operator== ( const FrameBuffer other) const

Equality operator.

◆ operator==() [5/14]

bool clan::GraphicContext::operator== ( const GraphicContext other) const
inline

◆ operator==() [6/14]

bool clan::ProgramObject::operator== ( const ProgramObject other) const

Equality operator.

◆ operator==() [7/14]

bool clan::RasterizerStateDescription::operator== ( const RasterizerStateDescription other) const

◆ operator==() [8/14]

bool clan::RenderBuffer::operator== ( const RenderBuffer other) const

Equality operator.

◆ operator==() [9/14]

bool clan::ShaderObject::operator== ( const ShaderObject other) const

Handle comparison operator.

◆ operator==() [10/14]

bool clan::StorageBuffer::operator== ( const StorageBuffer other) const

Handle comparison operator.

◆ operator==() [11/14]

bool clan::Texture::operator== ( const Texture other) const
inline

Equality operator.

References clan::Texture::impl.

◆ operator==() [12/14]

bool clan::TransferBuffer::operator== ( const TransferBuffer other) const

Handle comparison operator.

◆ operator==() [13/14]

bool clan::UniformBuffer::operator== ( const UniformBuffer other) const

Handle comparison operator.

◆ operator==() [14/14]

bool clan::VertexArrayBuffer::operator== ( const VertexArrayBuffer other) const

Handle comparison operator.

◆ operator[]() [1/2]

template<typename Type >
Type& clan::TransferVector< Type >::operator[] ( int  index)
inline

◆ operator[]() [2/2]

template<typename Type >
Type& clan::TransferVector< Type >::operator[] ( unsigned int  index)
inline

◆ pop_cliprect()

void clan::Canvas::pop_cliprect ( )

Pop current clipping rectangle from the stack.

◆ premultiply_alpha()

void clan::PixelBuffer::premultiply_alpha ( )

Multiply the RGB components by the Alpha component.

This is useful with certain blending functions

◆ premultiply_gamma()

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

◆ process()

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.

◆ push_cliprect() [1/2]

void clan::Canvas::push_cliprect ( )

Push cliprect.

◆ push_cliprect() [2/2]

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.

◆ rasterizer()

RasterizerStateDescription& clan::ShaderEffectDescription::rasterizer ( )

◆ release_ref()

static void clan::SharedGCData::release_ref ( )
static

Release ref.

◆ remove_disposable()

static void clan::SharedGCData::remove_disposable ( DisposableObject disposable)
static

Remove disposable.

Parameters
disposable= Disposable Object

◆ remove_provider()

static void clan::SharedGCData::remove_provider ( GraphicContextProvider provider)
static

Remove a provider.

◆ remove_target()

static void clan::Display::remove_target ( const DisplayTarget target)
static

Remove the target from the target list.

◆ request_repaint()

virtual void clan::DisplayWindowProvider::request_repaint ( const Rect rect)
pure virtual

Invalidates a region of a screen, causing a repaint.

◆ reset_blend_state() [1/2]

void clan::Canvas::reset_blend_state ( )

Set active blend state.

◆ reset_blend_state() [2/2]

void clan::GraphicContext::reset_blend_state ( )

Set active blend state.

◆ reset_cliprect()

void clan::Canvas::reset_cliprect ( )

Removes the set clipping rectangle and empties the cliprect stack.

◆ reset_depth_stencil_state() [1/2]

void clan::Canvas::reset_depth_stencil_state ( )

Set active depth stencil state.

◆ reset_depth_stencil_state() [2/2]

void clan::GraphicContext::reset_depth_stencil_state ( )

Set active depth stencil state.

◆ reset_frame_buffer() [1/2]

void clan::GraphicContext::reset_frame_buffer ( )

Resets the current frame buffer to be the initial frame buffer.

◆ reset_frame_buffer() [2/2]

virtual void clan::GraphicContextProvider::reset_frame_buffer ( )
pure virtual

Set the rendering buffer back to the screen.

◆ reset_image_texture() [1/2]

void clan::GraphicContext::reset_image_texture ( int  unit_index)

Remove texture from index.

Parameters
unit_index= 0 to x, the index of the texture

◆ reset_image_texture() [2/2]

virtual void clan::GraphicContextProvider::reset_image_texture ( int  unit_index)
pure virtual

Remove texture from image unit.

◆ reset_image_textures()

void clan::GraphicContext::reset_image_textures ( )

Remove all selected textures.

◆ reset_primitives_array() [1/2]

void clan::GraphicContext::reset_primitives_array ( )

Reset the primitives arrays.

◆ reset_primitives_array() [2/2]

virtual void clan::GraphicContextProvider::reset_primitives_array ( )
pure virtual

Reset the primitives arrays.

◆ reset_primitives_elements() [1/2]

void clan::GraphicContext::reset_primitives_elements ( )

Resets current elements array buffer.

◆ reset_primitives_elements() [2/2]

virtual void clan::GraphicContextProvider::reset_primitives_elements ( )
pure virtual

Resets current elements array buffer.

◆ reset_program_object() [1/2]

void clan::GraphicContext::reset_program_object ( )

Remove active program object.

◆ reset_program_object() [2/2]

virtual void clan::GraphicContextProvider::reset_program_object ( )
pure virtual

Remove active program object.

◆ reset_rasterizer_state() [1/2]

void clan::Canvas::reset_rasterizer_state ( )

Set active rasterizer state.

◆ reset_rasterizer_state() [2/2]

void clan::GraphicContext::reset_rasterizer_state ( )

Set active rasterizer state.

◆ reset_scissor() [1/2]

void clan::GraphicContext::reset_scissor ( )

Removes the set clipping rectangle.

◆ reset_scissor() [2/2]

virtual void clan::GraphicContextProvider::reset_scissor ( )
pure virtual

Reset scissor.

◆ reset_storage_buffer() [1/2]

void clan::GraphicContext::reset_storage_buffer ( int  index)

Remove storage buffer from index.

◆ reset_storage_buffer() [2/2]

virtual void clan::GraphicContextProvider::reset_storage_buffer ( int  index)
pure virtual

Remove storage buffer from index.

◆ reset_texture() [1/2]

void clan::GraphicContext::reset_texture ( int  unit_index)

Remove texture from index.

Parameters
unit_index= 0 to x, the index of the texture

◆ reset_texture() [2/2]

virtual void clan::GraphicContextProvider::reset_texture ( int  unit_index)
pure virtual

Remove texture from unit.

◆ reset_textures()

void clan::GraphicContext::reset_textures ( )

Remove all selected textures.

◆ reset_uniform_buffer() [1/2]

void clan::GraphicContext::reset_uniform_buffer ( int  index)

Remove uniform buffer from index.

◆ reset_uniform_buffer() [2/2]

virtual void clan::GraphicContextProvider::reset_uniform_buffer ( int  index)
pure virtual

Remove uniform buffer from index.

◆ resource()

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

◆ restore()

virtual void clan::DisplayWindowProvider::restore ( )
pure virtual

Restores the window.

◆ screen_to_client()

virtual Point clan::DisplayWindowProvider::screen_to_client ( const Point screen)
pure virtual

Convert from screen coordinates to client coordinates.

◆ set_amplitude()

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

◆ set_attribute() [1/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayBuffer buffer,
int  size,
VertexAttributeDataType  type,
size_t  offset = 0,
int  stride = 0,
bool  normalize = false 
)

◆ set_attribute() [2/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< char > &  buffer,
int  size,
bool  normalize = false 
)
inline

◆ set_attribute() [3/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Colorf > &  buffer 
)
inline

◆ set_attribute() [4/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< float > &  buffer 
)
inline

◆ set_attribute() [5/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< float > &  buffer,
int  size,
bool  normalize = false 
)
inline

◆ set_attribute() [6/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< int > &  buffer,
int  size,
bool  normalize = false 
)
inline

◆ set_attribute() [7/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< short > &  buffer,
int  size,
bool  normalize = false 
)
inline

◆ set_attribute() [8/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< signed char > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [9/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< signed int > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [10/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< signed short > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [11/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< unsigned char > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [12/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< unsigned char > &  buffer,
int  size,
bool  normalize = false 
)
inline

◆ set_attribute() [13/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< unsigned int > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [14/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< unsigned int > &  buffer,
int  size,
bool  normalize = false 
)
inline

◆ set_attribute() [15/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< unsigned short > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [16/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< unsigned short > &  buffer,
int  size,
bool  normalize = false 
)
inline

◆ set_attribute() [17/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec2b > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [18/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec2f > &  buffer 
)
inline

◆ set_attribute() [19/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec2i > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [20/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec2s > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [21/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec2ub > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [22/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec2ui > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [23/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec2us > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [24/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec3b > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [25/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec3f > &  buffer 
)
inline

◆ set_attribute() [26/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec3i > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [27/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec3s > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [28/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec3ub > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [29/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec3ui > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [30/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec3us > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [31/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec4b > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [32/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec4f > &  buffer 
)
inline

◆ set_attribute() [33/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec4i > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [34/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec4s > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [35/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec4ub > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [36/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec4ui > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute() [37/37]

void clan::ShaderEffectDescription::set_attribute ( std::string  name,
VertexArrayVector< Vec4us > &  buffer,
bool  normalize = false 
)
inline

◆ set_attribute_screen_quad()

void clan::ShaderEffectDescription::set_attribute_screen_quad ( std::string  name)

◆ set_attribute_uv_quad()

void clan::ShaderEffectDescription::set_attribute_uv_quad ( std::string  name)

◆ set_attributes() [1/66]

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().

◆ set_attributes() [2/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< char > &  buffer,
int  size,
bool  normalize = false 
)
inline

◆ set_attributes() [3/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Colorf > &  buffer 
)
inline

◆ set_attributes() [4/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< float > &  buffer 
)
inline

◆ set_attributes() [5/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< float > &  buffer,
int  size,
bool  normalize = false 
)
inline

◆ set_attributes() [6/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< int > &  buffer,
int  size,
bool  normalize = false 
)
inline

◆ set_attributes() [7/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< short > &  buffer,
int  size,
bool  normalize = false 
)
inline

◆ set_attributes() [8/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< signed char > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [9/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< signed int > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [10/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< signed short > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [11/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Colorf member_offset 
)
inline

◆ set_attributes() [12/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
float *  member_offset 
)
inline

◆ set_attributes() [13/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
signed char *  member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [14/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
signed int *  member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [15/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
signed short *  member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [16/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
unsigned char *  member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [17/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
unsigned int *  member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [18/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
unsigned short *  member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [19/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec2b member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [20/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec2f member_offset 
)
inline

◆ set_attributes() [21/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec2i member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [22/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec2s member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [23/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec2ub member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [24/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec2ui member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [25/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec2us member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [26/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec3b member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [27/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec3f member_offset 
)
inline

◆ set_attributes() [28/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec3i member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [29/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec3s member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [30/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec3ub member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [31/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec3ui member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [32/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec3us member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [33/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec4b member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [34/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec4f member_offset 
)
inline

◆ set_attributes() [35/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec4i member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [36/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec4s member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [37/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec4ub member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [38/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec4ui member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [39/66]

template<typename Type >
void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Type > &  buffer,
Vec4us member_offset,
bool  normalize = false 
)
inline

◆ set_attributes() [40/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< unsigned char > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [41/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< unsigned char > &  buffer,
int  size,
bool  normalize = false 
)
inline

◆ set_attributes() [42/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< unsigned int > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [43/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< unsigned int > &  buffer,
int  size,
bool  normalize = false 
)
inline

◆ set_attributes() [44/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< unsigned short > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [45/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< unsigned short > &  buffer,
int  size,
bool  normalize = false 
)
inline

◆ set_attributes() [46/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec2b > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [47/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec2f > &  buffer 
)
inline

◆ set_attributes() [48/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec2i > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [49/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec2s > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [50/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec2ub > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [51/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec2ui > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [52/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec2us > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [53/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec3b > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [54/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec3f > &  buffer 
)
inline

◆ set_attributes() [55/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec3i > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [56/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec3s > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [57/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec3ub > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [58/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec3ui > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [59/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec3us > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [60/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec4b > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [61/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec4f > &  buffer 
)
inline

◆ set_attributes() [62/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec4i > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [63/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec4s > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [64/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec4ub > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [65/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec4ui > &  buffer,
bool  normalize = false 
)
inline

◆ set_attributes() [66/66]

void clan::PrimitivesArray::set_attributes ( int  index,
VertexArrayVector< Vec4us > &  buffer,
bool  normalize = false 
)
inline

◆ set_base_level() [1/2]

void clan::Texture::set_base_level ( int  base_level)

Sets the texture base level texture parameter.

◆ set_base_level() [2/2]

virtual void clan::TextureProvider::set_base_level ( int  base_level)
pure virtual

Sets the texture base level texture parameter.

◆ set_batcher()

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.

◆ set_bind_target() [1/2]

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

◆ set_bind_target() [2/2]

virtual void clan::FrameBufferProvider::set_bind_target ( FrameBufferBindTarget  target)
pure virtual

◆ set_blend_equation()

void clan::BlendStateDescription::set_blend_equation ( BlendEquation  color,
BlendEquation  alpha 
)

Set the constant color used in the blend equations.

◆ set_blend_function()

void clan::BlendStateDescription::set_blend_function ( BlendFunc  src,
BlendFunc  dest,
BlendFunc  src_alpha,
BlendFunc  dest_alpha 
)

Set the blend functions.

◆ set_blend_state() [1/3]

virtual void clan::GraphicContextProvider::set_blend_state ( BlendStateProvider state,
const Colorf blend_color,
unsigned int  sample_mask 
)
pure virtual

Set active blend state.

◆ set_blend_state() [2/3]

void clan::Canvas::set_blend_state ( const BlendState state,
const Colorf blend_color = Colorf::white,
unsigned int  sample_mask = 0xffffffff 
)

Set active blend state.

◆ set_blend_state() [3/3]

void clan::GraphicContext::set_blend_state ( const BlendState state,
const Colorf blend_color = Colorf::white,
unsigned int  sample_mask = 0xffffffff 
)

Set active blend state.

◆ set_cached()

void clan::ImageImportDescription::set_cached ( bool  enable)

Controls if this image can be cached.

(This defaults to true)

◆ set_clipboard_image()

virtual void clan::DisplayWindowProvider::set_clipboard_image ( const PixelBuffer buf)
pure virtual

Stores an image in the clipboard.

◆ set_clipboard_text()

virtual void clan::DisplayWindowProvider::set_clipboard_text ( const std::string &  text)
pure virtual

Stores text in the clipboard.

◆ set_cliprect()

void clan::Canvas::set_cliprect ( const Rectf rect)

Set the current clipping rectangle.

◆ set_compute_shader()

void clan::ShaderEffectDescription::set_compute_shader ( std::string  code,
ShaderLanguage  language = shader_glsl 
)

◆ set_culled()

void clan::RasterizerStateDescription::set_culled ( bool  value)

Enables/disables polygon cull clipping.

◆ set_current()

void clan::DisplayTarget::set_current ( )

Set this display target to be the current target.

◆ set_current_target()

static void clan::Display::set_current_target ( const DisplayTarget target)
static

Sets the currently selected display target.

◆ set_cursor() [1/2]

virtual void clan::DisplayWindowProvider::set_cursor ( CursorProvider cursor)
pure virtual

Sets the current cursor icon.

◆ set_cursor() [2/2]

virtual void clan::DisplayWindowProvider::set_cursor ( StandardCursor  type)
pure virtual

Sets the current cursor icon.

◆ set_define()

void clan::ShaderEffectDescription::set_define ( std::string  name,
std::string  value = "1" 
)

◆ set_depth_compare_function()

void clan::DepthStencilStateDescription::set_depth_compare_function ( CompareFunction  func)

Set depth test function.

◆ set_depth_data() [1/2]

void clan::ShaderEffectDescription::set_depth_data ( RenderBuffer  buffer)

◆ set_depth_data() [2/2]

void clan::ShaderEffectDescription::set_depth_data ( Texture  texture)

◆ set_depth_range() [1/4]

void clan::GraphicContext::set_depth_range ( float  n,
float  f 
)

Specifies the depth range for all viewports.

◆ set_depth_range() [2/4]

virtual void clan::GraphicContextProvider::set_depth_range ( float  n,
float  f 
)
pure virtual

Specifies the depth range for all viewports.

◆ set_depth_range() [3/4]

void clan::GraphicContext::set_depth_range ( int  viewport,
float  n,
float  f 
)

Specifies the depth range for the specified viewport.

◆ set_depth_range() [4/4]

virtual void clan::GraphicContextProvider::set_depth_range ( int  viewport,
float  n,
float  f 
)
pure virtual

Specifies the depth range for the specified viewport.

◆ set_depth_stencil_state() [1/3]

void clan::Canvas::set_depth_stencil_state ( const DepthStencilState state,
int  stencil_ref = 0 
)

Set active depth stencil state.

◆ set_depth_stencil_state() [2/3]

void clan::GraphicContext::set_depth_stencil_state ( const DepthStencilState state,
int  stencil_ref = 0 
)

Set active depth stencil state.

◆ set_depth_stencil_state() [3/3]

virtual void clan::GraphicContextProvider::set_depth_stencil_state ( DepthStencilStateProvider state,
int  stencil_ref 
)
pure virtual

Set active depth stencil state.

◆ set_draw_buffer() [1/2]

void clan::GraphicContext::set_draw_buffer ( DrawBuffer  buffer)

Set used draw buffer.

◆ set_draw_buffer() [2/2]

virtual void clan::GraphicContextProvider::set_draw_buffer ( DrawBuffer  buffer)
pure virtual

◆ set_draw_count()

void clan::ShaderEffectDescription::set_draw_count ( int  count)

◆ set_elements() [1/4]

void clan::ShaderEffectDescription::set_elements ( ElementArrayBuffer element_array,
VertexAttributeDataType  indices_type 
)

◆ set_elements() [2/4]

void clan::ShaderEffectDescription::set_elements ( ElementArrayVector< unsigned char > &  element_array)
inline

◆ set_elements() [3/4]

void clan::ShaderEffectDescription::set_elements ( ElementArrayVector< unsigned int > &  element_array)
inline

◆ set_elements() [4/4]

void clan::ShaderEffectDescription::set_elements ( ElementArrayVector< unsigned short > &  element_array)
inline

◆ set_enabled()

virtual void clan::DisplayWindowProvider::set_enabled ( bool  enable)
pure virtual

Enables or disables input into this window.

◆ set_face_cull_mode()

void clan::RasterizerStateDescription::set_face_cull_mode ( CullMode  value)

Sets the polygon cull clipping mode.

◆ set_face_fill_mode()

void clan::RasterizerStateDescription::set_face_fill_mode ( FillMode  value)

Sets the filling mode for polygons.

◆ set_flip_vertical() [1/2]

void clan::PixelConverter::set_flip_vertical ( bool  enable)

Set the flip vertical setting.

This defaults to off.

◆ set_flip_vertical() [2/2]

void clan::ImageImportDescription::set_flip_vertical ( bool  enable)

Set the flip vertical setting.

(This defaults to off)

◆ set_format()

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

◆ set_frag_data() [1/2]

void clan::ShaderEffectDescription::set_frag_data ( std::string  name,
RenderBuffer  buffer 
)

◆ set_frag_data() [2/2]

void clan::ShaderEffectDescription::set_frag_data ( std::string  name,
Texture  texture 
)

◆ set_frag_data_to_back_buffer()

void clan::ShaderEffectDescription::set_frag_data_to_back_buffer ( std::string  name)

◆ set_fragment_shader()

void clan::ShaderEffectDescription::set_fragment_shader ( std::string  code,
ShaderLanguage  language = shader_glsl 
)

◆ set_frame_buffer() [1/3]

void clan::GraphicContext::set_frame_buffer ( const FrameBuffer write_buffer)

Sets the current frame buffer.

◆ set_frame_buffer() [2/3]

void clan::GraphicContext::set_frame_buffer ( const FrameBuffer write_buffer,
const FrameBuffer read_buffer 
)

◆ set_frame_buffer() [3/3]

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.

◆ set_front_face()

void clan::RasterizerStateDescription::set_front_face ( FaceSide  value)

Sets which side is the front side of a face.

◆ set_gamma()

void clan::PixelConverter::set_gamma ( float  gamma)

Set the gamma applied when converting.

This defaults to 1.0 (off).

◆ set_glsl_version()

void clan::ShaderEffectDescription::set_glsl_version ( int  version = 330)

◆ set_image() [1/11]

void clan::PixelBuffer::set_image ( const PixelBuffer source)

Copy source pixel buffer into this buffer, doing a format conversion if needed.

Parameters
sourceSource pixel buffer.

◆ set_image() [2/11]

void clan::PixelBuffer::set_image ( const PixelBuffer source,
PixelConverter converter 
)

Copy source pixel buffer into this buffer, doing a format conversion if needed.

Parameters
sourceSource pixel buffer.

◆ set_image() [3/11]

void clan::Texture2D::set_image ( GraphicContext context,
const PixelBuffer image,
int  level = 0 
)

Upload image to this texture.

Parameters
contextGraphic context to use for the request.
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_image() [4/11]

void clan::Texture2DArray::set_image ( GraphicContext context,
int  array_index,
const PixelBuffer image,
int  level = 0 
)

Upload image to this texture array.

Parameters
contextGraphic context to use for the request.
array_indexIndex in the array to upload the image into.
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_image() [5/11]

void clan::Texture1DArray::set_image ( GraphicContext context,
int  array_index,
PixelBuffer image,
int  level = 0 
)

Upload image to texture.

Parameters
contextGraphic context to use for the request
array_indexIndex in the array
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_image() [6/11]

void clan::TextureCubeArray::set_image ( GraphicContext context,
int  array_index,
TextureCubeDirection  cube_direction,
PixelBuffer image,
int  level = 0 
)

Upload image to texture.

Parameters
contextGraphic context to use for the request
array_indexIndex in the array
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_image() [7/11]

void clan::Texture3D::set_image ( GraphicContext context,
PixelBuffer image,
int  depth,
int  level = 0 
)

Upload image to texture.

Parameters
contextGraphic context to use for the request
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_image() [8/11]

void clan::Texture1D::set_image ( GraphicContext context,
PixelBuffer image,
int  level = 0 
)

Upload image to texture.

Parameters
contextGraphic context to use for the request
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_image() [9/11]

void clan::TextureCube::set_image ( GraphicContext context,
TextureCubeDirection  cube_direction,
PixelBuffer image,
int  level = 0 
)

Upload image to texture.

Parameters
contextGraphic context to use for the request
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_image() [10/11]

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.

◆ set_image() [11/11]

void clan::ShaderEffectDescription::set_image ( std::string  name,
Resource< Texture texture 
)

◆ set_image_texture() [1/3]

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()

◆ set_image_texture() [2/3]

virtual void clan::GraphicContextProvider::set_image_texture ( int  unit_index,
const Texture texture 
)
pure virtual

Select texture into image unit.

◆ set_image_texture() [3/3]

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

◆ set_input_is_ycrcb()

void clan::PixelConverter::set_input_is_ycrcb ( bool  enable)

Converts from JPEG JFIF YCrCb.

◆ set_large_icon()

virtual void clan::DisplayWindowProvider::set_large_icon ( const PixelBuffer image)
pure virtual

Sets the large icon used for this window.

◆ set_lod_bias() [1/2]

virtual void clan::TextureProvider::set_lod_bias ( double  lod_bias)
pure virtual

Sets the level of detail bias constant.

◆ set_lod_bias() [2/2]

void clan::Texture::set_lod_bias ( float  lod_bias)

Sets the level of detail bias constant.

◆ set_logic_op()

void clan::BlendStateDescription::set_logic_op ( LogicOp  op)

Set logic operation. (clanGL only)

◆ set_mag_filter() [1/2]

void clan::Texture::set_mag_filter ( TextureFilter  filter)

Set the magnification filter.

◆ set_mag_filter() [2/2]

virtual void clan::TextureProvider::set_mag_filter ( TextureFilter  filter)
pure virtual

Set the magnification filter.

◆ set_map_mode()

void clan::Canvas::set_map_mode ( MapMode  mode)

Set the projection mapping mode.

◆ set_max_anisotropy() [1/2]

void clan::Texture::set_max_anisotropy ( float  max_anisotropy)

Set the maximum degree of anisotropy.

◆ set_max_anisotropy() [2/2]

virtual void clan::TextureProvider::set_max_anisotropy ( float  v)
pure virtual

Set the maximum degree of anisotropy.

◆ set_max_level() [1/2]

void clan::Texture::set_max_level ( int  max_level)

Sets the texture max level texture parameter.

◆ set_max_level() [2/2]

virtual void clan::TextureProvider::set_max_level ( int  max_level)
pure virtual

Sets the texture max level texture parameter.

◆ set_max_lod() [1/2]

virtual void clan::TextureProvider::set_max_lod ( double  max_lod)
pure virtual

Set the maximum level of detail texture parameter.

◆ set_max_lod() [2/2]

void clan::Texture::set_max_lod ( float  max_lod)

Set the maximum level of detail texture parameter.

◆ set_maximum_size()

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
widthMaximum width of the window.
heightMaximum height of the window.
client_areaSize includes the entire window frame?

◆ set_min_filter() [1/2]

void clan::Texture::set_min_filter ( TextureFilter  filter)

Set the minification filter.

◆ set_min_filter() [2/2]

virtual void clan::TextureProvider::set_min_filter ( TextureFilter  filter)
pure virtual

Set the minification filter.

◆ set_min_lod() [1/2]

virtual void clan::TextureProvider::set_min_lod ( double  min_lod)
pure virtual

Set the minimum level of detail texture parameter.

◆ set_min_lod() [2/2]

void clan::Texture::set_min_lod ( float  min_lod)

Set the minimum level of detail texture parameter.

◆ set_minimum_size()

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
widthMinimum width of the window.
heightMinimum height of the window.
client_areaSize includes the entire window frame?

◆ set_octaves()

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

◆ set_output_is_ycrcb()

void clan::PixelConverter::set_output_is_ycrcb ( bool  enable)

Converts to JPEG JFIF YCrCb.

◆ set_permutations()

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

◆ set_pixel_ratio() [1/4]

void clan::Texture2DArray::set_pixel_ratio ( float  ratio)

Sets the display pixel ratio for this texture.

◆ set_pixel_ratio() [2/4]

void clan::Texture2D::set_pixel_ratio ( float  ratio)

Sets the display pixel ratio for this texture.

◆ set_pixel_ratio() [3/4]

void clan::PixelBuffer::set_pixel_ratio ( float  ratio)

Sets the display pixel ratio for this texture.

◆ set_pixel_ratio() [4/4]

virtual void clan::DisplayWindowProvider::set_pixel_ratio ( float  ratio)
pure virtual

Sets the display pixel ratio of this window.

Parameters
ratioThe new display pixel ratio to use on this window.

◆ set_point_fade_treshold_size()

void clan::RasterizerStateDescription::set_point_fade_treshold_size ( float  )

Alpha fade point once minimum size treshold reached. Requires multisampling to be enabled. (clanGL only)

◆ set_point_size()

void clan::RasterizerStateDescription::set_point_size ( float  )

The default value is 1.0 (clanGL only)

◆ set_point_sprite_origin()

void clan::RasterizerStateDescription::set_point_sprite_origin ( PointSpriteOrigin  origin)

Sets the origin of texture point sprites. (clanGL only)

◆ set_polygon_offset()

void clan::RasterizerStateDescription::set_polygon_offset ( float  factor,
float  units 
)

Sets the offset factor.

◆ set_position()

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.

◆ set_premultiply_alpha() [1/2]

void clan::PixelConverter::set_premultiply_alpha ( bool  enable)

Set the premultiply alpha setting.

This defaults to off.

◆ set_premultiply_alpha() [2/2]

void clan::ImageImportDescription::set_premultiply_alpha ( bool  enable)

Set the premultiply alpha setting.

(This defaults to off)

◆ set_primitives_array() [1/2]

void clan::GraphicContext::set_primitives_array ( const PrimitivesArray array)

Set the primitives array on the gc.

◆ set_primitives_array() [2/2]

virtual void clan::GraphicContextProvider::set_primitives_array ( const PrimitivesArray primitives_array)
pure virtual

Set the primitives array on the gc.

◆ set_primitives_elements() [1/3]

void clan::GraphicContext::set_primitives_elements ( ElementArrayBuffer element_array)

Sets current elements array buffer.

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

◆ set_primitives_elements() [2/3]

virtual void clan::GraphicContextProvider::set_primitives_elements ( ElementArrayBufferProvider array_provider)
pure virtual

Sets current elements array buffer.

◆ set_primitives_elements() [3/3]

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().

◆ set_program_object() [1/5]

void clan::GraphicContext::set_program_object ( const ProgramObject program)

Set active program object.

Parameters
program= Program to set

◆ set_program_object() [2/5]

virtual void clan::GraphicContextProvider::set_program_object ( const ProgramObject program)
pure virtual

Set active program object.

Parameters
program= Program to set

◆ set_program_object() [3/5]

void clan::Canvas::set_program_object ( StandardProgram  standard_program)

Set active program object to the standard program specified.

◆ set_program_object() [4/5]

void clan::GraphicContext::set_program_object ( StandardProgram  standard_program)

Set active program object to the standard program specified.

◆ set_program_object() [5/5]

virtual void clan::GraphicContextProvider::set_program_object ( StandardProgram  standard_program)
pure virtual

Set active program object to the standard program specified.

◆ set_projection()

void clan::Canvas::set_projection ( const Mat4f matrix)

Set the projection matrix to be used in user projection map mode.

◆ set_rasterizer_state() [1/3]

void clan::Canvas::set_rasterizer_state ( const RasterizerState state)

Set active rasterizer state.

◆ set_rasterizer_state() [2/3]

void clan::GraphicContext::set_rasterizer_state ( const RasterizerState state)

Set active rasterizer state.

◆ set_rasterizer_state() [3/3]

virtual void clan::GraphicContextProvider::set_rasterizer_state ( RasterizerStateProvider state)
pure virtual

Set active rasterizer state.

◆ set_scissor() [1/2]

virtual void clan::GraphicContextProvider::set_scissor ( const Rect rect)
pure virtual

Set scissor.

◆ set_scissor() [2/2]

void clan::GraphicContext::set_scissor ( const Rect rect,
TextureImageYAxis  y_axis 
)

Set the current clipping rectangle.

◆ set_size() [1/3]

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

◆ set_size() [2/3]

virtual void clan::DisplayWindowProvider::set_size ( int  width,
int  height,
bool  client_area 
)
pure virtual

Sets the size of this window.

Parameters
widthMinimum width of the window.
heightMinimum height of the window.
client_areaSize includes the entire window frame?

◆ set_size() [3/3]

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

◆ set_small_icon()

virtual void clan::DisplayWindowProvider::set_small_icon ( const PixelBuffer image)
pure virtual

Sets the small icon used for this window.

◆ set_srgb()

void clan::ImageImportDescription::set_srgb ( bool  enable)

Controls if the image is uploaded as a sRGB texture or not.

(This defaults to off)

◆ set_stencil_compare_back()

void clan::DepthStencilStateDescription::set_stencil_compare_back ( CompareFunction  back,
int  back_ref,
int  back_mask 
)

Set stencil compare function.

◆ set_stencil_compare_front()

void clan::DepthStencilStateDescription::set_stencil_compare_front ( CompareFunction  front,
int  front_ref,
int  front_mask 
)

Set stencil compare function.

◆ set_stencil_data() [1/2]

void clan::ShaderEffectDescription::set_stencil_data ( RenderBuffer  buffer)

◆ set_stencil_data() [2/2]

void clan::ShaderEffectDescription::set_stencil_data ( Texture  texture)

◆ set_stencil_op_back()

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.

◆ set_stencil_op_front()

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.

◆ set_stencil_write_mask()

void clan::DepthStencilStateDescription::set_stencil_write_mask ( unsigned char  front_facing_mask,
unsigned char  back_facing_mask 
)

Set stencil write masks.

◆ set_storage()

void clan::ShaderEffectDescription::set_storage ( std::string  name,
Resource< StorageBuffer values 
)

◆ set_storage_buffer() [1/2]

void clan::GraphicContext::set_storage_buffer ( int  index,
const StorageBuffer buffer 
)

Select storage buffer into index.

◆ set_storage_buffer() [2/2]

virtual void clan::GraphicContextProvider::set_storage_buffer ( int  index,
const StorageBuffer buffer 
)
pure virtual

Select storage buffer into index.

◆ set_storage_buffer_index() [1/3]

void clan::ProgramObject::set_storage_buffer_index ( const std::string &  block_name,
int  bind_index 
)

Sets the UniformBuffer.

◆ set_storage_buffer_index() [2/3]

void clan::ProgramObject::set_storage_buffer_index ( int  block_index,
int  bind_index 
)

Sets the UniformBuffer.

◆ set_storage_buffer_index() [3/3]

virtual void clan::ProgramObjectProvider::set_storage_buffer_index ( int  buffer_index,
int  bind_unit_index 
)
pure virtual

◆ set_subimage() [1/13]

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
sourceSource pixel buffer.
dest_rectDestination position for copy.
src_rectSource rectangle for copy.

◆ set_subimage() [2/13]

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
sourceSource pixel buffer.
dest_rectDestination position for copy.
src_rectSource rectangle for copy.

◆ set_subimage() [3/13]

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
contextGraphic context to use for the request.
pointPoint in the texture to write the new sub-texture image. onto.
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_subimage() [4/13]

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
contextGraphic context to use for the request.
array_indexIndex in the array to upload the image into.
pointPoint in the selected texture to write the new sub-texture image onto.
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_subimage() [5/13]

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
contextGraphic context to use for the request
array_indexIndex in the array
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_subimage() [6/13]

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
contextGraphic context to use for the request.
array_indexIndex in the array to upload the image into.
xThe horizontal point in the selected texture to write the new sub-texture image onto.
yThe vertical point in the selected texture to write the sub-texture image onto.
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_subimage() [7/13]

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 
)

◆ set_subimage() [8/13]

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
contextGraphic context to use for the request
array_indexIndex in the array
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_subimage() [9/13]

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
contextGraphic context to use for the request
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_subimage() [10/13]

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
contextGraphic context to use for the request.
xThe horizontal point in the texture to write the new sub-texture image onto.
yThe vertical point in the texture to write the new sub-texture image onto.
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_subimage() [11/13]

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
contextGraphic context to use for the request
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_subimage() [12/13]

void clan::TextureCube::set_subimage ( GraphicContext context,
TextureCubeDirection  cube_direction,
const Point point,
const PixelBuffer image,
const Rect src_rect,
int  level = 0 
)

◆ set_subimage() [13/13]

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
contextGraphic context to use for the request
imageImage to upload.
levelMipmap level-of-detail number.

◆ set_swizzle() [1/2]

void clan::PixelConverter::set_swizzle ( const Vec4i swizzle)

◆ set_swizzle() [2/2]

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.

◆ set_texture() [1/3]

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()

◆ set_texture() [2/3]

virtual void clan::GraphicContextProvider::set_texture ( int  unit_index,
const Texture texture 
)
pure virtual

Select texture into unit.

◆ set_texture() [3/3]

void clan::ShaderEffectDescription::set_texture ( std::string  name,
Resource< Texture texture 
)

◆ set_texture_compare() [1/2]

void clan::Texture::set_texture_compare ( TextureCompareMode  mode,
CompareFunction  func 
)

Sets the texture compare mode and compare function texture parameters.

◆ set_texture_compare() [2/2]

virtual void clan::TextureProvider::set_texture_compare ( TextureCompareMode  mode,
CompareFunction  func 
)
pure virtual

Sets the texture compare mode and compare function texture parameters.

◆ set_textures()

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

◆ set_title()

virtual void clan::DisplayWindowProvider::set_title ( const std::string &  new_title)
pure virtual

Change window title.

◆ set_transform()

void clan::Canvas::set_transform ( const Mat4f matrix)

Sets the transform matrix to a new matrix.

◆ set_uniform1f() [1/3]

void clan::ProgramObject::set_uniform1f ( const std::string &  name,
float  value_a 
)
inline

◆ set_uniform1f() [2/3]

void clan::ProgramObject::set_uniform1f ( int  location,
float  value_a 
)

◆ set_uniform1f() [3/3]

virtual void clan::ProgramObjectProvider::set_uniform1f ( int  location,
float  value_a 
)
pure virtual

◆ set_uniform1i() [1/3]

void clan::ProgramObject::set_uniform1i ( const std::string &  name,
int  value_a 
)
inline

◆ set_uniform1i() [2/3]

void clan::ProgramObject::set_uniform1i ( int  location,
int  value_a 
)

◆ set_uniform1i() [3/3]

virtual void clan::ProgramObjectProvider::set_uniform1i ( int  location,
int  value_a 
)
pure virtual

Set uniform variable(s).

◆ set_uniform2b() [1/2]

void clan::ProgramObject::set_uniform2b ( const std::string &  name,
const Vec2b vec 
)
inline

◆ set_uniform2b() [2/2]

void clan::ProgramObject::set_uniform2b ( int  location,
const Vec2b vec 
)
inline

◆ set_uniform2f() [1/5]

void clan::ProgramObject::set_uniform2f ( const std::string &  name,
const Vec2f vec 
)
inline

◆ set_uniform2f() [2/5]

void clan::ProgramObject::set_uniform2f ( const std::string &  name,
float  value_a,
float  value_b 
)
inline

◆ set_uniform2f() [3/5]

void clan::ProgramObject::set_uniform2f ( int  location,
const Vec2f vec 
)
inline

◆ set_uniform2f() [4/5]

void clan::ProgramObject::set_uniform2f ( int  location,
float  value_a,
float  value_b 
)

◆ set_uniform2f() [5/5]

virtual void clan::ProgramObjectProvider::set_uniform2f ( int  location,
float  value_a,
float  value_b 
)
pure virtual

◆ set_uniform2i() [1/5]

void clan::ProgramObject::set_uniform2i ( const std::string &  name,
const Vec2i vec 
)
inline

◆ set_uniform2i() [2/5]

void clan::ProgramObject::set_uniform2i ( const std::string &  name,
int  value_a,
int  value_b 
)
inline

◆ set_uniform2i() [3/5]

void clan::ProgramObject::set_uniform2i ( int  location,
const Vec2i vec 
)
inline

◆ set_uniform2i() [4/5]

void clan::ProgramObject::set_uniform2i ( int  location,
int  value_a,
int  value_b 
)

◆ set_uniform2i() [5/5]

virtual void clan::ProgramObjectProvider::set_uniform2i ( int  location,
int  value_a,
int  value_b 
)
pure virtual

◆ set_uniform2s() [1/2]

void clan::ProgramObject::set_uniform2s ( const std::string &  name,
const Vec2s vec 
)
inline

◆ set_uniform2s() [2/2]

void clan::ProgramObject::set_uniform2s ( int  location,
const Vec2s vec 
)
inline

◆ set_uniform3b() [1/2]

void clan::ProgramObject::set_uniform3b ( const std::string &  name,
const Vec3b vec 
)
inline

◆ set_uniform3b() [2/2]

void clan::ProgramObject::set_uniform3b ( int  location,
const Vec3b vec 
)
inline

◆ set_uniform3f() [1/5]

void clan::ProgramObject::set_uniform3f ( const std::string &  name,
const Vec3f vec 
)
inline

◆ set_uniform3f() [2/5]

void clan::ProgramObject::set_uniform3f ( const std::string &  name,
float  value_a,
float  value_b,
float  value_c 
)
inline

◆ set_uniform3f() [3/5]

void clan::ProgramObject::set_uniform3f ( int  location,
const Vec3f vec 
)
inline

◆ set_uniform3f() [4/5]

void clan::ProgramObject::set_uniform3f ( int  location,
float  value_a,
float  value_b,
float  value_c 
)

◆ set_uniform3f() [5/5]

virtual void clan::ProgramObjectProvider::set_uniform3f ( int  location,
float  value_a,
float  value_b,
float  value_c 
)
pure virtual

◆ set_uniform3i() [1/5]

void clan::ProgramObject::set_uniform3i ( const std::string &  name,
const Vec3i vec 
)
inline

◆ set_uniform3i() [2/5]

void clan::ProgramObject::set_uniform3i ( const std::string &  name,
int  value_a,
int  value_b,
int  value_c 
)
inline

◆ set_uniform3i() [3/5]

void clan::ProgramObject::set_uniform3i ( int  location,
const Vec3i vec 
)
inline

◆ set_uniform3i() [4/5]

void clan::ProgramObject::set_uniform3i ( int  location,
int  value_a,
int  value_b,
int  value_c 
)

◆ set_uniform3i() [5/5]

virtual void clan::ProgramObjectProvider::set_uniform3i ( int  location,
int  value_a,
int  value_b,
int  value_c 
)
pure virtual

◆ set_uniform3s() [1/2]

void clan::ProgramObject::set_uniform3s ( const std::string &  name,
const Vec3s vec 
)
inline

◆ set_uniform3s() [2/2]

void clan::ProgramObject::set_uniform3s ( int  location,
const Vec3s vec 
)
inline

◆ set_uniform4b() [1/2]

void clan::ProgramObject::set_uniform4b ( const std::string &  name,
const Vec4b vec 
)
inline

◆ set_uniform4b() [2/2]

void clan::ProgramObject::set_uniform4b ( int  location,
const Vec4b vec 
)
inline

◆ set_uniform4f() [1/5]

void clan::ProgramObject::set_uniform4f ( const std::string &  name,
const Vec4f vec 
)
inline

◆ set_uniform4f() [2/5]

void clan::ProgramObject::set_uniform4f ( const std::string &  name,
float  value_a,
float  value_b,
float  value_c,
float  value_d 
)
inline

◆ set_uniform4f() [3/5]

void clan::ProgramObject::set_uniform4f ( int  location,
const Vec4f vec 
)
inline

◆ set_uniform4f() [4/5]

void clan::ProgramObject::set_uniform4f ( int  location,
float  value_a,
float  value_b,
float  value_c,
float  value_d 
)

◆ set_uniform4f() [5/5]

virtual void clan::ProgramObjectProvider::set_uniform4f ( int  location,
float  value_a,
float  value_b,
float  value_c,
float  value_d 
)
pure virtual

◆ set_uniform4i() [1/5]

void clan::ProgramObject::set_uniform4i ( const std::string &  name,
const Vec4i vec 
)
inline

◆ set_uniform4i() [2/5]

void clan::ProgramObject::set_uniform4i ( const std::string &  name,
int  value_a,
int  value_b,
int  value_c,
int  value_d 
)
inline

◆ set_uniform4i() [3/5]

void clan::ProgramObject::set_uniform4i ( int  location,
const Vec4i vec 
)
inline

◆ set_uniform4i() [4/5]

void clan::ProgramObject::set_uniform4i ( int  location,
int  value_a,
int  value_b,
int  value_c,
int  value_d 
)

◆ set_uniform4i() [5/5]

virtual void clan::ProgramObjectProvider::set_uniform4i ( int  location,
int  value_a,
int  value_b,
int  value_c,
int  value_d 
)
pure virtual

◆ set_uniform4s() [1/2]

void clan::ProgramObject::set_uniform4s ( const std::string &  name,
const Vec4s vec 
)
inline

◆ set_uniform4s() [2/2]

void clan::ProgramObject::set_uniform4s ( int  location,
const Vec4s vec 
)
inline

◆ set_uniform_block()

void clan::ShaderEffectDescription::set_uniform_block ( std::string  name,
Resource< UniformBuffer values 
)

◆ set_uniform_buffer() [1/2]

void clan::GraphicContext::set_uniform_buffer ( int  index,
const UniformBuffer buffer 
)

Select uniform buffer into index.

◆ set_uniform_buffer() [2/2]

virtual void clan::GraphicContextProvider::set_uniform_buffer ( int  index,
const UniformBuffer buffer 
)
pure virtual

Select uniform buffer into index.

◆ set_uniform_buffer_index() [1/3]

void clan::ProgramObject::set_uniform_buffer_index ( const std::string &  block_name,
int  bind_index 
)

Sets the UniformBuffer.

◆ set_uniform_buffer_index() [2/3]

void clan::ProgramObject::set_uniform_buffer_index ( int  block_index,
int  bind_index 
)

Sets the UniformBuffer.

◆ set_uniform_buffer_index() [3/3]

virtual void clan::ProgramObjectProvider::set_uniform_buffer_index ( int  block_index,
int  bind_index 
)
pure virtual

◆ set_uniform_matrix() [1/15]

void clan::ProgramObject::set_uniform_matrix ( const std::string &  name,
const Mat2f matrix 
)
inline

◆ set_uniform_matrix() [2/15]

void clan::ProgramObject::set_uniform_matrix ( const std::string &  name,
const Mat3f matrix 
)
inline

◆ set_uniform_matrix() [3/15]

void clan::ProgramObject::set_uniform_matrix ( const std::string &  name,
const Mat4f matrix 
)
inline

◆ set_uniform_matrix() [4/15]

void clan::ProgramObject::set_uniform_matrix ( const std::string &  name,
int  count,
const Mat2f matrix 
)
inline

◆ set_uniform_matrix() [5/15]

void clan::ProgramObject::set_uniform_matrix ( const std::string &  name,
int  count,
const Mat3f matrix 
)
inline

◆ set_uniform_matrix() [6/15]

void clan::ProgramObject::set_uniform_matrix ( const std::string &  name,
int  count,
const Mat4f matrix 
)
inline

◆ set_uniform_matrix() [7/15]

void clan::ProgramObject::set_uniform_matrix ( const std::string &  name,
int  size,
int  count,
bool  transpose,
const float *  data 
)
inline

◆ set_uniform_matrix() [8/15]

void clan::ProgramObject::set_uniform_matrix ( int  location,
const Mat2f matrix 
)
inline

◆ set_uniform_matrix() [9/15]

void clan::ProgramObject::set_uniform_matrix ( int  location,
const Mat3f matrix 
)
inline

◆ set_uniform_matrix() [10/15]

void clan::ProgramObject::set_uniform_matrix ( int  location,
const Mat4f matrix 
)
inline

◆ set_uniform_matrix() [11/15]

void clan::ProgramObject::set_uniform_matrix ( int  location,
int  count,
const Mat2f matrix 
)
inline

◆ set_uniform_matrix() [12/15]

void clan::ProgramObject::set_uniform_matrix ( int  location,
int  count,
const Mat3f matrix 
)
inline

◆ set_uniform_matrix() [13/15]

void clan::ProgramObject::set_uniform_matrix ( int  location,
int  count,
const Mat4f matrix 
)
inline

◆ set_uniform_matrix() [14/15]

void clan::ProgramObject::set_uniform_matrix ( int  location,
int  size,
int  count,
bool  transpose,
const float *  data 
)

◆ set_uniform_matrix() [15/15]

virtual void clan::ProgramObjectProvider::set_uniform_matrix ( int  location,
int  size,
int  count,
bool  transpose,
const float *  data 
)
pure virtual

◆ set_uniformfv() [1/9]

void clan::ProgramObject::set_uniformfv ( const std::string &  name,
int  count,
const Vec2f data 
)
inline

◆ set_uniformfv() [2/9]

void clan::ProgramObject::set_uniformfv ( const std::string &  name,
int  count,
const Vec3f data 
)
inline

◆ set_uniformfv() [3/9]

void clan::ProgramObject::set_uniformfv ( const std::string &  name,
int  count,
const Vec4f data 
)
inline

◆ set_uniformfv() [4/9]

void clan::ProgramObject::set_uniformfv ( const std::string &  name,
int  size,
int  count,
const float *  data 
)
inline

◆ set_uniformfv() [5/9]

void clan::ProgramObject::set_uniformfv ( int  location,
int  count,
const Vec2f data 
)
inline

◆ set_uniformfv() [6/9]

void clan::ProgramObject::set_uniformfv ( int  location,
int  count,
const Vec3f data 
)
inline

◆ set_uniformfv() [7/9]

void clan::ProgramObject::set_uniformfv ( int  location,
int  count,
const Vec4f data 
)
inline

◆ set_uniformfv() [8/9]

void clan::ProgramObject::set_uniformfv ( int  location,
int  size,
int  count,
const float *  data 
)

◆ set_uniformfv() [9/9]

virtual void clan::ProgramObjectProvider::set_uniformfv ( int  location,
int  size,
int  count,
const float *  data 
)
pure virtual

◆ set_uniformiv() [1/9]

void clan::ProgramObject::set_uniformiv ( const std::string &  name,
int  count,
const Vec2i data 
)
inline

◆ set_uniformiv() [2/9]

void clan::ProgramObject::set_uniformiv ( const std::string &  name,
int  count,
const Vec3i data 
)
inline

◆ set_uniformiv() [3/9]

void clan::ProgramObject::set_uniformiv ( const std::string &  name,
int  count,
const Vec4i data 
)
inline

◆ set_uniformiv() [4/9]

void clan::ProgramObject::set_uniformiv ( const std::string &  name,
int  size,
int  count,
const int *  data 
)
inline

◆ set_uniformiv() [5/9]

void clan::ProgramObject::set_uniformiv ( int  location,
int  count,
const Vec2i data 
)
inline

◆ set_uniformiv() [6/9]

void clan::ProgramObject::set_uniformiv ( int  location,
int  count,
const Vec3i data 
)
inline

◆ set_uniformiv() [7/9]

void clan::ProgramObject::set_uniformiv ( int  location,
int  count,
const Vec4i data 
)
inline

◆ set_uniformiv() [8/9]

void clan::ProgramObject::set_uniformiv ( int  location,
int  size,
int  count,
const int *  data 
)

◆ set_uniformiv() [9/9]

virtual void clan::ProgramObjectProvider::set_uniformiv ( int  location,
int  size,
int  count,
const int *  data 
)
pure virtual

◆ set_vertex_shader()

void clan::ShaderEffectDescription::set_vertex_shader ( std::string  code,
ShaderLanguage  language = shader_glsl 
)

◆ set_viewport() [1/4]

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

◆ set_viewport() [2/4]

virtual void clan::GraphicContextProvider::set_viewport ( const Rectf viewport)
pure virtual

Set the viewport to be used in user projection map mode.

◆ set_viewport() [3/4]

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

◆ set_viewport() [4/4]

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.

◆ set_wrap_mode() [1/8]

void clan::Texture1D::set_wrap_mode ( TextureWrapMode  wrap_s)

◆ set_wrap_mode() [2/8]

void clan::Texture1DArray::set_wrap_mode ( TextureWrapMode  wrap_s)

◆ set_wrap_mode() [3/8]

virtual void clan::TextureProvider::set_wrap_mode ( TextureWrapMode  wrap_s)
pure virtual

◆ set_wrap_mode() [4/8]

void clan::Texture2DArray::set_wrap_mode ( TextureWrapMode  wrap_s,
TextureWrapMode  wrap_t 
)

◆ set_wrap_mode() [5/8]

void clan::Texture2D::set_wrap_mode ( TextureWrapMode  wrap_s,
TextureWrapMode  wrap_t 
)

◆ set_wrap_mode() [6/8]

virtual void clan::TextureProvider::set_wrap_mode ( TextureWrapMode  wrap_s,
TextureWrapMode  wrap_t 
)
pure virtual

◆ set_wrap_mode() [7/8]

void clan::Texture3D::set_wrap_mode ( TextureWrapMode  wrap_s,
TextureWrapMode  wrap_t,
TextureWrapMode  wrap_r 
)

Set the texture wrapping mode.

◆ set_wrap_mode() [8/8]

virtual void clan::TextureProvider::set_wrap_mode ( TextureWrapMode  wrap_s,
TextureWrapMode  wrap_t,
TextureWrapMode  wrap_r 
)
pure virtual

Set the texture wrapping mode.

◆ show()

virtual void clan::DisplayWindowProvider::show ( bool  activate)
pure virtual

Displays the window in its current size and position.

◆ show_system_cursor()

virtual void clan::DisplayWindowProvider::show_system_cursor ( )
pure virtual

Shows the mouse cursor.

◆ sig_window_resized()

virtual Signal<void(const Size &)>& clan::GraphicContextProvider::sig_window_resized ( )
pure virtual

Get the window resized signal.

◆ throw_if_null() [1/17]

void clan::PixelBufferSet::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [2/17]

void clan::OcclusionQuery::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [3/17]

void clan::DisplayTarget::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [4/17]

void clan::RenderBuffer::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [5/17]

void clan::TransferBuffer::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [6/17]

void clan::StorageBuffer::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [7/17]

void clan::VertexArrayBuffer::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [8/17]

void clan::ElementArrayBuffer::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [9/17]

void clan::UniformBuffer::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [10/17]

void clan::PrimitivesArray::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [11/17]

void clan::FrameBuffer::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [12/17]

void clan::Canvas::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [13/17]

void clan::PixelBuffer::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [14/17]

void clan::Texture::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [15/17]

void clan::ShaderObject::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [16/17]

void clan::ProgramObject::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ throw_if_null() [17/17]

void clan::GraphicContext::throw_if_null ( ) const

Throw an exception if this object is invalid.

◆ to_cpu()

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.

◆ to_format() [1/2]

PixelBuffer clan::PixelBuffer::to_format ( TextureFormat  texture_format) const

Converts current buffer to a new pixel format and returns the result.

◆ to_format() [2/2]

PixelBuffer clan::PixelBuffer::to_format ( TextureFormat  texture_format,
PixelConverter converter 
) const

Converts current buffer to a new pixel format and returns the result.

◆ to_gpu()

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.

◆ to_texture_1d()

Texture1D clan::Texture::to_texture_1d ( ) const

Dynamic cast to Texture1D.

◆ to_texture_1d_array()

Texture1DArray clan::Texture::to_texture_1d_array ( ) const

Dynamic cast to Texture1DArray.

◆ to_texture_2d()

Texture2D clan::Texture::to_texture_2d ( ) const

Dynamic cast to Texture2D.

◆ to_texture_2d_array()

Texture2DArray clan::Texture::to_texture_2d_array ( ) const

Dynamic cast to Texture2DArray.

◆ to_texture_3d()

Texture3D clan::Texture::to_texture_3d ( ) const

Dynamic cast to Texture3D.

◆ to_texture_cube()

TextureCube clan::Texture::to_texture_cube ( ) const

Dynamic cast to TextureCube.

◆ to_texture_cube_array()

TextureCubeArray clan::Texture::to_texture_cube_array ( ) const

Dynamic cast to TextureCubeArray.

◆ unlock() [1/5]

void clan::TransferBuffer::unlock ( )

Unmaps buffer.

◆ unlock() [2/5]

template<typename Type >
void clan::PixelBufferLock< Type >::unlock ( )
inline

Unlock pixel_buffer.

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

◆ unlock() [3/5]

void clan::PixelBuffer::unlock ( )

◆ unlock() [4/5]

virtual void clan::TransferBufferProvider::unlock ( )
pure virtual

Unmaps buffer.

◆ unlock() [5/5]

virtual void clan::PixelBufferProvider::unlock ( )
pure virtual

Unmaps element buffer.

◆ update()

virtual void clan::DisplayWindowProvider::update ( const Rect rect)
pure virtual

Copy a region of the backbuffer to the frontbuffer.

◆ upload_data() [1/22]

void clan::PixelBuffer::upload_data ( GraphicContext gc,
const Rect dest_rect,
const void *  data 
)

Uploads data to buffer.

◆ upload_data() [2/22]

virtual void clan::PixelBufferProvider::upload_data ( GraphicContext gc,
const Rect dest_rect,
const void *  data 
)
pure virtual

Uploads data to buffer.

◆ upload_data() [3/22]

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().

◆ upload_data() [4/22]

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().

◆ upload_data() [5/22]

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().

◆ upload_data() [6/22]

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().

◆ upload_data() [7/22]

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().

◆ upload_data() [8/22]

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().

◆ upload_data() [9/22]

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().

◆ upload_data() [10/22]

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().

◆ upload_data() [11/22]

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().

◆ upload_data() [12/22]

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.

◆ upload_data() [13/22]

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.

◆ upload_data() [14/22]

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.

◆ upload_data() [15/22]

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().

◆ upload_data() [16/22]

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().

◆ upload_data() [17/22]

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().

◆ upload_data() [18/22]

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().

◆ upload_data() [19/22]

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().

◆ upload_data() [20/22]

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().

◆ upload_data() [21/22]

virtual void clan::VertexArrayBufferProvider::upload_data ( GraphicContext gc,
int  offset,
const void *  data,
int  size 
)
pure virtual

Uploads data to vertex array buffer.

◆ upload_data() [22/22]

virtual void clan::TransferBufferProvider::upload_data ( GraphicContext gc,
int  offset,
const void *  data,
int  size 
)
pure virtual

Uploads data to buffer.

◆ validate() [1/2]

bool clan::ProgramObject::validate ( )

Validate program.

If the validation fails, get_info_log() will return the validation log.

◆ validate() [2/2]

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.

Variable Documentation

◆ func_minimize_clicked

std::function<bool()> clan::DisplayWindowSite::func_minimize_clicked

Minimize button is clicked callback function.

◆ func_window_resize

std::function<void(Rectf &)> clan::DisplayWindowSite::func_window_resize

Window resize callback function.

◆ impl

std::shared_ptr<Texture_Impl> clan::Texture::impl
protected

◆ pixelcenter_constant

const float clan::pixelcenter_constant = 0.375f

◆ sig_got_focus

Signal<void()> clan::DisplayWindowSite::sig_got_focus

Obtained focus signal.

◆ sig_lost_focus

Signal<void()> clan::DisplayWindowSite::sig_lost_focus

Lost focus signal.

◆ sig_paint

Signal<void(const Rectf &)> clan::DisplayWindowSite::sig_paint

Paint signal.

◆ sig_resize

Signal<void(float, float)> clan::DisplayWindowSite::sig_resize

Resize signal.

◆ sig_window_close

Signal<void()> clan::DisplayWindowSite::sig_window_close

Window close signal.

◆ sig_window_destroy

Signal<void()> clan::DisplayWindowSite::sig_window_destroy

Window destroy signal.

◆ sig_window_maximized

Signal<void()> clan::DisplayWindowSite::sig_window_maximized

Window maximized signal.

◆ sig_window_minimized

Signal<void()> clan::DisplayWindowSite::sig_window_minimized

Window minimized signal.

◆ sig_window_moved

Signal<void()> clan::DisplayWindowSite::sig_window_moved

Window moved signal.

◆ sig_window_restored

Signal<void()> clan::DisplayWindowSite::sig_window_restored

Window restored signal.

Friends

◆ DisplayTarget_Impl

friend class DisplayTarget_Impl
friend

◆ Font_DrawFlat

friend class Font_DrawFlat
friend

◆ Font_DrawScaled

friend class Font_DrawScaled
friend

◆ Font_DrawSubPixel

friend class Font_DrawSubPixel
friend

◆ Font_Impl

friend class Font_Impl
friend

◆ Image

friend class Image
friend

◆ OpenGL

friend class OpenGL
friend

◆ Path

friend class Path
friend

◆ PixelBuffer_Impl

friend class PixelBuffer_Impl
friend

◆ ShaderEffect

friend class ShaderEffect
friend

◆ Sprite_Impl

friend class Sprite_Impl
friend

◆ Texture2DArray

friend class Texture2DArray
friend