Cleanup: warnings, typos
[blender.git] / source / blender / freestyle / FRS_freestyle.h
index f23f167b3a0fc14b5807662e940334304c7748b0..9766372507b8ab6d296b0cf700183f969365cf8b 100644 (file)
@@ -1,7 +1,4 @@
-/* FRS_freestyle.h
- *
- * $Id$
- *
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * along with this program; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
- * The Original Code is Copyright (C) 2010 Blender Foundation.
- * All rights reserved.
- *
- * The Original Code is: all of this file.
- *
- * Contributor(s): none yet.
- *
  * ***** END GPL LICENSE BLOCK *****
  */
 
-#ifndef FRS_FREESTYLE_H
-#define FRS_FREESTYLE_H
+#ifndef __FRS_FREESTYLE_H__
+#define __FRS_FREESTYLE_H__
+
+/** \file blender/freestyle/FRS_freestyle.h
+ *  \ingroup freestyle
+ */
 
 #ifdef __cplusplus
 extern "C" {
-#endif 
-       
-       #include "DNA_listBase.h"
-       #include "DNA_scene_types.h"
-       
-       #include "BKE_context.h"
-       #include "BKE_object.h"
-       
-       struct Render;
-       
-       extern Scene *freestyle_scene;
-       extern float freestyle_viewpoint[3];
-       extern float freestyle_mv[4][4];
-       extern float freestyle_proj[4][4];
-       extern int freestyle_viewport[4];
+#endif
+
+struct Render;
+struct Material;
+struct FreestyleConfig;
+struct FreestyleLineStyle;
 
-       // Rendering
-       void FRS_initialize(void);
-       void FRS_set_context(bContext* C);
-       void FRS_read_file(bContext* C);
-       int FRS_is_freestyle_enabled(struct SceneRenderLayer* srl);
-       void FRS_init_stroke_rendering(struct Render* re);
-       struct Render* FRS_do_stroke_rendering(struct Render* re, struct SceneRenderLayer* srl);
-       void FRS_finish_stroke_rendering(struct Render* re);
-       void FRS_composite_result(struct Render* re, struct SceneRenderLayer* srl, struct Render* freestyle_render);
-       void FRS_exit(void);
-       
-       // Panel configuration
-       void FRS_add_module(FreestyleConfig *config);
-       void FRS_delete_module(FreestyleConfig *config, FreestyleModuleConfig *module_conf);
-       void FRS_move_module_up(FreestyleConfig *config, FreestyleModuleConfig *module_conf);
-       void FRS_move_module_down(FreestyleConfig *config, FreestyleModuleConfig *module_conf);
-       
-       FreestyleLineSet *FRS_add_lineset(FreestyleConfig *config);
-       void FRS_copy_active_lineset(FreestyleConfig *config);
-       void FRS_paste_active_lineset(FreestyleConfig *config);
-       void FRS_delete_active_lineset(FreestyleConfig *config);
-       void FRS_move_active_lineset_up(FreestyleConfig *config);
-       void FRS_move_active_lineset_down(FreestyleConfig *config);
+extern struct Scene *freestyle_scene;
+extern float freestyle_viewpoint[3];
+extern float freestyle_mv[4][4];
+extern float freestyle_proj[4][4];
+extern int freestyle_viewport[4];
 
-       FreestyleLineSet *FRS_get_active_lineset(FreestyleConfig *config);
-       short FRS_get_active_lineset_index(FreestyleConfig *config);
-       void FRS_set_active_lineset_index(FreestyleConfig *config, short index);
+/* Rendering */
+void FRS_initialize(void);
+void FRS_set_context(struct bContext *C);
+void FRS_read_file(struct bContext *C);
+int FRS_is_freestyle_enabled(struct SceneRenderLayer *srl);
+void FRS_init_stroke_rendering(struct Render *re);
+struct Render *FRS_do_stroke_rendering(struct Render *re, struct SceneRenderLayer *srl, int render);
+void FRS_finish_stroke_rendering(struct Render *re);
+void FRS_free_view_map_cache(void);
+void FRS_composite_result(struct Render *re, struct SceneRenderLayer *srl, struct Render *freestyle_render);
+void FRS_exit(void);
 
-       void FRS_unlink_target_object(FreestyleConfig *config, struct Object *ob);
+/* FreestyleConfig.linesets */
+void FRS_copy_active_lineset(struct FreestyleConfig *config);
+void FRS_paste_active_lineset(struct FreestyleConfig *config);
+void FRS_delete_active_lineset(struct FreestyleConfig *config);
+void FRS_move_active_lineset_up(struct FreestyleConfig *config);
+void FRS_move_active_lineset_down(struct FreestyleConfig *config);
+
+/* Testing */
+struct Material *FRS_create_stroke_material(struct Main *bmain, struct FreestyleLineStyle *linestyle);
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif
+#endif // __FRS_FREESTYLE_H__