clanDisplay Display

Classes
class	CL_BlendMode
	Blend mode description. More...
class	CL_BufferControl
	Container class for states related to reading, writing and tests performed on buffers. More...
class	CL_CursorProvider
	Interface for implementing a CL_Cursor target. More...
class	CL_Display
	Top level display class. More...
class	CL_DisplayTarget
	Display target for clanDisplay. More...
class	CL_DisplayTargetProvider
	Interface for implementing a CL_DisplayTarget target. More...
class	CL_DisplayWindowProvider
	Interface for implementing a CL_DisplayWindow target. More...
class	CL_DisplayWindowSite
	Display Window site. More...
class	CL_ElementArrayBuffer
	Element Array Buffer. More...
class	CL_ElementArrayBufferProvider
	Element Array Buffer provider. More...
class	CL_FontProvider
	Interface for implementing a CL_Font target. More...
class	CL_FrameBuffer
	Frame-buffer object class. More...
class	CL_FrameBufferProvider
	Interface for implementing a CL_FrameBuffer target. More...
class	CL_GraphicContext
	Interface to drawing graphics. More...
class	CL_GraphicContextProvider
	Interface for implementing a CL_GraphicContext target. More...
class	CL_IconSet
	Icon set class. More...
class	CL_ImageImportDescription
	Image Import Description Class. More...
class	CL_OcclusionQuery
	Graphics occlusion query class. More...
class	CL_Palette
	256 color ARGB palette class. More...
class	CL_Pen
	Pen description class. More...
class	CL_PerlinNoise
	Perlin Noise Generator class. More...
class	CL_PixelBuffer
	Pixel data container. More...
class	CL_PixelBufferHelp
	Pixel data helper class. More...
class	CL_PixelBufferProvider
	Element Array Buffer provider. More...
class	CL_PixelFormat
	Pixel utility functions. More...
class	CL_PolygonRasterizer
	Polygon rasterization description. More...
class	CL_PrimitivesArray
	Primitives array description. More...
class	CL_PrimitivesArrayBuilder
	Primitives array builder class. More...
class	CL_PrimitivesArrayData
	Primitives array data supplied to clanDisplay provider objects. More...
class	CL_ProgramAttribute
	OpenGL program object vertex attribute information class. More...
class	CL_ProgramObject
	OpenGL Program Object. More...
class	CL_ProgramObjectProvider
	Program Object provider. More...
class	CL_ProgramUniform
	OpenGL program object uniform variable. More...
class	CL_RenderBatcher
	Render batching abstraction. More...
class	CL_RenderBuffer
	Render-buffer object class. More...
class	CL_RenderBufferProvider
	Interface for implementing a CL_RenderBuffer target. More...
class	CL_RenderWindowProvider
	Provides generic render window services for clanDisplay. More...
class	CL_ScreenInfo
	Screen Information class. More...
class	CL_ShaderObject
	Shader Object. More...
class	CL_ShaderObjectProvider
	Shader Object provider. More...
class	CL_SharedGCData
	Shared Graphic Context Data. More...
class	CL_Texture
	Texture object class. More...
class	CL_TextureProvider
	Interface for implementing a CL_Texture target. More...
class	CL_VertexArrayBuffer
	Vertex Array Buffer. More...
class	CL_VertexArrayBufferProvider
	Vertex Array Buffer provider. More...

Macros
#define	cl_pixelcenter_constant   0.375f
#define	header_render_window_provider

Enumerations
enum	CL_BlendEquation {   cl_blend_equation_add, cl_blend_equation_subtract, cl_blend_equation_reverse_subtract, cl_blend_equation_min,   cl_blend_equation_max }
	Blending equations. More...
enum	CL_BlendFunc {   cl_blend_zero, cl_blend_one, cl_blend_dest_color, cl_blend_src_color,   cl_blend_one_minus_dest_color, cl_blend_one_minus_src_color, cl_blend_src_alpha, cl_blend_one_minus_src_alpha,   cl_blend_dest_alpha, cl_blend_one_minus_dest_alpha, cl_blend_src_alpha_saturate, cl_blend_constant_color,   cl_blend_one_minus_constant_color, cl_blend_constant_alpha, cl_blend_one_minus_constant_alpha }
	Blending functions. More...
enum	CL_BufferAccess { cl_access_read_only, cl_access_write_only, cl_access_read_write }
	Array Buffer access enum. More...
