# Pigment API reference sections

# please add sections in alphabetical order using the following template
# leave two empty lines between sections
# <SECTION>
# <FILE>pgmxxx</FILE>
# <TITLE>PgmXxx</TITLE>
# typedefs
# macros
# constructor
# methods
# <SUBSECTION Standard>
# <SUBSECTION Private>
# </SECTION>

<INCLUDE>pgm/pgm.h</INCLUDE>

<SECTION>
<FILE>pgm</FILE>
<TITLE>Pgm</TITLE>
pgm_init
pgm_init_check
pgm_deinit
pgm_version
pgm_version_string
pgm_events_pending
pgm_main
pgm_main_quit
pgm_main_iteration
pgm_main_iteration_do
<SUBSECTION Private>
</SECTION>


<SECTION>
<FILE>pgmcanvas</FILE>
<TITLE>PgmCanvas</TITLE>
PgmCanvas
pgm_canvas_new
pgm_canvas_set_size
pgm_canvas_get_size
pgm_canvas_add
pgm_canvas_remove
pgm_canvas_add_many
pgm_canvas_remove_many
pgm_canvas_set_order
pgm_canvas_get_order
pgm_canvas_get_layer_count
pgm_canvas_regenerate
pgm_canvas_get_pixel_formats
<SUBSECTION Standard>
PGM_CANVAS
PGM_IS_CANVAS
PGM_TYPE_CANVAS
PGM_CANVAS_CLASS
PGM_IS_CANVAS_CLASS
PGM_CANVAS_GET_CLASS
<SUBSECTION Private>
pgm_canvas_get_type
PgmCanvasClass
</SECTION>


<SECTION>
<FILE>pgmcommon</FILE>
<TITLE>PgmCommon</TITLE>
PGM_DEGREES_TO_RADIANS
PGM_RADIANS_TO_DEGREES
PGM_SINCOS
PGM_FABSF
PgmError
<SUBSECTION Private>
PGM_PADDING
</SECTION>


<SECTION>
<FILE>pgmdrawable</FILE>
<TITLE>PgmDrawable</TITLE>
PgmDrawableLayer
PgmDrawableProperty
PgmDrawable
PgmDrawableClass
pgm_drawable_hide
pgm_drawable_show
pgm_drawable_is_visible
pgm_drawable_set_size
pgm_drawable_get_size
pgm_drawable_set_position
pgm_drawable_get_position
pgm_drawable_set_rotation_x
pgm_drawable_get_rotation_x
pgm_drawable_set_rotation_y
pgm_drawable_get_rotation_y
pgm_drawable_set_rotation_z
pgm_drawable_get_rotation_z
pgm_drawable_set_fg_color
pgm_drawable_get_fg_color
pgm_drawable_set_bg_color
pgm_drawable_get_bg_color
pgm_drawable_set_opacity
pgm_drawable_get_opacity
pgm_drawable_regenerate
pgm_drawable_from_canvas
pgm_drawable_to_canvas
<SUBSECTION Standard>
PGM_DRAWABLE
PGM_IS_DRAWABLE
PGM_TYPE_DRAWABLE
PGM_DRAWABLE_CLASS
PGM_IS_DRAWABLE_CLASS
PGM_DRAWABLE_GET_CLASS
<SUBSECTION Private>
PgmDrawableFlags
PgmDrawablePickingSignal
pgm_drawable_get_type
</SECTION>


<SECTION>
<FILE>pgmevents</FILE>
<TITLE>PgmEvents</TITLE>
PgmEventType
PgmModifierType
PgmButtonType
PgmScrollDirection
PgmEvent
PgmEventAny
PgmEventMotion
PgmEventButton
PgmEventScroll
PgmEventDnd
PgmEventKey
PgmEventExpose
PgmEventConfigure
pgm_event_new
pgm_event_copy
pgm_event_free
pgm_keyval_to_unicode
<SUBSECTION Standard>
PGM_TYPE_EVENT
<SUBSECTION Private>
pgm_event_get_type
</SECTION>


