init commit

include/mupdf/fitz/transition.h

@@ -1,3 +1,25 @@
+// Copyright (C) 2004-2021 Artifex Software, Inc.
+//
+// This file is part of MuPDF.
+//
+// MuPDF is free software: you can redistribute it and/or modify it under the
+// terms of the GNU Affero General Public License as published by the Free
+// Software Foundation, either version 3 of the License, or (at your option)
+// any later version.
+//
+// MuPDF 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 Affero General Public License for more
+// details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with MuPDF. If not, see <https://www.gnu.org/licenses/agpl-3.0.en.html>
+//
+// Alternative licensing terms are available from the licensor.
+// For commercial licensing, see <https://www.artifex.com/> or contact
+// Artifex Software, Inc., 39 Mesa Street, Suite 108A, San Francisco,
+// CA 94129, USA, for further information.
+
 #ifndef MUPDF_FITZ_TRANSITION_H
 #define MUPDF_FITZ_TRANSITION_H
 
@@ -5,8 +27,6 @@
 #include "mupdf/fitz/pixmap.h"
 
 /* Transition support */
-typedef struct fz_transition_s fz_transition;
-
 enum {
 	FZ_TRANSITION_NONE = 0, /* aka 'R' or 'REPLACE' */
 	FZ_TRANSITION_SPLIT,
@@ -22,7 +42,7 @@ enum {
 	FZ_TRANSITION_FADE
 };
 
-struct fz_transition_s
+typedef struct
 {
 	int type;
 	float duration; /* Effect duration (seconds) */
@@ -36,10 +56,10 @@ struct fz_transition_s
 	/* State variables for use of the transition code */
 	int state0;
 	int state1;
-};
+} fz_transition;
 
-/*
-	fz_generate_transition: Generate a frame of a transition.
+/**
+	Generate a frame of a transition.
 
 	tpix: Target pixmap
 	opix: Old pixmap
@@ -48,6 +68,8 @@ struct fz_transition_s
 	trans: Transition details
 
 	Returns 1 if successfully generated a frame.
+
+	Note: Pixmaps must include alpha.
 */
 int fz_generate_transition(fz_context *ctx, fz_pixmap *tpix, fz_pixmap *opix, fz_pixmap *npix, int time, fz_transition *trans);