shm

package
v0.0.0-...-103704b Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 26, 2022 License: 0BSD, BSD-3-Clause Imports: 2 Imported by: 0

Documentation

Overview

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

Index

Constants

View Source 
const (
	MajorVersion = 1
	MinorVersion = 2
)
View Source 
const BadBadSeg = 0

BadBadSeg is the error number for a BadBadSeg.

View Source 
const Completion = 0

Completion is the event number for a CompletionEvent.

Variables

This section is empty.

Functions

func BadSegErrorNew 

func BadSegErrorNew(buf []byte) xgb.Error

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

func CompletionEventNew 

func CompletionEventNew(buf []byte) xgb.Event

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

func Init 

func Init(c *xgb.Conn) error

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

Types

type AttachCookie 

type AttachCookie struct {
	*xgb.Cookie
}

AttachCookie is a cookie used only for Attach requests.

func Attach 

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 

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 

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 

type AttachFdCookie struct {
	*xgb.Cookie
}

AttachFdCookie is a cookie used only for AttachFd requests.

func AttachFd 

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 

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 

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 

type BadSegError xproto.ValueError

func (BadSegError) BadId 

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 

func (err BadSegError) Error() string

Error returns a rudimentary string representation of the BadBadSeg error.

func (BadSegError) SequenceId 

func (err BadSegError) SequenceId() uint16

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

type CompletionEvent 

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 

func (v CompletionEvent) Bytes() []byte

Bytes writes a CompletionEvent value to a byte slice.

func (CompletionEvent) SequenceId 

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 

func (v CompletionEvent) String() string

String is a rudimentary string representation of CompletionEvent.

type CreatePixmapCookie 

type CreatePixmapCookie struct {
	*xgb.Cookie
}

CreatePixmapCookie is a cookie used only for CreatePixmap requests.

func CreatePixmap 

func CreatePixmap(c *xgb.Conn, Pid xproto.Pixmap, Drawable xproto.Drawable, Width, 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 

func CreatePixmapChecked(c *xgb.Conn, Pid xproto.Pixmap, Drawable xproto.Drawable, Width, 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 

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 

type CreateSegmentCookie struct {
	*xgb.Cookie
}

CreateSegmentCookie is a cookie used only for CreateSegment requests.

func CreateSegment 

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 

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 

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

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

type CreateSegmentReply 

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 

type DetachCookie struct {
	*xgb.Cookie
}

DetachCookie is a cookie used only for Detach requests.

func Detach 

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 

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 

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 

type GetImageCookie struct {
	*xgb.Cookie
}

GetImageCookie is a cookie used only for GetImage requests.

func GetImage 

func GetImage(c *xgb.Conn, Drawable xproto.Drawable, X, Y int16, Width, 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 

func GetImageUnchecked(c *xgb.Conn, Drawable xproto.Drawable, X, Y int16, Width, 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 

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

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

type GetImageReply 

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 

type PutImageCookie struct {
	*xgb.Cookie
}

PutImageCookie is a cookie used only for PutImage requests.

func PutImage 

func PutImage(c *xgb.Conn, Drawable xproto.Drawable, Gc xproto.Gcontext, TotalWidth, TotalHeight, SrcX, SrcY, SrcWidth, SrcHeight uint16, DstX, DstY int16, Depth, Format, 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 

func PutImageChecked(c *xgb.Conn, Drawable xproto.Drawable, Gc xproto.Gcontext, TotalWidth, TotalHeight, SrcX, SrcY, SrcWidth, SrcHeight uint16, DstX, DstY int16, Depth, Format, 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 

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 

type QueryVersionCookie struct {
	*xgb.Cookie
}

QueryVersionCookie is a cookie used only for QueryVersion requests.

func QueryVersion 

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 

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 

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
	SharedPixmaps bool
	MajorVersion  uint16
	MinorVersion  uint16
	Uid           uint16
	Gid           uint16
	PixmapFormat  byte
}

QueryVersionReply represents the data returned from a QueryVersion request.

type Seg 

type Seg uint32

func NewSegId 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.