shm

package
v1.2.2 Latest Latest
Warning

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

Go to latest
Published: Jul 27, 2024 License: BSD-3-Clause, GooglePatentClause Imports: 7 Imported by: 0

Documentation

Overview

FILE GENERATED AUTOMATICALLY FROM "shm.xml"

Index

Constants

View Source
const (
	// ExtName is the user-friendly name string of this X extension.
	ExtName = "Shm"

	// ExtXName is the name string this extension is known by to the X server.
	ExtXName = "MIT-SHM"
)
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 Attach

func Attach(c *xgb.XConn, Shmseg Seg, Shmid uint32, ReadOnly bool) error

Attach sends a checked request.

func AttachFd

func AttachFd(c *xgb.XConn, Shmseg Seg, ReadOnly bool) error

AttachFd sends a checked request.

func AttachFdUnchecked added in v1.1.0

func AttachFdUnchecked(c *xgb.XConn, Shmseg Seg, ReadOnly bool) error

AttachFdUnchecked sends an unchecked request.

func AttachUnchecked added in v1.1.0

func AttachUnchecked(c *xgb.XConn, Shmseg Seg, Shmid uint32, ReadOnly bool) error

AttachUnchecked sends an unchecked request.

func CreatePixmap

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

CreatePixmap sends a checked request.

func CreatePixmapUnchecked added in v1.1.0

func CreatePixmapUnchecked(c *xgb.XConn, Pid xproto.Pixmap, Drawable xproto.Drawable, Width uint16, Height uint16, Depth byte, Shmseg Seg, Offset uint32) error

CreatePixmapUnchecked sends an unchecked request.

func CreateSegmentUnchecked

func CreateSegmentUnchecked(c *xgb.XConn, Shmseg Seg, Size uint32, ReadOnly bool) error

CreateSegmentUnchecked sends an unchecked request.

func Detach

func Detach(c *xgb.XConn, Shmseg Seg) error

Detach sends a checked request.

func DetachUnchecked added in v1.1.0

func DetachUnchecked(c *xgb.XConn, Shmseg Seg) error

DetachUnchecked sends an unchecked request.

func GetImageUnchecked

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

GetImageUnchecked sends an unchecked request.

func PutImage

func PutImage(c *xgb.XConn, 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 bool, Shmseg Seg, Offset uint32) error

PutImage sends a checked request.

func PutImageUnchecked added in v1.1.0

func PutImageUnchecked(c *xgb.XConn, 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 bool, Shmseg Seg, Offset uint32) error

PutImageUnchecked sends an unchecked request.

func QueryVersionUnchecked

func QueryVersionUnchecked(c *xgb.XConn) error

QueryVersionUnchecked sends an unchecked request.

func Register added in v1.1.0

func Register(xconn *xgb.XConn) error

Register will query the X server for Shm extension support, and register relevant extension unmarshalers with the XConn.

func UnmarshalBadSegError added in v1.1.0

func UnmarshalBadSegError(buf []byte) (xgb.XError, error)

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

func UnmarshalCompletionEvent added in v1.1.0

func UnmarshalCompletionEvent(buf []byte) (xgb.XEvent, error)

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

Types

type BadSegError

type BadSegError xproto.ValueError

func (*BadSegError) BadID added in v1.1.0

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) SeqID added in v1.1.0

func (err *BadSegError) SeqID() 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) SeqID added in v1.1.0

func (v *CompletionEvent) SeqID() uint16

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

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.

func CreateSegment

func CreateSegment(c *xgb.XConn, Shmseg Seg, Size uint32, ReadOnly bool) (CreateSegmentReply, error)

CreateSegment sends a checked request.

func (*CreateSegmentReply) Unmarshal added in v1.1.0

func (v *CreateSegmentReply) Unmarshal(buf []byte) error

Unmarshal reads a byte slice into a CreateSegmentReply value.

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.

func GetImage

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

GetImage sends a checked request.

func (*GetImageReply) Unmarshal added in v1.1.0

func (v *GetImageReply) Unmarshal(buf []byte) error

Unmarshal reads a byte slice into a GetImageReply value.

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.

func QueryVersion

func QueryVersion(c *xgb.XConn) (QueryVersionReply, error)

QueryVersion sends a checked request.

func (*QueryVersionReply) Unmarshal added in v1.1.0

func (v *QueryVersionReply) Unmarshal(buf []byte) error

Unmarshal reads a byte slice into a QueryVersionReply value.

type Seg

type Seg uint32

func NewSegID added in v1.1.0

func NewSegID(c *xgb.XConn) Seg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL