window_surfaces_ex.h

00001 /*******************************************************************************
00002 * DISCLAIMER
00003 * This software is supplied by Renesas Electronics Corporation and is only
00004 * intended for use with Renesas products. No other uses are authorized. This
00005 * software is owned by Renesas Electronics Corporation and is protected under
00006 * all applicable laws, including copyright laws.
00007 * THIS SOFTWARE IS PROVIDED "AS IS" AND RENESAS MAKES NO WARRANTIES REGARDING
00008 * THIS SOFTWARE, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
00009 * LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
00010 * AND NON-INFRINGEMENT. ALL SUCH WARRANTIES ARE EXPRESSLY DISCLAIMED.
00011 * TO THE MAXIMUM EXTENT PERMITTED NOT PROHIBITED BY LAW, NEITHER RENESAS
00012 * ELECTRONICS CORPORATION NOR ANY OF ITS AFFILIATED COMPANIES SHALL BE LIABLE
00013 * FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR
00014 * ANY REASON RELATED TO THIS SOFTWARE, EVEN IF RENESAS OR ITS AFFILIATES HAVE
00015 * BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
00016 * Renesas reserves the right, without notice, to make changes to this software
00017 * and to discontinue the availability of this software. By using this software,
00018 * you agree to the additional terms and conditions found by accessing the
00019 * following link:
00020 * http://www.renesas.com/disclaimer
00021 * Copyright (C) 2012 - 2014 Renesas Electronics Corporation. All rights reserved.
00022 *******************************************************************************/
00023 /**
00024 * @file  window_surfaces_ex.h
00025 * @brief   $Module: CLibCommon $ $PublicVersion: 1.00 $ (=CLIB_VERSION)
00026 * $Rev: 47 $
00027 * $Date:: 2014-01-06 18:18:48 +0900#$
00028 */
00029 #ifndef  WINDOW_SURFACES_EX_H
00030 #define  WINDOW_SURFACES_EX_H
00031 
00032 /******************************************************************************
00033 Includes   <System Includes> , "Project Includes"
00034 ******************************************************************************/
00035 #include  "window_surfaces_ex_typedef.h "
00036 
00037 #ifdef __cplusplus
00038 extern "C" {
00039 #endif /* __cplusplus */
00040 
00041 
00042 /******************************************************************************
00043 Typedef definitions
00044 ******************************************************************************/
00045 /* In "frame_buffer_typedef.h" */
00046 
00047 /******************************************************************************
00048 Macro definitions
00049 ******************************************************************************/
00050 /* In "frame_buffer_typedef.h" */
00051 
00052 /******************************************************************************
00053 Variable Externs
00054 ******************************************************************************/
00055 /* In "frame_buffer_typedef.h" */
00056 
00057 /******************************************************************************
00058 Functions Prototypes
00059 ******************************************************************************/
00060 
00061 
00062 /***********************************************************************
00063 * Class: window_surfaces_t
00064 *    Extra methods of <window_surfaces_t>
00065 ************************************************************************/
00066 
00067 /**
00068 * @brief   Emulate message loop function.
00069 *
00070 * @param   self window_surfaces_t
00071 * @return  Error code, 0=No error
00072 */
00073 errnum_t  R_WINDOW_SURFACES_DoMessageLoop( window_surfaces_t *self );
00074 
00075 
00076 /**
00077 * @brief   Set or get by <layer_attributes_t>
00078 *
00079 * @param   self window_surfaces_t
00080 * @param   in_out_Attributes <layer_attributes_t>
00081 * @return  Error code, 0=No error
00082 */
00083 errnum_t  R_WINDOW_SURFACES_AccessLayerAttributes( window_surfaces_t *self,
00084         layer_attributes_t *in_out_Attributes );
00085 
00086 
00087 /***********************************************************************
00088 * Class: vram_ex_stack_t
00089 *    VRAM stack in external RAM
00090 ************************************************************************/
00091 
00092 /**
00093 * @brief   R_VRAM_EX_STACK_Initialize
00094 *
00095 * @param   self vram_ex_stack_t
00096 * @param   NullConfig NULL
00097 * @return  Error Code. 0=No Error.
00098 */
00099 errnum_t  R_VRAM_EX_STACK_Initialize( vram_ex_stack_t *self, void *NullConfig );
00100 
00101 
00102 /**
00103 * @brief   Allocate VRAM from external RAM
00104 *
00105 * @param   self vram_ex_stack_t
00106 * @param   in_out_FrameBuffer frame_buffer_t
00107 * @return  Error code, 0=No error
00108 *
00109 * @par Description
00110 *    - (input) - >stride, ->height, ->buffer_count
00111 *    - (output) - >buffer_address[(all)]
00112 */
00113 errnum_t  R_VRAM_EX_STACK_Alloc( vram_ex_stack_t *self, frame_buffer_t *in_out_FrameBuffer );
00114 
00115 
00116 /**
00117 * @brief   Free VRAM to external RAM
00118 *
00119 * @param   self vram_ex_stack_t
00120 * @param   frame_buffer frame_buffer_t
00121 * @return  Error code, 0=No error
00122 *
00123 * @par Description
00124 *    - If frame_buffer - >buffer_count == 0, do nothing.
00125 */
00126 errnum_t  R_VRAM_EX_STACK_Free( vram_ex_stack_t *self, frame_buffer_t *frame_buffer );
00127 
00128 
00129 #ifdef __cplusplus
00130 }  /* extern "C" */
00131 #endif /* __cplusplus */
00132 
00133 #endif