From 0125b58431716afa13c5bcff0f435aa23ecd7fc0 Mon Sep 17 00:00:00 2001 From: Mike McCormack Date: Mon, 7 Nov 2011 18:56:16 +0900 Subject: [PATCH] [glview] delete docs --- src/lib/elm_glview.c | 127 --------------------------------------------------- 1 file changed, 127 deletions(-) diff --git a/src/lib/elm_glview.c b/src/lib/elm_glview.c index a90a755..d1311e7 100644 --- a/src/lib/elm_glview.c +++ b/src/lib/elm_glview.c @@ -1,14 +1,6 @@ #include #include "elm_priv.h" -/** - * @defgroup GLView - * - * A simple GLView widget that allows GL rendering. - * - * Signals that you can add callbacks for are: - * - */ typedef struct _Widget_Data Widget_Data; struct _Widget_Data @@ -221,14 +213,6 @@ _set_render_policy_callback(Evas_Object *obj) } } -/** - * Add a new glview to the parent - * - * @param parent The parent object - * @return The new object or NULL if it cannot be created - * - * @ingroup GLView - */ EAPI Evas_Object * elm_glview_add(Evas_Object *parent) { @@ -296,14 +280,6 @@ elm_glview_add(Evas_Object *parent) return obj; } -/** - * Gets the gl api struct for gl rendering - * - * @param obj The glview object - * @return The api object or NULL if it cannot be created - * - * @ingroup GLView - */ EAPI Evas_GL_API * elm_glview_gl_api_get(const Evas_Object *obj) { @@ -314,16 +290,6 @@ elm_glview_gl_api_get(const Evas_Object *obj) return evas_gl_api_get(wd->evasgl); } - -/** - * Set the mode of the GLView. Supports Three simple modes. - * - * @param obj The glview object - * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil. - * @return True if set properly. - * - * @ingroup GLView - */ EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) { @@ -358,19 +324,6 @@ elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) return EINA_TRUE; } -/** - * Set the resize policy for the glview object. - * - * @param obj The glview object. - * @param policy The scaling policy. - * - * By default, the resize policy is set to ELM_GLVIEW_RESIZE_POLICY_RECREATE. - * When resize is called it destroys the previous surface and recreates the newly - * specified size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE, however, - * glview only scales the image object and not the underlying GL Surface. - * - * @ingroup GLView - */ EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) { @@ -393,20 +346,6 @@ elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) elm_glview_changed_set(obj); } -/** - * Set the render policy for the glview object. - * - * @param obj The glview object. - * @param policy The render policy. - * - * By default, the render policy is set to ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. - * This policy is set such that during the render loop, glview is only redrawn - * if it needs to be redrawn. (i.e. When it is visible) If the policy is set - * to ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of whether it is - * visible/need redrawing or not. - * - * @ingroup GLView - */ EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) { @@ -427,15 +366,6 @@ elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) return EINA_TRUE; } -/** - * Sets the size of the glview - * - * @param obj The glview object - * @param width width of the glview object - * @param height height of the glview object - * - * @ingroup GLView - */ EAPI void elm_glview_size_set(Evas_Object *obj, int width, int height) { @@ -450,19 +380,6 @@ elm_glview_size_set(Evas_Object *obj, int width, int height) elm_glview_changed_set(obj); } -/** - * Gets the size of the glview. - * - * @param obj The glview object - * @param width width of the glview object - * @param height height of the glview object - * - * Note that this function returns the actual image size of the glview. - * This means that when the scale policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE, - * it'll return the non-scaled size. - * - * @ingroup GLView - */ EAPI void elm_glview_size_get(const Evas_Object *obj, int *width, int *height) { @@ -474,16 +391,6 @@ elm_glview_size_get(const Evas_Object *obj, int *width, int *height) if (height) *height = wd->h; } -/** - * Set the init function that runs once in the main loop. - * - * @param obj The glview object. - * @param func The init function to be registered. - * - * The registered init function gets called once during the render loop. - * - * @ingroup GLView - */ EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) { @@ -495,16 +402,6 @@ elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) wd->init_func = func; } -/** - * Set the render function that runs in the main loop. - * - * @param obj The glview object. - * @param func The delete function to be registered. - * - * The registered del function gets called when GLView object is deleted. - * - * @ingroup GLView - */ EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) { @@ -515,14 +412,6 @@ elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) wd->del_func = func; } -/** - * Set the resize function that gets called when resize happens. - * - * @param obj The glview object. - * @param func The resize function to be registered. - * - * @ingroup GLView - */ EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) { @@ -537,15 +426,6 @@ elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) wd->resize_func = func; } - -/** - * Set the render function that runs in the main loop. - * - * @param obj The glview object. - * @param func The render function to be registered. - * - * @ingroup GLView - */ EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) { @@ -557,13 +437,6 @@ elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) _set_render_policy_callback(obj); } -/** - * Notifies that there has been changes in the GLView. - * - * @param obj The glview object. - * - * @ingroup GLView - */ EAPI void elm_glview_changed_set(Evas_Object *obj) { -- 2.7.4