graphicscomposition/openwfcompositionengine/adaptation/include/owfdisplaycontextgeneral.h
branchRCL_3
changeset 164 25ffed67c7ef
parent 163 bbf46f59e123
equal deleted inserted replaced
163:bbf46f59e123 164:25ffed67c7ef
     1 /* Copyright (c) 2009 The Khronos Group Inc.
     1 /* Copyright (c) 2009 The Khronos Group Inc.
     2  * Portions copyright (c) 2009-2010  Nokia Corporation and/or its subsidiary(-ies)
       
     3  *
     2  *
     4  * Permission is hereby granted, free of charge, to any person obtaining a
     3  * Permission is hereby granted, free of charge, to any person obtaining a
     5  * copy of this software and/or associated documentation files (the
     4  * copy of this software and/or associated documentation files (the
     6  * "Materials"), to deal in the Materials without restriction, including
     5  * "Materials"), to deal in the Materials without restriction, including
     7  * without limitation the rights to use, copy, modify, merge, publish,
     6  * without limitation the rights to use, copy, modify, merge, publish,
    21  * MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
    20  * MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
    22  */
    21  */
    23 #ifndef OWFDISPLAYCONTEXTGENERAL_H_
    22 #ifndef OWFDISPLAYCONTEXTGENERAL_H_
    24 #define OWFDISPLAYCONTEXTGENERAL_H_
    23 #define OWFDISPLAYCONTEXTGENERAL_H_
    25 
    24 
       
    25 #include <e32def.h>
    26 #include <WF/wfc.h>
    26 #include <WF/wfc.h>
    27 #include <e32def.h>
       
    28 #include <KHR/khrplatform.h>
    27 #include <KHR/khrplatform.h>
    29 
    28 
    30 #ifdef __cplusplus
    29 #ifdef __cplusplus
    31 extern "C" {
    30 extern "C" {
    32 #endif
    31 #endif
    62 @param  dc      The display context who's composition ongoing flag is to be set
    61 @param  dc      The display context who's composition ongoing flag is to be set
    63 @param val      The boolean value
    62 @param val      The boolean value
    64 */
    63 */
    65 void OWF_DisplayContext_SetCompositionOngoing(OWF_DISPCTX dc, WFCboolean val);
    64 void OWF_DisplayContext_SetCompositionOngoing(OWF_DISPCTX dc, WFCboolean val);
    66 
    65 
    67 /**
       
    68 Creates posts the rendezvous semaphore
       
    69 @param  dc      The display context
       
    70 */
       
    71 void OWF_ComposerThread_Rendezvous(OWF_DISPCTX dc);
       
    72 
       
    73 /**
       
    74 Waits on rendezvous semaphore
       
    75 @param  dc      The display context who's composition ongoing flag is to be set
       
    76 */
       
    77 void OWF_ComposerThread_RendezvousWait(OWF_DISPCTX dc);
       
    78 
       
    79 /**
       
    80 Destroys on rendezvous semaphore
       
    81 @param  dc      The display context
       
    82 */
       
    83 void OWF_ComposerThread_RendezvousDestroy(OWF_DISPCTX dc);
       
    84 
       
    85 /**
       
    86 Activates fastpath mechanism and associates the stream output
       
    87 @param  dc      The display context
       
    88 @param  fastpathStream      Sets the fastpath stream
       
    89 */
       
    90 void OWF_DisplayContext_EnableFastpath(OWF_DISPCTX dc, OWFNativeStreamType fastpathStream);
       
    91 
       
    92 /**
       
    93 Disable fastpath stream
       
    94 @param  dc      The display context
       
    95 */
       
    96 void OWF_DisplayContext_DisableFastpath(OWF_DISPCTX dc);
       
    97 
       
    98 /**
       
    99 Returns fastpath state
       
   100 @param  dc      The display context
       
   101 @return OWF_TRUE if the current stream is fastpathable, OWF_FALSE otherwise 
       
   102 */
       
   103 WFCboolean OWF_DisplayContext_FastpathEnabled(OWF_DISPCTX dc);
       
   104 
       
   105 /**
       
   106 Returns fastpathed stream
       
   107 @param  dc      The display context
       
   108 @return handle of the fastpathed stream 
       
   109 */
       
   110 OWFNativeStreamType OWF_DisplayContext_FastpathStream(OWF_DISPCTX dc);
       
   111 
       
   112 /**
       
   113 Retrieves state of the fastpath
       
   114 @param  dc      The display context
       
   115 @return OWF_TRUE if the fastpath has been checked, OWF_FALSE otherwise 
       
   116 */
       
   117 WFCboolean OWF_DisplayContext_FastpathChecked(OWF_DISPCTX dc);
       
   118 /**
       
   119 Resets fatpath check
       
   120 @param  dc      The display context
       
   121 */
       
   122 void OWF_DisplayContext_ResetFastpathCheck(OWF_DISPCTX dc);
       
   123 /**
       
   124 Sets fatpath check
       
   125 @param  dc      The display context
       
   126 */
       
   127 void OWF_DisplayContext_SetFastpathChecked(OWF_DISPCTX dc);
       
   128 
       
   129 /**
       
   130 Flags that the internal stream has been made accessible for outside world
       
   131 The fast path mechanism is using it in order to fill the internal stream with
       
   132 the content of the fastpathed stream
       
   133 @param  dc      The display context
       
   134 */
       
   135 void OWF_DisplayContext_FlagInternalStreamAccessed(OWF_DISPCTX dc);
       
   136 
       
   137 /**
       
   138 Returns the internal stream accessibilty flag
       
   139 @param  dc      The display context
       
   140 @return OWF_TRUE if the fastpat has been checked, OWF_FALSE otherwise 
       
   141 */
       
   142 WFCboolean OWF_DisplayContext_InternalStreamAccessed(OWF_DISPCTX dc);
       
   143 
       
   144 OWFboolean OWF_DisplayContext_CopyFastpathedStreamToTargetStream(void* context);
       
   145 
       
   146 
       
   147 #ifdef __cplusplus
    66 #ifdef __cplusplus
   148 }
    67 }
   149 #endif
    68 #endif
   150 
    69 
   151 #endif /* OWFDISPLAYCONTEXTGENERAL_H_ */
    70 #endif /* OWFDISPLAYCONTEXTGENERAL_H_ */