GUAC-656: Add simple surface and stubs.

This commit is contained in:
Michael Jumper 2014-04-29 15:45:16 -07:00
parent 4766970015
commit 3b541f70ee
3 changed files with 261 additions and 2 deletions

View File

@ -33,7 +33,8 @@ noinst_HEADERS = \
guac_iconv.h \
guac_list.h \
guac_pointer_cursor.h \
guac_string.h
guac_string.h \
guac_surface.h
libguac_common_la_SOURCES = \
guac_io.c \
@ -42,7 +43,8 @@ libguac_common_la_SOURCES = \
guac_iconv.c \
guac_list.c \
guac_pointer_cursor.c \
guac_string.c
guac_string.c \
guac_surface.c
libguac_common_la_LIBADD = @LIBGUAC_LTLIB@

67
src/common/guac_surface.c Normal file
View File

@ -0,0 +1,67 @@
/*
* Copyright (C) 2014 Glyptodon LLC
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#include "config.h"
#include "guac_surface.h"
#include <guacamole/layer.h>
#include <guacamole/protocol.h>
#include <guacamole/socket.h>
guac_common_surface* guac_common_surface_alloc(guac_socket* socket, const guac_layer* layer, int w, int h) {
/* STUB */
return NULL;
}
void guac_common_surface_free(guac_common_surface* surface) {
/* STUB */
}
void guac_common_surface_draw(guac_common_surface* surface, cairo_surface_t* src, int x, int y) {
/* STUB */
}
void guac_common_surface_copy(guac_common_surface* src, int sx, int sy, int w, int h,
guac_common_surface* dst, int dx, int dy) {
/* STUB */
}
void guac_common_surface_transfer(guac_transfer_function op,
guac_common_surface* src, int sx, int sy, int w, int h,
guac_common_surface* dst, int dx, int dy) {
/* STUB */
}
void guac_common_surface_resize(guac_common_surface* surface, int w, int h) {
/* STUB */
}
void guac_common_surface_rect(guac_common_surface* surface,
int x, int y, int w, int h,
int red, int green, int blue) {
/* STUB */
}
void guac_common_surface_flush(guac_common_surface* surface) {
/* STUB */
}

190
src/common/guac_surface.h Normal file
View File

@ -0,0 +1,190 @@
/*
* Copyright (C) 2014 Glyptodon LLC
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#ifndef __GUAC_COMMON_SURFACE_H
#define __GUAC_COMMON_SURFACE_H
#include "config.h"
#include <guacamole/layer.h>
#include <guacamole/protocol.h>
#include <guacamole/socket.h>
/**
* Surface which backs a Guacamole buffer or layer, automatically
* combining updates when possible.
*/
typedef struct guac_common_surface {
/**
* The width of this layer, in pixels.
*/
int width;
/**
* The height of this layer, in pixels.
*/
int height;
/**
* The layer this surface will draw to.
*/
guac_layer* layer;
/**
* The socket to send instructions on when flushing.
*/
guac_socket* socket;
/**
* The Cairo surface containins this Guacamole surface's current
* graphical state.
*/
cairo_surface_t* surface;
/**
* Non-zero if this surface is dirty and needs to be flushed, 0 otherwise.
*/
int dirty;
/**
* The X coordinate of the upper-left corner of the dirty rect. This
* value is undefined if the surface is unchanged (not dirty).
*/
int dirty_x;
/**
* The Y coordinate of the upper-left corner of the dirty rect. This
* value is undefined if the surface is unchanged (not dirty).
*/
int dirty_y;
/**
* The width of the dirty rect. This value is undefined if the surface is
* unchanged (not dirty).
*/
int dirty_width;
/**
* The height of the dirty rect. This value is undefined if the surface
* is unchanged (not dirty).
*/
int dirty_height;
} guac_common_surface;
/**
* Allocates a new guac_common_surface, assigning it to the given layer.
*
* @param socket The socket to send instructions on when flushing.
* @param layer The layer to associate with the new surface.
* @param w The width of the surface.
* @param h The height of the surface.
* @return A newly-allocated guac_common_surface.
*/
guac_common_surface* guac_common_surface_alloc(guac_socket* socket, const guac_layer* layer, int w, int h);
/**
* Frees the given guac_common_surface. Beware that this will NOT free any
* associated layers, which must be freed manually.
*
* @param surface The surface to free.
*/
void guac_common_surface_free(guac_common_surface* surface);
/**
* Draws the given data to the given guac_common_surface.
*
* @param surface The surface to draw to.
* @param src The Cairo surface to retrieve data from.
* @param x The X coordinate of the draw location.
* @param y The Y coordinate of the draw location.
*/
void guac_common_surface_draw(guac_common_surface* surface, cairo_surface_t* src, int x, int y);
/**
* Copies a rectangle of data between two surfaces.
*
* @param src The source surface.
* @param sx The X coordinate of the upper-left corner of the source rect.
* @param sy The Y coordinate of the upper-left corner of the source rect.
* @param w The width of the source rect.
* @param h The height of the source rect.
* @param dst The destination surface.
* @param dx The X coordinate of the upper-left corner of the destination rect.
* @param dy The Y coordinate of the upper-left corner of the destination rect.
*/
void guac_common_surface_copy(guac_common_surface* src, int sx, int sy, int w, int h,
guac_common_surface* dst, int dx, int dy);
/**
* Transfers a rectangle of data between two surfaces.
*
* @param op The transfer function.
* @param src The source surface.
* @param sx The X coordinate of the upper-left corner of the source rect.
* @param sy The Y coordinate of the upper-left corner of the source rect.
* @param w The width of the source rect.
* @param h The height of the source rect.
* @param dst The destination surface.
* @param dx The X coordinate of the upper-left corner of the destination rect.
* @param dy The Y coordinate of the upper-left corner of the destination rect.
*/
void guac_common_surface_transfer(guac_transfer_function op,
guac_common_surface* src, int sx, int sy, int w, int h,
guac_common_surface* dst, int dx, int dy);
/**
* Resizes the given surface to the given size.
*
* @param surface The surface to resize.
* @param w The width of the surface.
* @param h The height of the surface.
*/
void guac_common_surface_resize(guac_common_surface* surface, int w, int h);
/**
* Draws a solid color rectangle at the given coordinates on the given surface.
*
* @param surface The surface to draw upon.
* @param x The X coordinate of the upper-left corner of the rectangle.
* @param y The Y coordinate of the upper-left corner of the rectangle.
* @param w The width of the rectangle.
* @param h The height of the rectangle.
* @param red The red component of the color of the rectangle.
* @param green The green component of the color of the rectangle.
* @param blue The blue component of the color of the rectangle.
*/
void guac_common_surface_rect(guac_common_surface* surface,
int x, int y, int w, int h,
int red, int green, int blue);
/**
* Flushes the given surface, drawing any pending operations on the remote
* display.
*
* @param surface The surface to flush.
*/
void guac_common_surface_flush(guac_common_surface* surface);
#endif