<SECTION>
<FILE>pgmimage</FILE>
<TITLE>PgmImage</TITLE>
PgmImageAlignment
PgmImageLayoutType
PgmImageInterpType
PgmImagePixelFormat
PgmImageBuffer
PgmImageGstBuffer
PgmImageSystemBuffer
PgmImagePixbuf
PgmImageStorageType
PgmImageData
PgmImage
pgm_image_new
pgm_image_new_from_file
pgm_image_new_from_buffer
pgm_image_new_from_image
pgm_image_set_from_file
pgm_image_set_from_buffer
pgm_image_set_from_gst_buffer
pgm_image_set_from_system_buffer
pgm_image_set_from_image
pgm_image_clear
pgm_image_get_storage_type
pgm_image_system_buffer_lock
pgm_image_system_buffer_unlock
pgm_image_set_mapping_matrix
pgm_image_get_mapping_matrix
pgm_image_set_alignment
pgm_image_get_alignment
pgm_image_set_layout
pgm_image_get_layout
pgm_image_set_interp
pgm_image_get_interp
pgm_image_set_aspect_ratio
pgm_image_get_aspect_ratio
pgm_image_set_border_width
pgm_image_get_border_width
pgm_image_set_border_inner_color
pgm_image_get_border_inner_color
pgm_image_set_border_outer_color
pgm_image_get_border_outer_color
pgm_image_from_drawable
pgm_image_to_drawable
<SUBSECTION Standard>
PGM_IMAGE
PGM_IS_IMAGE
PGM_TYPE_IMAGE
PGM_IMAGE_CLASS
PGM_IS_IMAGE_CLASS
PGM_IMAGE_GET_CLASS
<SUBSECTION Private>
PGM_IMAGE_NB_PIXEL_FORMATS
PgmImageStorageType
PgmImageClass
pgm_image_get_type
</SECTION>


<SECTION>
<FILE>pgmimagesink</FILE>
<TITLE>PgmImageSink</TITLE>
PgmImageSinkEventMask
PgmImageSink
pgm_image_sink_new
pgm_image_sink_set_image
pgm_image_sink_get_image
pgm_image_sink_set_events
pgm_image_sink_get_events
<SUBSECTION Standard>
PGM_IMAGE_SINK
PGM_IS_IMAGE_SINK
PGM_TYPE_IMAGE_SINK
PGM_IMAGE_SINK_CLASS
PGM_IS_IMAGE_SINK_CLASS
<SUBSECTION Private>
PgmImageSinkClass
pgm_image_sink_get_type
</SECTION>