enum	CL_BufferUsage {   cl_usage_stream_draw, cl_usage_stream_read, cl_usage_stream_copy, cl_usage_static_draw,   cl_usage_static_read, cl_usage_static_copy, cl_usage_dynamic_draw, cl_usage_dynamic_read,   cl_usage_dynamic_copy }
	Array Buffer usage enum. More...
enum	CL_CompareFunction {   cl_comparefunc_lequal, cl_comparefunc_gequal, cl_comparefunc_less, cl_comparefunc_greater,   cl_comparefunc_equal, cl_comparefunc_notequal, cl_comparefunc_always, cl_comparefunc_never }
	Compare functions. More...
enum	CL_CullMode { cl_cull_front, cl_cull_back, cl_cull_front_and_back }
	Polygon culling modes. More...
enum	CL_DrawBuffer {   cl_buffer_none, cl_buffer_front_left, cl_buffer_front_right, cl_buffer_back_left,   cl_buffer_back_right, cl_buffer_front, cl_buffer_back, cl_buffer_left,   cl_buffer_right, cl_buffer_front_and_back }
	Drawing buffers. More...
enum	CL_FaceSide { cl_face_side_clockwise, cl_face_side_counter_clockwise }
	Front face modes. More...
enum	CL_FillMode { cl_fill_point, cl_fill_line, cl_fill_polygon }
	Polygon filling modes. More...
enum	CL_FrameBufferBindTarget { cl_framebuffer_draw, cl_framebuffer_read }
	Framebuffer bind target. More...
enum	CL_LogicOp {   cl_logic_op_clear, cl_logic_op_and, cl_logic_op_and_reverse, cl_logic_op_copy,   cl_logic_op_and_inverted, cl_logic_op_noop, cl_logic_op_xor, cl_logic_op_or,   cl_logic_op_nor, cl_logic_op_equiv, cl_logic_op_invert, cl_logic_op_or_reverse,   cl_logic_op_copy_inverted, cl_logic_op_or_inverted, cl_logic_op_nand, cl_logic_op_set }
	Logic Op. More...
enum	CL_MapMode { cl_map_2d_upper_left, cl_map_2d_lower_left, cl_user_projection }
	Mapping modes. More...
enum	CL_PixelBufferDirection { cl_data_to_gpu, cl_data_from_gpu }
	Pixel buffer prefered direction. More...
enum	CL_PointSpriteOrigin { cl_point_sprite_origin_upper_left, cl_point_sprite_origin_lower_left }
	Point Sprite Origin. More...
enum	CL_PrimitivesType {   cl_points, cl_line_strip, cl_line_loop, cl_lines,   cl_triangle_strip, cl_triangle_fan, cl_triangles }
	Primitive types. More...
enum	CL_ProgramMatrixFlags {   cl_program_matrix_none = 0, cl_program_matrix_modelview = 0x1, cl_program_matrix_projection = 0x2, cl_program_matrix_modelview_projection = 0x4,   cl_program_matrix_normal = 0x8, cl_program_matrix_all_standard = cl_program_matrix_modelview | cl_program_matrix_projection | cl_program_matrix_modelview_projection | cl_program_matrix_normal }
	Program Object Matrix Flags. More...
enum	CL_ShaderType { cl_shadertype_vertex, cl_shadertype_geometry, cl_shadertype_fragment }
	Shader Type. More...
enum	CL_StandardAttributeIndex {   cl_attrib_position = 0, cl_attrib_color = 1, cl_attrib_texture_position = 2, cl_attrib_texture_index = 3,   cl_attrib_normal = 4 }
	Standard Attribute Index. More...
enum	CL_StandardProgram { cl_program_color_only, cl_program_single_texture, cl_program_sprite }
	Standard Program. More...
enum	CL_StencilOp {   cl_stencil_keep, cl_stencil_zero, cl_stencil_replace, cl_stencil_incr,   cl_stencil_decr, cl_stencil_invert, cl_stencil_incr_wrap, cl_stencil_decr_wrap }
	Stencil operations. More...
enum	CL_TextureCompareMode { cl_comparemode_none, cl_comparemode_compare_r_to_texture }
	Texture compare modes. More...
enum	CL_TextureDimensions { cl_texture_1d, cl_texture_2d, cl_texture_3d, cl_texture_cube_map }
	Texture dimensions. More...
enum	CL_TextureFilter {   cl_filter_nearest, cl_filter_linear, cl_filter_nearest_mipmap_nearest, cl_filter_nearest_mipmap_linear,   cl_filter_linear_mipmap_nearest, cl_filter_linear_mipmap_linear }
	Texture filters. More...
