]> git.sesse.net Git - mlt/blobdiff - src/framework/mlt_geometry.h
A little debugging.
[mlt] / src / framework / mlt_geometry.h
index 12619026a75098fea6beaa7927fde968bf74ffde..fffe2d841abfa0bb5eb804458237cb0c1fe78df9 100644 (file)
@@ -1,21 +1,24 @@
-/*
- * mlt_geometry.h -- provides the geometry API
+/**
+ * \file mlt_geometry.h
+ * \brief geometry animation API (deprecated)
+ * \deprecated use mlt_animation_s instead
+ *
  * Copyright (C) 2004-2005 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+ * \author Charles Yates <charles.yates@pandora.be>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  *
- * This program is distributed in the hope that it will be useful,
+ * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
 #ifndef _MLT_GEOMETRY_H
 
 #include "mlt_types.h"
 
+/** geometry animation item (deprecated)
+ * \deprecated use mlt_animation_s instead
+ */
+
 struct mlt_geometry_item_s
 {
        /* Will be 1 when this is a key frame */
@@ -37,6 +44,10 @@ struct mlt_geometry_item_s
        int f[ 5 ];
 };
 
+/** geometry object (deprecated)
+ * \deprecated use mlt_animation_s instead
+ */
+
 struct mlt_geometry_s
 {
        void *local;
@@ -60,6 +71,8 @@ extern int mlt_geometry_fetch( mlt_geometry self, mlt_geometry_item item, float
 extern int mlt_geometry_insert( mlt_geometry self, mlt_geometry_item item );
 /* Remove the key at the specified position */
 extern int mlt_geometry_remove( mlt_geometry self, int position );
+/* Typically, re-interpolate after a series of insertions or removals. */
+extern void mlt_geometry_interpolate( mlt_geometry self );
 /* Get the key at the position or the next following */
 extern int mlt_geometry_next_key( mlt_geometry self, mlt_geometry_item item, int position );
 extern int mlt_geometry_prev_key( mlt_geometry self, mlt_geometry_item item, int position );