Package composite

import "github.com/BurntSushi/xgb/composite"
Overview
Index

Overview ▾

Package composite is the X client API for the Composite extension.

Index ▾

Constants
func Init(c *xgb.Conn) error
type CreateRegionFromBorderClipCookie
    func CreateRegionFromBorderClip(c *xgb.Conn, Region xfixes.Region, Window xproto.Window) CreateRegionFromBorderClipCookie
    func CreateRegionFromBorderClipChecked(c *xgb.Conn, Region xfixes.Region, Window xproto.Window) CreateRegionFromBorderClipCookie
    func (cook CreateRegionFromBorderClipCookie) Check() error
type GetOverlayWindowCookie
    func GetOverlayWindow(c *xgb.Conn, Window xproto.Window) GetOverlayWindowCookie
    func GetOverlayWindowUnchecked(c *xgb.Conn, Window xproto.Window) GetOverlayWindowCookie
    func (cook GetOverlayWindowCookie) Reply() (*GetOverlayWindowReply, error)
type GetOverlayWindowReply
type NameWindowPixmapCookie
    func NameWindowPixmap(c *xgb.Conn, Window xproto.Window, Pixmap xproto.Pixmap) NameWindowPixmapCookie
    func NameWindowPixmapChecked(c *xgb.Conn, Window xproto.Window, Pixmap xproto.Pixmap) NameWindowPixmapCookie
    func (cook NameWindowPixmapCookie) Check() error
type QueryVersionCookie
    func QueryVersion(c *xgb.Conn, ClientMajorVersion uint32, ClientMinorVersion uint32) QueryVersionCookie
    func QueryVersionUnchecked(c *xgb.Conn, ClientMajorVersion uint32, ClientMinorVersion uint32) QueryVersionCookie
    func (cook QueryVersionCookie) Reply() (*QueryVersionReply, error)
type QueryVersionReply
type RedirectSubwindowsCookie
    func RedirectSubwindows(c *xgb.Conn, Window xproto.Window, Update byte) RedirectSubwindowsCookie
    func RedirectSubwindowsChecked(c *xgb.Conn, Window xproto.Window, Update byte) RedirectSubwindowsCookie
    func (cook RedirectSubwindowsCookie) Check() error
type RedirectWindowCookie
    func RedirectWindow(c *xgb.Conn, Window xproto.Window, Update byte) RedirectWindowCookie
    func RedirectWindowChecked(c *xgb.Conn, Window xproto.Window, Update byte) RedirectWindowCookie
    func (cook RedirectWindowCookie) Check() error
type ReleaseOverlayWindowCookie
    func ReleaseOverlayWindow(c *xgb.Conn, Window xproto.Window) ReleaseOverlayWindowCookie
    func ReleaseOverlayWindowChecked(c *xgb.Conn, Window xproto.Window) ReleaseOverlayWindowCookie
    func (cook ReleaseOverlayWindowCookie) Check() error
type UnredirectSubwindowsCookie
    func UnredirectSubwindows(c *xgb.Conn, Window xproto.Window, Update byte) UnredirectSubwindowsCookie
    func UnredirectSubwindowsChecked(c *xgb.Conn, Window xproto.Window, Update byte) UnredirectSubwindowsCookie
    func (cook UnredirectSubwindowsCookie) Check() error
type UnredirectWindowCookie
    func UnredirectWindow(c *xgb.Conn, Window xproto.Window, Update byte) UnredirectWindowCookie
    func UnredirectWindowChecked(c *xgb.Conn, Window xproto.Window, Update byte) UnredirectWindowCookie
    func (cook UnredirectWindowCookie) Check() error

Package files

composite.go

Constants

const (
    RedirectAutomatic = 0
    RedirectManual    = 1
)

func Init

func Init(c *xgb.Conn) error

Init must be called before using the Composite extension.

type CreateRegionFromBorderClipCookie

type CreateRegionFromBorderClipCookie struct {
    *xgb.Cookie
}

CreateRegionFromBorderClipCookie is a cookie used only for CreateRegionFromBorderClip requests.

func CreateRegionFromBorderClip

func CreateRegionFromBorderClip(c *xgb.Conn, Region xfixes.Region, Window xproto.Window) CreateRegionFromBorderClipCookie

CreateRegionFromBorderClip sends an unchecked request. If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.

