os/graphics/graphicscomposition/openwfcompositionengine/composition/include/wfcpipeline.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
/* Copyright (c) 2009 The Khronos Group Inc.
sl@0
     2
 * Portions copyright (c) 2009-2010  Nokia Corporation and/or its subsidiary(-ies)
sl@0
     3
 *
sl@0
     4
 * Permission is hereby granted, free of charge, to any person obtaining a
sl@0
     5
 * copy of this software and/or associated documentation files (the
sl@0
     6
 * "Materials"), to deal in the Materials without restriction, including
sl@0
     7
 * without limitation the rights to use, copy, modify, merge, publish,
sl@0
     8
 * distribute, sublicense, and/or sell copies of the Materials, and to
sl@0
     9
 * permit persons to whom the Materials are furnished to do so, subject to
sl@0
    10
 * the following conditions:
sl@0
    11
 *
sl@0
    12
 * The above copyright notice and this permission notice shall be included
sl@0
    13
 * in all copies or substantial portions of the Materials.
sl@0
    14
 *
sl@0
    15
 * THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
sl@0
    16
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
sl@0
    17
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
sl@0
    18
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
sl@0
    19
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
sl@0
    20
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
sl@0
    21
 * MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
sl@0
    22
 */
sl@0
    23
sl@0
    24
/*! \ingroup wfc
sl@0
    25
 *  \file wfcpipeline.h
sl@0
    26
 *
sl@0
    27
 *  \brief Composition pipeline interface
sl@0
    28
 */
sl@0
    29
#ifndef WFCPIPELINE_H_
sl@0
    30
#define WFCPIPELINE_H_
sl@0
    31
sl@0
    32
#include <string.h>
sl@0
    33
#include <stdlib.h>
sl@0
    34
#include <math.h>
sl@0
    35
sl@0
    36
#include "WF/wfc.h"
sl@0
    37
#include "wfccontext.h"
sl@0
    38
#include "wfcelement.h"
sl@0
    39
#include "wfcimageprovider.h"
sl@0
    40
#include "wfcstructs.h"
sl@0
    41
#include "wfcscene.h"
sl@0
    42
sl@0
    43
#include "owfobject.h"
sl@0
    44
sl@0
    45
#include "owfnativestream.h"
sl@0
    46
#include "owfmemory.h"
sl@0
    47
#include "owfimage.h"
sl@0
    48
#include "owfdebug.h"
sl@0
    49
sl@0
    50
#ifdef __cplusplus
sl@0
    51
