2013-12-28 20:53:12 -08:00
|
|
|
/*
|
2016-03-25 12:59:40 -07:00
|
|
|
* Licensed to the Apache Software Foundation (ASF) under one
|
|
|
|
* or more contributor license agreements. See the NOTICE file
|
|
|
|
* distributed with this work for additional information
|
|
|
|
* regarding copyright ownership. The ASF licenses this file
|
|
|
|
* to you under the Apache License, Version 2.0 (the
|
|
|
|
* "License"); you may not use this file except in compliance
|
|
|
|
* with the License. You may obtain a copy of the License at
|
2012-01-02 17:59:52 -08:00
|
|
|
*
|
2016-03-25 12:59:40 -07:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2012-01-02 17:59:52 -08:00
|
|
|
*
|
2016-03-25 12:59:40 -07:00
|
|
|
* Unless required by applicable law or agreed to in writing,
|
|
|
|
* software distributed under the License is distributed on an
|
|
|
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
|
|
* KIND, either express or implied. See the License for the
|
|
|
|
* specific language governing permissions and limitations
|
|
|
|
* under the License.
|
2013-12-28 20:53:12 -08:00
|
|
|
*/
|
|
|
|
|
2019-12-23 13:29:13 -08:00
|
|
|
#ifndef GUAC_RDP_BITMAP_H
|
|
|
|
#define GUAC_RDP_BITMAP_H
|
2012-01-02 17:59:52 -08:00
|
|
|
|
2014-01-01 14:44:28 -08:00
|
|
|
#include "config.h"
|
2016-09-11 17:28:50 -07:00
|
|
|
#include "common/display.h"
|
2014-01-01 14:44:28 -08:00
|
|
|
|
2012-01-02 17:59:52 -08:00
|
|
|
#include <freerdp/freerdp.h>
|
2014-06-10 18:45:14 -07:00
|
|
|
#include <guacamole/layer.h>
|
2013-07-17 11:54:24 -07:00
|
|
|
#include <winpr/wtypes.h>
|
|
|
|
|
2016-02-29 21:50:00 -08:00
|
|
|
/**
|
|
|
|
* Guacamole-specific rdpBitmap data.
|
|
|
|
*/
|
2012-01-02 18:25:04 -08:00
|
|
|
typedef struct guac_rdp_bitmap {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* FreeRDP bitmap data - MUST GO FIRST.
|
|
|
|
*/
|
|
|
|
rdpBitmap bitmap;
|
|
|
|
|
|
|
|
/**
|
2016-02-29 21:50:00 -08:00
|
|
|
* Layer containing cached image data.
|
2014-04-30 11:44:06 -07:00
|
|
|
*/
|
2016-02-29 21:50:00 -08:00
|
|
|
guac_common_display_layer* layer;
|
2012-01-02 18:25:04 -08:00
|
|
|
|
2012-04-10 13:21:13 -07:00
|
|
|
/**
|
|
|
|
* The number of times a bitmap has been used.
|
|
|
|
*/
|
|
|
|
int used;
|
|
|
|
|
2012-01-02 18:25:04 -08:00
|
|
|
} guac_rdp_bitmap;
|
|
|
|
|
2016-02-29 21:50:00 -08:00
|
|
|
/**
|
|
|
|
* Caches the given bitmap immediately, storing its data in a remote Guacamole
|
|
|
|
* buffer. As RDP bitmaps are frequently created, used once, and immediately
|
|
|
|
* destroyed, we defer actual remote-side caching of RDP bitmaps until they are
|
|
|
|
* used at least once.
|
|
|
|
*
|
2016-03-07 15:05:31 -08:00
|
|
|
* @param context
|
|
|
|
* The rdpContext associated with the current RDP session.
|
|
|
|
*
|
|
|
|
* @param bitmap
|
|
|
|
* The bitmap to cache.
|
2019-12-28 12:29:09 -08:00
|
|
|
*
|
|
|
|
* @return
|
|
|
|
* TRUE if successful, FALSE otherwise.
|
2016-02-29 21:50:00 -08:00
|
|
|
*/
|
2017-03-25 19:59:04 -07:00
|
|
|
BOOL guac_rdp_cache_bitmap(rdpContext* context, rdpBitmap* bitmap);
|
2016-02-29 21:50:00 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Initializes the given newly-created rdpBitmap.
|
|
|
|
*
|
2016-03-07 15:05:31 -08:00
|
|
|
* @param context
|
|
|
|
* The rdpContext associated with the current RDP session.
|
|
|
|
*
|
|
|
|
* @param bitmap
|
|
|
|
* The bitmap to initialize.
|
2019-12-28 12:29:09 -08:00
|
|
|
*
|
|
|
|
* @return
|
|
|
|
* TRUE if successful, FALSE otherwise.
|
2016-02-29 21:50:00 -08:00
|
|
|
*/
|
2017-03-25 19:59:04 -07:00
|
|
|
BOOL guac_rdp_bitmap_new(rdpContext* context, rdpBitmap* bitmap);
|
2016-02-29 21:50:00 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Paints the given rdpBitmap on the primary display surface. Note that this
|
|
|
|
* operation does NOT draw to the "current" surface set by calls to
|
|
|
|
* guac_rdp_bitmap_setsurface().
|
|
|
|
*
|
2016-03-07 15:05:31 -08:00
|
|
|
* @param context
|
|
|
|
* The rdpContext associated with the current RDP session.
|
2016-02-29 21:50:00 -08:00
|
|
|
*
|
|
|
|
* @param bitmap
|
|
|
|
* The bitmap to paint. This structure will also contain the specifics of
|
|
|
|
* the paint operation to perform, including the destination X/Y
|
|
|
|
* coordinates.
|
2019-12-28 12:29:09 -08:00
|
|
|
*
|
|
|
|
* @return
|
|
|
|
* TRUE if successful, FALSE otherwise.
|
2016-02-29 21:50:00 -08:00
|
|
|
*/
|
2017-03-25 19:59:04 -07:00
|
|
|
BOOL guac_rdp_bitmap_paint(rdpContext* context, rdpBitmap* bitmap);
|
2016-02-29 21:50:00 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Frees any Guacamole-specific data associated with the given rdpBitmap.
|
|
|
|
*
|
2016-03-07 15:05:31 -08:00
|
|
|
* @param context
|
|
|
|
* The rdpContext associated with the current RDP session.
|
|
|
|
*
|
|
|
|
* @param bitmap
|
|
|
|
* The bitmap whose Guacamole-specific data is to be freed.
|
2016-02-29 21:50:00 -08:00
|
|
|
*/
|
2012-01-03 13:04:50 -08:00
|
|
|
void guac_rdp_bitmap_free(rdpContext* context, rdpBitmap* bitmap);
|
2016-02-29 21:50:00 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the given rdpBitmap as the drawing surface for future operations or,
|
|
|
|
* if the primary flag is set, resets the current drawing surface to the
|
|
|
|
* primary drawing surface of the remote display.
|
|
|
|
*
|
2016-03-07 15:05:31 -08:00
|
|
|
* @param context
|
|
|
|
* The rdpContext associated with the current RDP session.
|
2016-02-29 21:50:00 -08:00
|
|
|
*
|
|
|
|
* @param bitmap
|
|
|
|
* The rdpBitmap to set as the current drawing surface. This parameter is
|
|
|
|
* only valid if the primary flag is FALSE.
|
|
|
|
*
|
|
|
|
* @param primary
|
|
|
|
* TRUE if the bitmap parameter should be ignored, and the current drawing
|
|
|
|
* surface should be reset to the primary drawing surface of the remote
|
|
|
|
* display, FALSE otherwise.
|
2019-12-28 12:29:09 -08:00
|
|
|
*
|
|
|
|
* @return
|
|
|
|
* TRUE if successful, FALSE otherwise.
|
2016-02-29 21:50:00 -08:00
|
|
|
*/
|
2017-03-25 19:59:04 -07:00
|
|
|
BOOL guac_rdp_bitmap_setsurface(rdpContext* context, rdpBitmap* bitmap,
|
2016-02-29 21:50:00 -08:00
|
|
|
BOOL primary);
|
2012-01-02 17:59:52 -08:00
|
|
|
|
|
|
|
#endif
|