func CreateRegionFromBorderClipChecked

func CreateRegionFromBorderClipChecked(c *xgb.Conn, Region xfixes.Region, Window xproto.Window) CreateRegionFromBorderClipCookie

CreateRegionFromBorderClipChecked sends a checked request. If an error occurs, it can be retrieved using CreateRegionFromBorderClipCookie.Check()

func (CreateRegionFromBorderClipCookie) Check

func (cook CreateRegionFromBorderClipCookie) Check() error

Check returns an error if one occurred for checked requests that are not expecting a reply. This cannot be called for requests expecting a reply, nor for unchecked requests.

type GetOverlayWindowCookie

type GetOverlayWindowCookie struct {
    *xgb.Cookie
}

GetOverlayWindowCookie is a cookie used only for GetOverlayWindow requests.

func GetOverlayWindow

func GetOverlayWindow(c *xgb.Conn, Window xproto.Window) GetOverlayWindowCookie

GetOverlayWindow sends a checked request. If an error occurs, it will be returned with the reply by calling GetOverlayWindowCookie.Reply()

func GetOverlayWindowUnchecked

func GetOverlayWindowUnchecked(c *xgb.Conn, Window xproto.Window) GetOverlayWindowCookie

GetOverlayWindowUnchecked sends an unchecked request. If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.

func (GetOverlayWindowCookie) Reply

func (cook GetOverlayWindowCookie) Reply() (*GetOverlayWindowReply, error)

Reply blocks and returns the reply data for a GetOverlayWindow request.

type GetOverlayWindowReply

type GetOverlayWindowReply struct {
    Sequence uint16 // sequence number of the request for this reply
    Length   uint32 // number of bytes in this reply
    // padding: 1 bytes
    OverlayWin xproto.Window
}

GetOverlayWindowReply represents the data returned from a GetOverlayWindow request.

type NameWindowPixmapCookie

type NameWindowPixmapCookie struct {
    *xgb.Cookie
}

NameWindowPixmapCookie is a cookie used only for NameWindowPixmap requests.

func NameWindowPixmap

func NameWindowPixmap(c *xgb.Conn, Window xproto.Window, Pixmap xproto.Pixmap) NameWindowPixmapCookie

NameWindowPixmap sends an unchecked request. If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.

func NameWindowPixmapChecked

func NameWindowPixmapChecked(c *xgb.Conn, Window xproto.Window, Pixmap xproto.Pixmap) NameWindowPixmapCookie

NameWindowPixmapChecked sends a checked request. If an error occurs, it can be retrieved using NameWindowPixmapCookie.Check()

func (NameWindowPixmapCookie) Check

func (cook NameWindowPixmapCookie) Check() error

Check returns an error if one occurred for checked requests that are not expecting a reply. This cannot be called for requests expecting a reply, nor for unchecked requests.

type QueryVersionCookie

type QueryVersionCookie struct {
    *xgb.Cookie
}

QueryVersionCookie is a cookie used only for QueryVersion requests.

func QueryVersion

func QueryVersion(c *xgb.Conn, ClientMajorVersion uint32, ClientMinorVersion uint32) QueryVersionCookie

QueryVersion sends a checked request. If an error occurs, it will be returned with the reply by calling QueryVersionCookie.Reply()

func QueryVersionUnchecked

func QueryVersionUnchecked(c *xgb.Conn, ClientMajorVersion uint32, ClientMinorVersion uint32) QueryVersionCookie

QueryVersionUnchecked sends an unchecked request. If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.

func (QueryVersionCookie) Reply

func (cook QueryVersionCookie) Reply() (*QueryVersionReply, error)

Reply blocks and returns the reply data for a QueryVersion request.

type QueryVersionReply

type QueryVersionReply struct {
    Sequence uint16 // sequence number of the request for this reply
    Length   uint32 // number of bytes in this reply
    // padding: 1 bytes
    MajorVersion uint32
    MinorVersion uint32
}

QueryVersionReply represents the data returned from a QueryVersion request.

type RedirectSubwindowsCookie

type RedirectSubwindowsCookie struct {
    *xgb.Cookie
}

RedirectSubwindowsCookie is a cookie used only for RedirectSubwindows requests.

func RedirectSubwindows

func RedirectSubwindows(c *xgb.Conn, Window xproto.Window, Update byte) RedirectSubwindowsCookie

