Function x11rb::protocol::xproto::create_glyph_cursor

source · 
pub fn create_glyph_cursor<Conn, A>(
    conn: &Conn,
    cid: Cursor,
    source_font: Font,
    mask_font: A,
    source_char: u16,
    mask_char: u16,
    fore_red: u16,
    fore_green: u16,
    fore_blue: u16,
    back_red: u16,
    back_green: u16,
    back_blue: u16
) -> Result<VoidCookie<'_, Conn>, ConnectionError>
where
    Conn: RequestConnection + ?Sized,
    A: Into<Font>,
Expand description

create cursor.

Creates a cursor from a font glyph. X provides a set of standard cursor shapes in a special font named cursor. Applications are encouraged to use this interface for their cursors because the font can be customized for the individual display type.

All pixels which are set to 1 in the source will use the foreground color (as specified by fore_red, fore_green and fore_blue). All pixels set to 0 will use the background color (as specified by back_red, back_green and back_blue).

Fields

  • cid - The ID with which you will refer to the cursor, created by xcb_generate_id.
  • source_font - In which font to look for the cursor glyph.
  • mask_font - In which font to look for the mask glyph.
  • source_char - The glyph of source_font to use.
  • mask_char - The glyph of mask_font to use as a mask: Pixels which are set to 1 define which source pixels are displayed. All pixels which are set to 0 are not displayed.
  • fore_red - The red value of the foreground color.
  • fore_green - The green value of the foreground color.
  • fore_blue - The blue value of the foreground color.
  • back_red - The red value of the background color.
  • back_green - The green value of the background color.
  • back_blue - The blue value of the background color.

Errors

  • Alloc - The X server could not allocate the requested resources (no memory?).
  • Font - The specified source_font or mask_font does not exist.
  • Value - Either source_char or mask_char are not defined in source_font or mask_font, respectively.