Enums.h
Go to the documentation of this file.
/**
* @file
* @brief Header file for TextReader class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @section LICENSE
*
* Copyright (c) 2008-2014 OpenShot Studios, LLC
* <http://www.openshotstudios.com/>. This file is part of
* OpenShot Library (libopenshot), an open-source project dedicated to
* delivering high quality video editing and animation solutions to the
* world. For more information visit <http://www.openshot.org/>.
*
* OpenShot Library (libopenshot) 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 3 of the
* License, or (at your option) any later version.
*
* OpenShot Library (libopenshot) 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef OPENSHOT_ENUMS_H
#define OPENSHOT_ENUMS_H
namespace openshot
{
/// This enumeration determines how clips are aligned to their parent container.
enum GravityType
{
GRAVITY_TOP_LEFT, ///< Align clip to the top left of its parent
GRAVITY_TOP, ///< Align clip to the top center of its parent
GRAVITY_TOP_RIGHT, ///< Align clip to the top right of its parent
GRAVITY_LEFT, ///< Align clip to the left of its parent (middle aligned)
GRAVITY_CENTER, ///< Align clip to the center of its parent (middle aligned)
GRAVITY_RIGHT, ///< Align clip to the right of its parent (middle aligned)
GRAVITY_BOTTOM_LEFT, ///< Align clip to the bottom left of its parent
GRAVITY_BOTTOM, ///< Align clip to the bottom center of its parent
GRAVITY_BOTTOM_RIGHT ///< Align clip to the bottom right of its parent
};
/// This enumeration determines how clips are scaled to fit their parent container.
enum ScaleType
{
SCALE_CROP, ///< Scale the clip until both height and width fill the canvas (cropping the overlap)
SCALE_FIT, ///< Scale the clip until either height or width fills the canvas (with no cropping)
SCALE_STRETCH, ///< Scale the clip until both height and width fill the canvas (distort to fit)
SCALE_NONE ///< Do not scale the clip
};
/// This enumeration determines what parent a clip should be aligned to.
enum AnchorType
{
ANCHOR_CANVAS, ///< Anchor the clip to the canvas
ANCHOR_VIEWPORT ///< Anchor the clip to the viewport (which can be moved / animated around the canvas)
};
/// This enumeration determines the display format of the clip's frame number (if any). Useful for debugging.
enum FrameDisplayType
{
FRAME_DISPLAY_NONE, ///< Do not display the frame number
FRAME_DISPLAY_CLIP, ///< Display the clip's internal frame number
FRAME_DISPLAY_TIMELINE, ///< Display the timeline's frame number
FRAME_DISPLAY_BOTH ///< Display both the clip's and timeline's frame number
};
}
#endif
openshot::FRAME_DISPLAY_TIMELINE
Display the timeline&#39;s frame number.
Definition: Enums.h:69
openshot::GRAVITY_RIGHT
Align clip to the right of its parent (middle aligned)
Definition: Enums.h:42
openshot::GRAVITY_BOTTOM_RIGHT
Align clip to the bottom right of its parent.
Definition: Enums.h:45
openshot::SCALE_NONE
Do not scale the clip.
Definition: Enums.h:54
openshot::SCALE_CROP
Scale the clip until both height and width fill the canvas (cropping the overlap) ...
Definition: Enums.h:51
openshot::ScaleType
ScaleType
This enumeration determines how clips are scaled to fit their parent container.
Definition: Enums.h:49
openshot::FRAME_DISPLAY_NONE
Do not display the frame number.
Definition: Enums.h:67
openshot::GRAVITY_TOP_RIGHT
Align clip to the top right of its parent.
Definition: Enums.h:39
openshot::GRAVITY_BOTTOM_LEFT
Align clip to the bottom left of its parent.
Definition: Enums.h:43
openshot::GRAVITY_BOTTOM
Align clip to the bottom center of its parent.
Definition: Enums.h:44
openshot::GRAVITY_TOP_LEFT
Align clip to the top left of its parent.
Definition: Enums.h:37
openshot::FrameDisplayType
FrameDisplayType
This enumeration determines the display format of the clip&#39;s frame number (if any). Useful for debugging.
Definition: Enums.h:65
openshot::GRAVITY_LEFT
Align clip to the left of its parent (middle aligned)
Definition: Enums.h:40
openshot::SCALE_STRETCH
Scale the clip until both height and width fill the canvas (distort to fit)
Definition: Enums.h:53
openshot::FRAME_DISPLAY_CLIP
Display the clip&#39;s internal frame number.
Definition: Enums.h:68
openshot::ANCHOR_VIEWPORT
Anchor the clip to the viewport (which can be moved / animated around the canvas) ...
Definition: Enums.h:61
openshot::AnchorType
AnchorType
This enumeration determines what parent a clip should be aligned to.
Definition: Enums.h:58
openshot::GRAVITY_CENTER
Align clip to the center of its parent (middle aligned)
Definition: Enums.h:41
openshot::FRAME_DISPLAY_BOTH
Display both the clip&#39;s and timeline&#39;s frame number.
Definition: Enums.h:70
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:45
openshot::GRAVITY_TOP
Align clip to the top center of its parent.
Definition: Enums.h:38
openshot::SCALE_FIT
Scale the clip until either height or width fills the canvas (with no cropping)
Definition: Enums.h:52
openshot::GravityType
GravityType
This enumeration determines how clips are aligned to their parent container.
Definition: Enums.h:35
openshot::ANCHOR_CANVAS
Anchor the clip to the canvas.
Definition: Enums.h:60