RedirectSubwindows sends an unchecked request. If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.

func RedirectSubwindowsChecked

func RedirectSubwindowsChecked(c *xgb.Conn, Window xproto.Window, Update byte) RedirectSubwindowsCookie

RedirectSubwindowsChecked sends a checked request. If an error occurs, it can be retrieved using RedirectSubwindowsCookie.Check()

func (RedirectSubwindowsCookie) Check

func (cook RedirectSubwindowsCookie) Check() error

Check returns an error if one occurred for checked requests that are not expecting a reply. This cannot be called for requests expecting a reply, nor for unchecked requests.

type RedirectWindowCookie

type RedirectWindowCookie struct {
    *xgb.Cookie
}

RedirectWindowCookie is a cookie used only for RedirectWindow requests.

func RedirectWindow

func RedirectWindow(c *xgb.Conn, Window xproto.Window, Update byte) RedirectWindowCookie

RedirectWindow sends an unchecked request. If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.

func RedirectWindowChecked

func RedirectWindowChecked(c *xgb.Conn, Window xproto.Window, Update byte) RedirectWindowCookie

RedirectWindowChecked sends a checked request. If an error occurs, it can be retrieved using RedirectWindowCookie.Check()

func (RedirectWindowCookie) Check

func (cook RedirectWindowCookie) Check() error

Check returns an error if one occurred for checked requests that are not expecting a reply. This cannot be called for requests expecting a reply, nor for unchecked requests.

type ReleaseOverlayWindowCookie

type ReleaseOverlayWindowCookie struct {
    *xgb.Cookie
}

ReleaseOverlayWindowCookie is a cookie used only for ReleaseOverlayWindow requests.

func ReleaseOverlayWindow

func ReleaseOverlayWindow(c *xgb.Conn, Window xproto.Window) ReleaseOverlayWindowCookie

ReleaseOverlayWindow sends an unchecked request. If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.

func ReleaseOverlayWindowChecked

func ReleaseOverlayWindowChecked(c *xgb.Conn, Window xproto.Window) ReleaseOverlayWindowCookie

ReleaseOverlayWindowChecked sends a checked request. If an error occurs, it can be retrieved using ReleaseOverlayWindowCookie.Check()

func (ReleaseOverlayWindowCookie) Check

func (cook ReleaseOverlayWindowCookie) Check() error

Check returns an error if one occurred for checked requests that are not expecting a reply. This cannot be called for requests expecting a reply, nor for unchecked requests.

type UnredirectSubwindowsCookie

type UnredirectSubwindowsCookie struct {
    *xgb.Cookie
}

UnredirectSubwindowsCookie is a cookie used only for UnredirectSubwindows requests.

func UnredirectSubwindows

func UnredirectSubwindows(c *xgb.Conn, Window xproto.Window, Update byte) UnredirectSubwindowsCookie

UnredirectSubwindows sends an unchecked request. If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.

func UnredirectSubwindowsChecked

func UnredirectSubwindowsChecked(c *xgb.Conn, Window xproto.Window, Update byte) UnredirectSubwindowsCookie

UnredirectSubwindowsChecked sends a checked request. If an error occurs, it can be retrieved using UnredirectSubwindowsCookie.Check()

func (UnredirectSubwindowsCookie) Check

func (cook UnredirectSubwindowsCookie) Check() error

Check returns an error if one occurred for checked requests that are not expecting a reply. This cannot be called for requests expecting a reply, nor for unchecked requests.

type UnredirectWindowCookie

type UnredirectWindowCookie struct {
    *xgb.Cookie
}

UnredirectWindowCookie is a cookie used only for UnredirectWindow requests.

func UnredirectWindow

func UnredirectWindow(c *xgb.Conn, Window xproto.Window, Update byte) UnredirectWindowCookie

UnredirectWindow sends an unchecked request. If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.

func UnredirectWindowChecked

func UnredirectWindowChecked(c *xgb.Conn, Window xproto.Window, Update byte) UnredirectWindowCookie

UnredirectWindowChecked sends a checked request. If an error occurs, it can be retrieved using UnredirectWindowCookie.Check()

func (UnredirectWindowCookie) Check

func (cook UnredirectWindowCookie) Check() error

Check returns an error if one occurred for checked requests that are not expecting a reply. This cannot be called for requests expecting a reply, nor for unchecked requests.