cscg24-guacamole

CSCG 2024 Challenge 'Guacamole Mashup'
git clone https://git.sinitax.com/sinitax/cscg24-guacamole
Log | Files | Refs | sfeed.txt

cursor.h (1996B)

      1/*
      2 * Licensed to the Apache Software Foundation (ASF) under one
      3 * or more contributor license agreements.  See the NOTICE file
      4 * distributed with this work for additional information
      5 * regarding copyright ownership.  The ASF licenses this file
      6 * to you under the Apache License, Version 2.0 (the
      7 * "License"); you may not use this file except in compliance
      8 * with the License.  You may obtain a copy of the License at
      9 *
     10 *   http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing,
     13 * software distributed under the License is distributed on an
     14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     15 * KIND, either express or implied.  See the License for the
     16 * specific language governing permissions and limitations
     17 * under the License.
     18 */
     19
     20#ifndef GUAC_VNC_CURSOR_H
     21#define GUAC_VNC_CURSOR_H
     22
     23#include "config.h"
     24
     25#include <rfb/rfbclient.h>
     26#include <rfb/rfbproto.h>
     27
     28/**
     29 * Callback invoked by libVNCServer when it receives a new cursor image from
     30 * the VNC server. The cursor image itself will be split across
     31 * client->rcSource and client->rcMask, where rcSource is an image buffer of
     32 * the format natively used by the current VNC connection, and rcMask is an
     33 * array if bitmasks. Each bit within rcMask corresponds to a pixel within
     34 * rcSource, where a 0 denotes full transparency and a 1 denotes full opacity.
     35 *
     36 * @param client
     37 *     The VNC client associated with the VNC session in which the new cursor
     38 *     image was received.
     39 *
     40 * @param x
     41 *     The X coordinate of the new cursor image's hotspot, in pixels.
     42 *
     43 * @param y
     44 *     The Y coordinate of the new cursor image's hotspot, in pixels.
     45 *
     46 * @param w
     47 *     The width of the cursor image, in pixels.
     48 *
     49 * @param h
     50 *     The height of the cursor image, in pixels.
     51 *
     52 * @param bpp
     53 *     The number of bytes in each pixel, which must be either 4, 2, or 1.
     54 */
     55void guac_vnc_cursor(rfbClient* client, int x, int y, int w, int h, int bpp);
     56
     57#endif
     58