enum	CL_TextureFormat {   cl_rgba8, cl_rgb8, cl_bgr8, cl_a1_rgb5,   cl_argb8, cl_abgr8, cl_color_index, cl_stencil_index,   cl_depth_component, cl_depth_stencil, cl_red, cl_green,   cl_blue, cl_rg, cl_rgb, cl_rgba,   cl_bgr, cl_bgra, cl_red_integer, cl_green_integer,   cl_blue_integer, cl_rg_integer, cl_rgb_integer, cl_rgba_integer,   cl_bgr_integer, cl_bgra_integer, cl_stencil_index1, cl_stencil_index4,   cl_stencil_index8, cl_stencil_index16, cl_r8, cl_r8_snorm,   cl_r16, cl_r16_snorm, cl_rg8, cl_rg8_snorm,   cl_rg16, cl_rg16_snorm, cl_r3_g3_b2, cl_rgb4,   cl_rgb5, cl_rgb8_snorm, cl_rgb10, cl_rgb12,   cl_rgb16, cl_rgb16_snorm, cl_rgba2, cl_rgba4,   cl_rgb5_a1, cl_rgba8_snorm, cl_rgb10_a2, cl_rgba12,   cl_rgba16, cl_rgba16_snorm, cl_srgb8, cl_srgb8_alpha8,   cl_r16f, cl_rg16f, cl_rgb16f, cl_rgba16f,   cl_r32f, cl_rg32f, cl_rgb32f, cl_rgba32f,   cl_r11f_g11f_b10f, cl_rgb9_e5, cl_r8i, cl_r8ui,   cl_r16i, cl_r16ui, cl_r32i, cl_r32ui,   cl_rg8i, cl_rg8ui, cl_rg16i, cl_rg16ui,   cl_rg32i, cl_rg32ui, cl_rgb8i, cl_rgb8ui,   cl_rgb16i, cl_rgb16ui, cl_rgb32i, cl_rgb32ui,   cl_rgba8i, cl_rgba8ui, cl_rgba16i, cl_rgba16ui,   cl_rgba32i, cl_rgba32ui, cl_depth_component16, cl_depth_component24,   cl_depth_component32, cl_depth_component32f, cl_depth24_stencil8, cl_depth32f_stencil8,   cl_compressed_red, cl_compressed_rg, cl_compressed_rgb, cl_compressed_rgba,   cl_compressed_srgb, cl_compressed_srgb_alpha, cl_compressed_red_rgtc1, cl_compressed_signed_red_rgtc1,   cl_compressed_rg_rgtc2, cl_compressed_signed_rg_rgtc2 }
	Texture format. More...
enum	CL_TextureSubtype {   cl_subtype_cube_map_positive_x, cl_subtype_cube_map_negative_x, cl_subtype_cube_map_positive_y, cl_subtype_cube_map_negative_y,   cl_subtype_cube_map_positive_z, cl_subtype_cube_map_negative_z }
	Texture Subtype. More...
enum	CL_TextureWrapMode { cl_wrap_clamp_to_edge, cl_wrap_repeat, cl_wrap_mirrored_repeat }
	Texture coordinate wrapping modes. More...
enum	CL_VertexAttributeDataType {   cl_type_unsigned_byte, cl_type_unsigned_short, cl_type_unsigned_int, cl_type_byte,   cl_type_short, cl_type_int, cl_type_float }
	Primitives array description. More...

Detailed Description

Macro Definition Documentation

#define cl_pixelcenter_constant   0.375f

#define header_render_window_provider

Enumeration Type Documentation

enum CL_BlendEquation

Blending equations.

Enumerator
cl_blend_equation_add
cl_blend_equation_subtract
cl_blend_equation_reverse_subtract
cl_blend_equation_min
cl_blend_equation_max

enum CL_BlendFunc

Blending functions.

Enumerator
cl_blend_zero	source or destination (0, 0, 0, 0)
cl_blend_one	source or destination (1, 1, 1, 1)
cl_blend_dest_color	source (Rd, Gd, Bd, Ad)
cl_blend_src_color	destination (Rs, Gs, Bs, As)
cl_blend_one_minus_dest_color	source (1, 1, 1, 1) - (Rd, Gd, Bd, Ad)
cl_blend_one_minus_src_color	destination (1, 1, 1, 1) - (Rs, Gs, Bs, As)
cl_blend_src_alpha	source or destination (As, As, As, As)
cl_blend_one_minus_src_alpha	source or destination (1, 1, 1, 1) - (As, As, As, As)
cl_blend_dest_alpha	source or destination (Ad, Ad, Ad, Ad)
cl_blend_one_minus_dest_alpha	source or destination (1, 1, 1, 1) - (Ad, Ad, Ad, Ad)
cl_blend_src_alpha_saturate	source (f, f, f, 1) - f = min(As, 1 - Ad)
cl_blend_constant_color	source or destination (Rc, Gc, Bc, Ac)
cl_blend_one_minus_constant_color	source or destination (1, 1, 1, 1) - (Rc, Gc, Bc, Ac)
cl_blend_constant_alpha	source or destination (Ac, Ac, Ac, Ac)
cl_blend_one_minus_constant_alpha	source or destination (1, 1, 1, 1) - (Ac, Ac, Ac, Ac)

