Initial commit - from Precise source
[freerdp-ubuntu-pcb-backport.git] / include / freerdp / cache / offscreen.h
1 /**
2  * FreeRDP: A Remote Desktop Protocol Client
3  * Offscreen Bitmap Cache
4  *
5  * Copyright 2011 Marc-Andre Moreau <marcandre.moreau@gmail.com>
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *     http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19
20 #ifndef __OFFSCREEN_CACHE_H
21 #define __OFFSCREEN_CACHE_H
22
23 #include <freerdp/api.h>
24 #include <freerdp/types.h>
25 #include <freerdp/update.h>
26 #include <freerdp/freerdp.h>
27 #include <freerdp/utils/stream.h>
28
29 typedef struct rdp_offscreen_cache rdpOffscreenCache;
30
31 #include <freerdp/cache/cache.h>
32
33 struct rdp_offscreen_cache
34 {
35         uint32 maxSize; /* 0 */
36         uint32 maxEntries; /* 1 */
37         rdpBitmap** entries; /* 2 */
38         uint32 currentSurface; /* 3 */
39
40         /* internal */
41
42         rdpUpdate* update;
43         rdpSettings* settings;
44 };
45
46 FREERDP_API rdpBitmap* offscreen_cache_get(rdpOffscreenCache* offscreen_cache, uint32 index);
47 FREERDP_API void offscreen_cache_put(rdpOffscreenCache* offscreen_cache, uint32 index, rdpBitmap* bitmap);
48 FREERDP_API void offscreen_cache_delete(rdpOffscreenCache* offscreen, uint32 index);
49
50 FREERDP_API void offscreen_cache_register_callbacks(rdpUpdate* update);
51
52 FREERDP_API rdpOffscreenCache* offscreen_cache_new(rdpSettings* settings);
53 FREERDP_API void offscreen_cache_free(rdpOffscreenCache* offscreen);
54
55 #endif /* __OFFSCREEN_CACHE_H */