<SECTION>
<FILE>pgmlinearalgebra</FILE>
<TITLE>PgmLinearAlgebra</TITLE>
PgmMat4x4Predefined
PgmVec3
PgmVec4
PgmMat3x3
PgmMat4x4
pgm_vec3_new
pgm_vec3_new_from_scalars
pgm_vec3_copy
pgm_vec3_free
pgm_vec3_set_from_scalars
pgm_vec3_set_from_vec3
pgm_vec3_length
pgm_vec3_normalize
pgm_vec3_dot_product
pgm_vec3_cross_product
pgm_vec3_add_scalar
pgm_vec3_add_vec3
pgm_vec3_substract_scalar
pgm_vec3_substract_vec3
pgm_vec3_multiply_scalar
pgm_vec3_multiply_vec3
pgm_vec3_to_string
pgm_vec4_new
pgm_vec4_new_from_scalars
pgm_vec4_copy
pgm_vec4_free
pgm_vec4_set_from_scalars
pgm_vec4_set_from_vec4
pgm_vec4_length
pgm_vec4_normalize
pgm_vec4_add_scalar
pgm_vec4_add_vec4
pgm_vec4_substract_scalar
pgm_vec4_substract_vec4
pgm_vec4_multiply_scalar
pgm_vec4_multiply_vec4
pgm_vec4_to_string
pgm_mat3x3_new
pgm_mat3x3_new_from_scalars
pgm_mat3x3_new_from_vec3
pgm_mat3x3_new_identity
pgm_mat3x3_copy
pgm_mat3x3_free
pgm_mat3x3_set_from_scalars
pgm_mat3x3_set_from_vec3
pgm_mat3x3_set_from_mat3x3
pgm_mat3x3_is_identity
pgm_mat3x3_inverse
pgm_mat3x3_transpose
pgm_mat3x3_add_scalar
pgm_mat3x3_add_mat3x3
pgm_mat3x3_substract_scalar
pgm_mat3x3_substract_mat3x3
pgm_mat3x3_multiply_scalar
pgm_mat3x3_multiply_vec3
pgm_mat3x3_multiply_mat3x3
pgm_mat3x3_to_string
pgm_mat4x4_new
pgm_mat4x4_new_from_scalars
pgm_mat4x4_new_from_vec4
pgm_mat4x4_new_identity
pgm_mat4x4_new_predefined
pgm_mat4x4_new_translate_from_vec3
pgm_mat4x4_new_translate_from_scalars
pgm_mat4x4_new_scale_from_vec3
pgm_mat4x4_new_scale_from_scalars
pgm_mat4x4_new_rotate_x
pgm_mat4x4_new_rotate_y
pgm_mat4x4_new_rotate_z
pgm_mat4x4_new_rotate_axis_from_vec3
pgm_mat4x4_new_rotate_axis_from_scalars
pgm_mat4x4_copy
pgm_mat4x4_free
pgm_mat4x4_set_from_scalars
pgm_mat4x4_set_from_vec4
pgm_mat4x4_set_from_mat4x4
pgm_mat4x4_is_identity
pgm_mat4x4_inverse
pgm_mat4x4_transpose
pgm_mat4x4_translate_from_vec3
pgm_mat4x4_translate_from_scalars
pgm_mat4x4_scale_from_vec3
pgm_mat4x4_scale_from_scalars
pgm_mat4x4_rotate_x
pgm_mat4x4_rotate_y
pgm_mat4x4_rotate_z
pgm_mat4x4_rotate_axis_from_vec3
pgm_mat4x4_rotate_axis_from_scalars
pgm_mat4x4_add_scalar
pgm_mat4x4_add_mat4x4
pgm_mat4x4_substract_scalar
pgm_mat4x4_substract_mat4x4
pgm_mat4x4_multiply_scalar
pgm_mat4x4_multiply_vec4
pgm_mat4x4_multiply_mat4x4
pgm_mat4x4_to_string
pgm_intersection_line_plane
pgm_point_belongs_rectangle
<SUBSECTION Standard>
PGM_TYPE_MAT3X3
PGM_TYPE_MAT4X4
PGM_TYPE_VEC3
PGM_TYPE_VEC4
<SUBSECTION Private>
pgm_vec3_get_type
pgm_vec4_get_type
pgm_mat3x3_get_type
pgm_mat4x4_get_type
</SECTION>


<SECTION>
<FILE>pgmmodule</FILE>
<TITLE>PgmModule</TITLE>
<SUBSECTION Private>
PGM_IS_MODULE
PGM_IS_MODULE_CLASS
PGM_MODULE
PGM_MODULE_CLASS
PGM_MODULE_GET_CLASS
PGM_TYPE_MODULE
PgmModule
PgmModuleClass
pgm_module_get_type
pgm_module_new
</SECTION>


<SECTION>
<FILE>pgmplugin</FILE>
<TITLE>PgmPlugin</TITLE>
PGM_PLUGIN_PATH_NAME
PgmPluginInitFunc
PgmPluginShutdownFunc
PgmPluginCreateFunc
PgmPluginDesc
PGM_PLUGIN_DEFINE
<SUBSECTION Private>
PGM_DEFINE_DYNAMIC_TYPE
PGM_DEFINE_DYNAMIC_TYPE_EXTENDED
</SECTION>


<SECTION>
<FILE>pgmtext</FILE>
<TITLE>PgmText</TITLE>
PgmTextEllipsize
PgmTextAlignment
PgmTextWrap
PgmTextGravity
PgmTextStretch
PgmTextStyle
PgmTextVariant
PgmTextWeight
PgmText
pgm_text_new
pgm_text_set_label
pgm_text_set_markup
pgm_text_get_label
pgm_text_set_font_family
pgm_text_get_font_family
pgm_text_set_font_height
pgm_text_get_font_height
pgm_text_set_ellipsize
pgm_text_get_ellipsize
pgm_text_set_justify
pgm_text_get_justify
pgm_text_set_alignment
pgm_text_get_alignment
pgm_text_set_wrap
pgm_text_get_wrap
pgm_text_set_gravity
pgm_text_get_gravity
pgm_text_set_stretch
pgm_text_get_stretch
pgm_text_set_style
pgm_text_get_style
pgm_text_set_variant
pgm_text_get_variant
pgm_text_set_weight
pgm_text_get_weight
pgm_text_set_line_spacing
pgm_text_get_line_spacing
pgm_text_set_outline_color
pgm_text_get_outline_color
pgm_text_set_outline_width
pgm_text_get_outline_width
<SUBSECTION Standard>
PGM_TEXT
PGM_IS_TEXT
PGM_TYPE_TEXT
PGM_TEXT_CLASS
PGM_IS_TEXT_CLASS
PGM_TEXT_GET_CLASS
<SUBSECTION Private>
PgmTextClass
pgm_text_get_type
</SECTION>