enum CL_BufferAccess

Array Buffer access enum.

Enumerator
cl_access_read_only
cl_access_write_only
cl_access_read_write

enum CL_BufferUsage

Array Buffer usage enum.

Enumerator
cl_usage_stream_draw
cl_usage_stream_read
cl_usage_stream_copy
cl_usage_static_draw
cl_usage_static_read
cl_usage_static_copy
cl_usage_dynamic_draw
cl_usage_dynamic_read
cl_usage_dynamic_copy

enum CL_CompareFunction

Compare functions.

Enumerator
cl_comparefunc_lequal
cl_comparefunc_gequal
cl_comparefunc_less
cl_comparefunc_greater
cl_comparefunc_equal
cl_comparefunc_notequal
cl_comparefunc_always
cl_comparefunc_never

enum CL_CullMode

Polygon culling modes.

Enumerator
cl_cull_front
cl_cull_back
cl_cull_front_and_back

enum CL_DrawBuffer

Drawing buffers.

Enumerator
cl_buffer_none
cl_buffer_front_left
cl_buffer_front_right
cl_buffer_back_left
cl_buffer_back_right
cl_buffer_front
cl_buffer_back
cl_buffer_left
cl_buffer_right
cl_buffer_front_and_back

enum CL_FaceSide

Front face modes.

Enumerator
cl_face_side_clockwise
cl_face_side_counter_clockwise

enum CL_FillMode

Polygon filling modes.

Enumerator
cl_fill_point
cl_fill_line
cl_fill_polygon

enum CL_FrameBufferBindTarget

Framebuffer bind target.

Enumerator
cl_framebuffer_draw
cl_framebuffer_read

enum CL_LogicOp

Logic Op.

Enumerator
cl_logic_op_clear
cl_logic_op_and
cl_logic_op_and_reverse
cl_logic_op_copy
cl_logic_op_and_inverted
cl_logic_op_noop
cl_logic_op_xor
cl_logic_op_or
cl_logic_op_nor
cl_logic_op_equiv
cl_logic_op_invert
cl_logic_op_or_reverse
cl_logic_op_copy_inverted
cl_logic_op_or_inverted
cl_logic_op_nand
cl_logic_op_set

enum CL_MapMode

Mapping modes.

Enumerator
cl_map_2d_upper_left
cl_map_2d_lower_left
cl_user_projection

enum CL_PixelBufferDirection

Pixel buffer prefered direction.

Enumerator
cl_data_to_gpu	Use of the pixel buffer is to send data to the gpu.
cl_data_from_gpu	Use of the pixel buffer is to retrieve data from the gpu.

enum CL_PointSpriteOrigin

Point Sprite Origin.

Enumerator
cl_point_sprite_origin_upper_left
cl_point_sprite_origin_lower_left

enum CL_PrimitivesType

Primitive types.

Enumerator
cl_points
cl_line_strip
cl_line_loop
cl_lines
cl_triangle_strip
cl_triangle_fan
cl_triangles

enum CL_ProgramMatrixFlags

Program Object Matrix Flags.

These defines determine which matricies will be set in the program object

Enumerator
cl_program_matrix_none
cl_program_matrix_modelview	cl_ModelViewMatrix (mat4)
cl_program_matrix_projection	cl_ProjectionMatrix (mat4)
cl_program_matrix_modelview_projection	cl_ModelViewProjectionMatrix (mat4)
cl_program_matrix_normal	cl_NormalMatrix (mat3 - inverse of cl_ModelViewMatrix)
cl_program_matrix_all_standard	All the standard OpenGL uniforms.

enum CL_ShaderType

Shader Type.

Enumerator
cl_shadertype_vertex
cl_shadertype_geometry
cl_shadertype_fragment

enum CL_StandardAttributeIndex

Standard Attribute Index.

These can be used within CL_Primitives array when you are using CL_StandardProgram.

