struct SpiceDisplayChannel

struct SpiceDisplayChannel;

The SpiceDisplayChannel struct is opaque and should not be accessed directly.

struct SpiceDisplayChannelClass

struct SpiceDisplayChannelClass {
    SpiceChannelClass parent_class;

    /* signals */
    void (*display_primary_create)(SpiceChannel *channel, gint format,
                                   gint width, gint height, gint stride,
                                   gint shmid, gpointer data);
    void (*display_primary_destroy)(SpiceChannel *channel);
    void (*display_invalidate)(SpiceChannel *channel,
                               gint x, gint y, gint w, gint h);
    void (*display_mark)(SpiceChannel *channel,
                         gboolean mark);
};

Class structure for SpiceDisplayChannel.

struct SpiceDisplayMonitorConfig

struct SpiceDisplayMonitorConfig {
    guint id;
    guint surface_id;
    guint x;
    guint y;
    guint width;
    guint height;
};

Holds a monitor configuration.

struct SpiceDisplayPrimary

struct SpiceDisplayPrimary {
    enum SpiceSurfaceFmt format;
    gint width;
    gint height;
    gint stride;
    gint shmid;
    guint8 *data;
    gboolean marked;
};

Holds the information necessary to use the primary surface.

struct SpiceGlScanout

struct SpiceGlScanout {
    gint fd;
    guint32 width;
    guint32 height;
    guint32 stride;
    guint32 format;
    gboolean y0top;
};

Holds the information necessary for using the GL display scanout.

spice_display_get_gl_scanout ()

const SpiceGlScanout * spice_display_get_gl_scanout     (SpiceDisplayChannel *channel);

Retrieves the GL scanout if available

Since 0.31

spice_display_gl_draw_done ()

void                spice_display_gl_draw_done          (SpiceDisplayChannel *channel);

After a SpiceDisplayChannel::gl-draw is emitted, the client should draw the current display with the current GL scanout, and must release the GL resource with a call to spice_display_gl_draw_done() (failing to do so for each gl-draw may result in a frozen display).

Since 0.31

spice_display_get_primary ()

gboolean            spice_display_get_primary           (SpiceChannel *channel,
                                                         guint32 surface_id,
                                                         SpiceDisplayPrimary *primary);

Retrieve primary display surface surface_id.

spice_display_change_preferred_compression ()

void                spice_display_change_preferred_compression
                                                        (SpiceChannel *channel,
                                                         gint compression);

Tells the spice server to change the preferred image compression for the channel.

Since 0.31

spice_display_change_preferred_video_codec_type ()

void                spice_display_change_preferred_video_codec_type
                                                        (SpiceChannel *channel,
                                                         gint codec_type);

Tells the spice server to change the preferred video codec type for streaming in channel. Application can set only one preferred video codec per display channel.

Since 0.34

spice_gl_scanout_free ()

void                spice_gl_scanout_free               (SpiceGlScanout *scanout);

Frees the scanout.

Since 0.31

The "gl-scanout" property

  "gl-scanout"               SpiceGlScanout*       : Read

The last SpiceGlScanout received.

Since 0.31

The "height" property

  "height"                   guint                 : Read

The primary surface height.

Default value: 0

The "monitors" property

  "monitors"                 GArray*               : Read

Current monitors configuration.

Since 0.13

The "monitors-max" property

  "monitors-max"             guint                 : Read

The maximum number of monitors the server or guest supports. May change during client lifetime, for instance guest may reboot or dynamically adjust this.

Allowed values: [1,256]

Default value: 1

Since 0.13

The "width" property

  "width"                    guint                 : Read

The primary surface width.

Default value: 0

The "display-invalidate" signal

void                user_function                      (SpiceDisplayChannel *display,
                                                        gint                 x,
                                                        gint                 y,
                                                        gint                 width,
                                                        gint                 height,
                                                        gpointer             user_data)      : Run First

The "display-invalidate" signal is emitted when the rectangular region x/y/w/h of the primary buffer is updated.

The "display-mark" signal

void                user_function                      (SpiceDisplayChannel *display,
                                                        gint                 mark,
                                                        gpointer             user_data)      : Run First

The "display-mark" signal is emitted when the RED_DISPLAY_MARK command is received, and the display should be exposed.

The "display-primary-create" signal

void                user_function                      (SpiceDisplayChannel *display,
                                                        gint                 format,
                                                        gint                 width,
                                                        gint                 height,
                                                        gint                 stride,
                                                        gint                 shmid,
                                                        gpointer             imgdata,
                                                        gpointer             user_data)      : Run First

The "display-primary-create" signal provides main display buffer data.

The "display-primary-destroy" signal

void                user_function                      (SpiceDisplayChannel *display,
                                                        gpointer             user_data)      : Run First

The "display-primary-destroy" signal is emitted when the primary surface is freed and should not be accessed anymore.

The "gl-draw" signal

void                user_function                      (SpiceDisplayChannel *display,
                                                        guint                x,
                                                        guint                y,
                                                        guint                width,
                                                        guint                height,
                                                        gpointer             user_data)

The "draw" signal is emitted when the rectangular region x/y/w/h of the GL scanout is updated and must be drawn. When the draw is finished, you must call spice_display_gl_draw_done() in order to release the GL resources.

Since 0.31