extern "C"
sl@0
    52
{
sl@0
    53
#endif
sl@0
    54
sl@0
    55
/*------------------------------------------------------------------------ *//*!
sl@0
    56
 *  \brief Composition pipeline preparation
sl@0
    57
 *
sl@0
    58
 *  \param context          Context
sl@0
    59
 *  \param element          Element
sl@0
    60
 *
sl@0
    61
 *  \return Boolean value indicating whether preparation succeeded
sl@0
    62
 *//*-------------------------------------------------------------------------*/
sl@0
    63
OWF_API_CALL WFC_ELEMENT_STATE* 
sl@0
    64
WFC_Pipeline_BeginComposition(WFC_CONTEXT* context, WFC_ELEMENT* element);
sl@0
    65
sl@0
    66
sl@0
    67
/*------------------------------------------------------------------------ *//*!
sl@0
    68
 *  Composition pipeline cleanup
sl@0
    69
 *
sl@0
    70
 *  \param context          Context
sl@0
    71
 *  \param element          Element
sl@0
    72
 *//*-------------------------------------------------------------------------*/
sl@0
    73
OWF_API_CALL void
sl@0
    74
WFC_Pipeline_EndComposition(WFC_CONTEXT* context, WFC_ELEMENT* element,WFC_ELEMENT_STATE* elementState);
sl@0
    75
sl@0
    76
/*------------------------------------------------------------------------ *//*!
sl@0
    77
 *  \brief Source conversion stage
sl@0
    78
 *
sl@0
    79
 *  \param context          Context
sl@0
    80
 *  \param element          Element
sl@0
    81
 *//*-------------------------------------------------------------------------*/
sl@0
    82
OWF_API_CALL void
sl@0
    83
WFC_Pipeline_ExecuteSourceConversionStage(WFC_CONTEXT* context,WFC_ELEMENT_STATE* elementState);
sl@0
    84
sl@0
    85
/*------------------------------------------------------------------------ *//*!
sl@0
    86
 *  \brief Crop stage
sl@0
    87
 *
sl@0
    88
 *  \param context          Context
sl@0
    89
 *  \param element          Element
sl@0
    90
 *//*-------------------------------------------------------------------------*/
sl@0
    91
OWF_API_CALL void
sl@0
    92
WFC_Pipeline_ExecuteCropStage(WFC_CONTEXT* context, WFC_ELEMENT_STATE* elementState);
sl@0
    93
sl@0
    94
/*------------------------------------------------------------------------ *//*!
sl@0
    95
 *  \brief Flip stage
sl@0
    96
 *
sl@0
    97
 *  \param context          Context
sl@0
    98
 *  \param element          Element
sl@0
    99
 *//*-------------------------------------------------------------------------*/
sl@0
   100
OWF_API_CALL void
sl@0
   101
WFC_Pipeline_ExecuteFlipStage(WFC_CONTEXT* context, WFC_ELEMENT_STATE* elementState);
sl@0
   102
sl@0
   103
/*------------------------------------------------------------------------ *//*!
sl@0
   104
 *  \brief Rotation stage
sl@0
   105
 *
sl@0
   106
 *  \param context          Context
sl@0
   107
 *  \param element          Element
sl@0
   108
 *//*-------------------------------------------------------------------------*/
sl@0
   109
OWF_API_CALL void
sl@0
   110
WFC_Pipeline_ExecuteRotationStage(WFC_CONTEXT* context, WFC_ELEMENT_STATE* elementState);
sl@0
   111
sl@0
   112
/*------------------------------------------------------------------------ *//*!
sl@0
   113
 *  \brief Scaling stage
sl@0
   114
 *
sl@0
   115
 *  \param context          Context
sl@0
   116
 *  \param element          Element
sl@0
   117
 *//*-------------------------------------------------------------------------*/
sl@0
   118
OWF_API_CALL void
sl@0
   119
WFC_Pipeline_ExecuteScalingStage(WFC_CONTEXT* context, WFC_ELEMENT_STATE* elementState);
sl@0
   120
sl@0
   121
/*------------------------------------------------------------------------ *//*!
sl@0
   122
 *  \brief Blending stage
sl@0
   123
 *
sl@0
   124
 *  \param context          Context
sl@0
   125
 *  \param element          Element
sl@0
   126
 *//*-------------------------------------------------------------------------*/
sl@0
   127
OWF_API_CALL void
sl@0
   128
WFC_Pipeline_ExecuteBlendingStage(WFC_CONTEXT* context, WFC_ELEMENT_STATE* elementState);
sl@0
   129
sl@0
   130
/*------------------------------------------------------------------------ *//*!
sl@0
   131
 *  \brief Composition pipeline preparation per context creation
sl@0
   132
 *
sl@0
   133
 *  \param context          Context
sl@0
   134
 *
sl@0
   135
 *  \return Boolean value indicating whether preparation succeeded
sl@0
   136
 *//*-------------------------------------------------------------------------*/
sl@0
   137
OWF_API_CALL OWFboolean WFC_Pipeline_CreateState(WFC_CONTEXT* context);
sl@0
   138
sl@0
   139
/*------------------------------------------------------------------------ *//*!
sl@0
   140
 *  \brief Composition pipeline pull-dowwn per context
sl@0
   141
 *
sl@0
   142
 *  \param context          Context
sl@0
   143
 *
sl@0
   144
 *  \return Boolean value indicating whether preparation succeeded
sl@0
   145
 *//*-------------------------------------------------------------------------*/
sl@0
   146
OWF_API_CALL void WFC_Pipeline_DestroyState(WFC_CONTEXT* context);
sl@0
   147
sl@0
   148
sl@0
   149
sl@0
   150
#ifdef __cplusplus
sl@0
   151
}
sl@0
   152
#endif
sl@0
   153
#endif /* WFCPIPELINE_H_ */