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