<SECTION>
<FILE>pgmversion</FILE>
<TITLE>PgmVersion</TITLE>
PGM_VERSION_MAJOR
PGM_VERSION_MINOR
PGM_VERSION_MICRO
PGM_VERSION_NANO
</SECTION>


<SECTION>
<FILE>pgmviewport</FILE>
<TITLE>PgmViewport</TITLE>
PgmViewportCursor
PgmViewportCapacity
PgmViewportRotation
PgmViewportReflection
PgmViewport
PgmViewportClass
pgm_viewport_set_title
pgm_viewport_get_title
pgm_viewport_show
pgm_viewport_hide
pgm_viewport_is_visible
pgm_viewport_set_decorated
pgm_viewport_get_decorated
pgm_viewport_set_cursor
pgm_viewport_get_cursor
pgm_viewport_set_icon
pgm_viewport_get_icon
pgm_viewport_set_size
pgm_viewport_get_size
pgm_viewport_set_alpha_blending
pgm_viewport_get_alpha_blending
pgm_viewport_set_opacity
pgm_viewport_get_opacity
pgm_viewport_set_fullscreen
pgm_viewport_get_fullscreen
pgm_viewport_get_screen_resolution
pgm_viewport_set_screen_resolution
pgm_viewport_get_screen_size_mm
pgm_viewport_set_screen_size_mm
pgm_viewport_push_event
pgm_viewport_get_canvas
pgm_viewport_set_canvas
pgm_viewport_set_canvas_rotation
pgm_viewport_get_canvas_rotation
pgm_viewport_set_canvas_reflection
pgm_viewport_get_canvas_reflection
pgm_viewport_update_projection
pgm_viewport_to_canvas
pgm_viewport_from_canvas
pgm_viewport_get_embedding_id
pgm_viewport_get_pixel_formats
pgm_viewport_get_caps_mask
pgm_viewport_get_frame_rate
pgm_viewport_read_pixels
pgm_viewport_push_pixels
pgm_viewport_emit_update_pass
<SUBSECTION Standard>
PGM_VIEWPORT
PGM_IS_VIEWPORT
PGM_TYPE_VIEWPORT
PGM_VIEWPORT_CLASS
PGM_IS_VIEWPORT_CLASS
PGM_VIEWPORT_GET_CLASS
PGM_VIEWPORT_CAST
<SUBSECTION Private>
_PgmIOWatch
pgm_viewport_get_type
</SECTION>


<SECTION>
<FILE>pgmviewportfactory</FILE>
<TITLE>PgmViewportFactory</TITLE>
PgmViewportFactory
pgm_viewport_factory_new
pgm_viewport_factory_get_description
pgm_viewport_factory_get_license
pgm_viewport_factory_get_origin
pgm_viewport_factory_get_author
pgm_viewport_factory_create
pgm_viewport_factory_make
<SUBSECTION Standard>
PGM_VIEWPORT_FACTORY
PGM_IS_VIEWPORT_FACTORY
PGM_TYPE_VIEWPORT_FACTORY
PGM_VIEWPORT_FACTORY_CLASS
PGM_IS_VIEWPORT_FACTORY_CLASS
PGM_VIEWPORT_FACTORY_GET_CLASS
<SUBSECTION Private>
PgmViewportFactoryClass
pgm_viewport_factory_get_type
</SECTION>


<SECTION>
<FILE>pgmgtk</FILE>
<TITLE>PgmGtk</TITLE>
PgmGtk
pgm_gtk_new
pgm_gtk_set_viewport
pgm_gtk_get_viewport
<SUBSECTION Standard>
PGM_TYPE_GTK
PGM_GTK
PGM_IS_GTK
PGM_GTK_CLASS
PGM_IS_GTK_CLASS
<SUBSECTION Private>
PgmGtkClass
pgm_gtk_get_type
</SECTION>