Enumerator
cl_attrib_position
cl_attrib_color
cl_attrib_texture_position
cl_attrib_texture_index
cl_attrib_normal

enum CL_StandardProgram

Standard Program.

See "CL_StandardAttributeIndex" if using the standard program with CL_PrimitivesArray

Enumerator
cl_program_color_only
cl_program_single_texture
cl_program_sprite

enum CL_StencilOp

Stencil operations.

Enumerator
cl_stencil_keep
cl_stencil_zero
cl_stencil_replace
cl_stencil_incr
cl_stencil_decr
cl_stencil_invert
cl_stencil_incr_wrap
cl_stencil_decr_wrap

enum CL_TextureCompareMode

Texture compare modes.

Enumerator
cl_comparemode_none
cl_comparemode_compare_r_to_texture

enum CL_TextureDimensions

Texture dimensions.

Enumerator
cl_texture_1d
cl_texture_2d
cl_texture_3d
cl_texture_cube_map

enum CL_TextureFilter

Texture filters.

Enumerator
cl_filter_nearest
cl_filter_linear
cl_filter_nearest_mipmap_nearest
cl_filter_nearest_mipmap_linear
cl_filter_linear_mipmap_nearest
cl_filter_linear_mipmap_linear

enum CL_TextureFormat

Texture format.

Enumerator
cl_rgba8
cl_rgb8
cl_bgr8
cl_a1_rgb5
cl_argb8
cl_abgr8
cl_color_index
cl_stencil_index
cl_depth_component
cl_depth_stencil
cl_red
cl_green
cl_blue
cl_rg
cl_rgb
cl_rgba
cl_bgr
cl_bgra
cl_red_integer
cl_green_integer
cl_blue_integer
cl_rg_integer
cl_rgb_integer
cl_rgba_integer
cl_bgr_integer
cl_bgra_integer
cl_stencil_index1
cl_stencil_index4
cl_stencil_index8
cl_stencil_index16
cl_r8
cl_r8_snorm
cl_r16
cl_r16_snorm
cl_rg8
cl_rg8_snorm
cl_rg16
cl_rg16_snorm
cl_r3_g3_b2
cl_rgb4
cl_rgb5
cl_rgb8_snorm
cl_rgb10
cl_rgb12
cl_rgb16
cl_rgb16_snorm
cl_rgba2
cl_rgba4
cl_rgb5_a1
cl_rgba8_snorm
cl_rgb10_a2
cl_rgba12
cl_rgba16
cl_rgba16_snorm
cl_srgb8
cl_srgb8_alpha8
cl_r16f
cl_rg16f
cl_rgb16f
cl_rgba16f
cl_r32f
cl_rg32f
cl_rgb32f
cl_rgba32f
cl_r11f_g11f_b10f
cl_rgb9_e5
cl_r8i
cl_r8ui
cl_r16i
cl_r16ui
cl_r32i
cl_r32ui
cl_rg8i
cl_rg8ui
cl_rg16i
cl_rg16ui
cl_rg32i
cl_rg32ui
cl_rgb8i
cl_rgb8ui
cl_rgb16i
cl_rgb16ui
cl_rgb32i
cl_rgb32ui
cl_rgba8i
cl_rgba8ui
cl_rgba16i
cl_rgba16ui
cl_rgba32i
cl_rgba32ui
cl_depth_component16
cl_depth_component24
cl_depth_component32
cl_depth_component32f
cl_depth24_stencil8
cl_depth32f_stencil8
cl_compressed_red
cl_compressed_rg
cl_compressed_rgb
cl_compressed_rgba
cl_compressed_srgb
cl_compressed_srgb_alpha
cl_compressed_red_rgtc1
cl_compressed_signed_red_rgtc1
cl_compressed_rg_rgtc2
cl_compressed_signed_rg_rgtc2

enum CL_TextureSubtype

Texture Subtype.

Enumerator
cl_subtype_cube_map_positive_x
cl_subtype_cube_map_negative_x
cl_subtype_cube_map_positive_y
cl_subtype_cube_map_negative_y
cl_subtype_cube_map_positive_z
cl_subtype_cube_map_negative_z

enum CL_TextureWrapMode

Texture coordinate wrapping modes.

Enumerator
cl_wrap_clamp_to_edge
cl_wrap_repeat
cl_wrap_mirrored_repeat

enum CL_VertexAttributeDataType

Primitives array description.

Enumerator
cl_type_unsigned_byte
cl_type_unsigned_short
cl_type_unsigned_int
cl_type_byte
cl_type_short
cl_type_int
cl_type_float