exp: golang.org/x/exp/shiny/vendor/github.com/BurntSushi/xgb/shm Index | Files

package shm

import "golang.org/x/exp/shiny/vendor/github.com/BurntSushi/xgb/shm"

Package shm is the X client API for the MIT-SHM extension.

Index

Package Files

shm.go

Constants

const BadBadSeg = 0

BadBadSeg is the error number for a BadBadSeg.

const Completion = 0

Completion is the event number for a CompletionEvent.

func BadSegErrorNew Uses

func BadSegErrorNew(buf []byte) xgb.Error

BadSegErrorNew constructs a BadSegError value that implements xgb.Error from a byte slice.

func CompletionEventNew Uses

func CompletionEventNew(buf []byte) xgb.Event

CompletionEventNew constructs a CompletionEvent value that implements xgb.Event from a byte slice.

func Init Uses

func Init(c *xgb.Conn) error

Init must be called before using the MIT-SHM extension.

type AttachCookie Uses

type AttachCookie struct {
    *xgb.Cookie
}

AttachCookie is a cookie used only for Attach requests.

func Attach Uses

func Attach(c *xgb.Conn, Shmseg Seg, Shmid uint32, ReadOnly bool) AttachCookie

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

func AttachChecked Uses

func AttachChecked(c *xgb.Conn, Shmseg Seg, Shmid uint32, ReadOnly bool) AttachCookie

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

func (AttachCookie) Check Uses

func (cook AttachCookie) 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 AttachFdCookie Uses

type AttachFdCookie struct {
    *xgb.Cookie
}

AttachFdCookie is a cookie used only for AttachFd requests.

func AttachFd Uses

func AttachFd(c *xgb.Conn, Shmseg Seg, ReadOnly bool) AttachFdCookie

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

func AttachFdChecked Uses

func AttachFdChecked(c *xgb.Conn, Shmseg Seg, ReadOnly bool) AttachFdCookie

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

func (AttachFdCookie) Check Uses

func (cook AttachFdCookie) 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 BadSegError Uses

type BadSegError xproto.ValueError

func (BadSegError) BadId Uses

func (err BadSegError) BadId() uint32

BadId returns the 'BadValue' number if one exists for the BadBadSeg error. If no bad value exists, 0 is returned.

func (BadSegError) Error Uses

func (err BadSegError) Error() string

Error returns a rudimentary string representation of the BadBadSeg error.

func (BadSegError) SequenceId Uses

func (err BadSegError) SequenceId() uint16

SequenceId returns the sequence id attached to the BadBadSeg error. This is mostly used internally.

type CompletionEvent Uses

type CompletionEvent struct {
    Sequence uint16
    // padding: 1 bytes
    Drawable   xproto.Drawable
    MinorEvent uint16
    MajorEvent byte
    // padding: 1 bytes
    Shmseg Seg
    Offset uint32
}

func (CompletionEvent) Bytes Uses

func (v CompletionEvent) Bytes() []byte

Bytes writes a CompletionEvent value to a byte slice.

func (CompletionEvent) SequenceId Uses

func (v CompletionEvent) SequenceId() uint16

SequenceId returns the sequence id attached to the Completion event. Events without a sequence number (KeymapNotify) return 0. This is mostly used internally.

func (CompletionEvent) String Uses

func (v CompletionEvent) String() string

String is a rudimentary string representation of CompletionEvent.

type CreatePixmapCookie Uses

type CreatePixmapCookie struct {
    *xgb.Cookie
}

CreatePixmapCookie is a cookie used only for CreatePixmap requests.

func CreatePixmap Uses

func CreatePixmap(c *xgb.Conn, Pid xproto.Pixmap, Drawable xproto.Drawable, Width uint16, Height uint16, Depth byte, Shmseg Seg, Offset uint32) CreatePixmapCookie

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

func CreatePixmapChecked Uses

func CreatePixmapChecked(c *xgb.Conn, Pid xproto.Pixmap, Drawable xproto.Drawable, Width uint16, Height uint16, Depth byte, Shmseg Seg, Offset uint32) CreatePixmapCookie

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

func (CreatePixmapCookie) Check Uses

func (cook CreatePixmapCookie) 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 CreateSegmentCookie Uses

type CreateSegmentCookie struct {
    *xgb.Cookie
}

CreateSegmentCookie is a cookie used only for CreateSegment requests.

func CreateSegment Uses

func CreateSegment(c *xgb.Conn, Shmseg Seg, Size uint32, ReadOnly bool) CreateSegmentCookie

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

func CreateSegmentUnchecked Uses

func CreateSegmentUnchecked(c *xgb.Conn, Shmseg Seg, Size uint32, ReadOnly bool) CreateSegmentCookie

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

func (CreateSegmentCookie) Reply Uses

func (cook CreateSegmentCookie) Reply() (*CreateSegmentReply, error)

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

type CreateSegmentReply Uses

type CreateSegmentReply struct {
    Sequence uint16 // sequence number of the request for this reply
    Length   uint32 // number of bytes in this reply
    Nfd      byte
}

CreateSegmentReply represents the data returned from a CreateSegment request.

type DetachCookie Uses

type DetachCookie struct {
    *xgb.Cookie
}

DetachCookie is a cookie used only for Detach requests.

func Detach Uses

func Detach(c *xgb.Conn, Shmseg Seg) DetachCookie

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

func DetachChecked Uses

func DetachChecked(c *xgb.Conn, Shmseg Seg) DetachCookie

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

func (DetachCookie) Check Uses

func (cook DetachCookie) 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 GetImageCookie Uses

type GetImageCookie struct {
    *xgb.Cookie
}

GetImageCookie is a cookie used only for GetImage requests.

func GetImage Uses

func GetImage(c *xgb.Conn, Drawable xproto.Drawable, X int16, Y int16, Width uint16, Height uint16, PlaneMask uint32, Format byte, Shmseg Seg, Offset uint32) GetImageCookie

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

func GetImageUnchecked Uses

func GetImageUnchecked(c *xgb.Conn, Drawable xproto.Drawable, X int16, Y int16, Width uint16, Height uint16, PlaneMask uint32, Format byte, Shmseg Seg, Offset uint32) GetImageCookie

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

func (GetImageCookie) Reply Uses

func (cook GetImageCookie) Reply() (*GetImageReply, error)

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

type GetImageReply Uses

type GetImageReply struct {
    Sequence uint16 // sequence number of the request for this reply
    Length   uint32 // number of bytes in this reply
    Depth    byte
    Visual   xproto.Visualid
    Size     uint32
}

GetImageReply represents the data returned from a GetImage request.

type PutImageCookie Uses

type PutImageCookie struct {
    *xgb.Cookie
}

PutImageCookie is a cookie used only for PutImage requests.

func PutImage Uses

func PutImage(c *xgb.Conn, Drawable xproto.Drawable, Gc xproto.Gcontext, TotalWidth uint16, TotalHeight uint16, SrcX uint16, SrcY uint16, SrcWidth uint16, SrcHeight uint16, DstX int16, DstY int16, Depth byte, Format byte, SendEvent byte, Shmseg Seg, Offset uint32) PutImageCookie

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

func PutImageChecked Uses

func PutImageChecked(c *xgb.Conn, Drawable xproto.Drawable, Gc xproto.Gcontext, TotalWidth uint16, TotalHeight uint16, SrcX uint16, SrcY uint16, SrcWidth uint16, SrcHeight uint16, DstX int16, DstY int16, Depth byte, Format byte, SendEvent byte, Shmseg Seg, Offset uint32) PutImageCookie

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

func (PutImageCookie) Check Uses

func (cook PutImageCookie) 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 Uses

type QueryVersionCookie struct {
    *xgb.Cookie
}

QueryVersionCookie is a cookie used only for QueryVersion requests.

func QueryVersion Uses

func QueryVersion(c *xgb.Conn) QueryVersionCookie

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

func QueryVersionUnchecked Uses

func QueryVersionUnchecked(c *xgb.Conn) QueryVersionCookie

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

func (QueryVersionCookie) Reply Uses

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

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

type QueryVersionReply Uses

type QueryVersionReply struct {
    Sequence      uint16 // sequence number of the request for this reply
    Length        uint32 // number of bytes in this reply
    SharedPixmaps bool
    MajorVersion  uint16
    MinorVersion  uint16
    Uid           uint16
    Gid           uint16
    PixmapFormat  byte
}

QueryVersionReply represents the data returned from a QueryVersion request.

type Seg Uses

type Seg uint32

func NewSegId Uses

func NewSegId(c *xgb.Conn) (Seg, error)

Package shm imports 2 packages (graph). Updated 2017-06-05. Refresh now. Tools for package owners.