Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

compose

package module

Go to main page

Versions in this module

v0

v0.2.0

May 19, 2026

Changes in this version

type Frame

+ Sequence uint64

type Server

+ func (s *Server) Snapshot() map[uint64]*Frame

v0.1.0

May 17, 2026

Changes in this version

+ var ErrClosed = errors.New("compose: server/client closed")

+ var ErrMaxModules = conn.ErrMaxModules

+ var ErrModuleNotFound = errors.New("compose: module not found")

+ var ErrNameTaken = conn.ErrNameTaken

+ var ErrNotAccepted = errors.New("compose: connection not accepted by compositor")

+ type Client struct

+ func Dial(addr string, opts ...ClientOption) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) ModuleID() uint64

+ func (c *Client) OnFrameRequest(fn func())

+ func (c *Client) PublishFrame(f Frame) error

+ func (c *Client) SetCompression(algo string)

+ type ClientOption func(*clientConfig)

+ func WithFPS(fps uint16) ClientOption

+ func WithFrameSize(width, height uint32) ClientOption

+ func WithName(name string) ClientOption

+ type Frame struct

+ DirtyRect image.Rectangle

+ Height uint32

+ ModuleID uint64

+ Name string

+ Pixels []byte

+ Timestamp int64

+ Width uint32

+ type Server struct

+ func Listen(addr string, opts ...ServerOption) (*Server, error)

+ func (s *Server) Close() error

+ func (s *Server) OnConnect(fn func(id uint64, name string))

+ func (s *Server) OnDisconnect(fn func(id uint64, name string))

+ func (s *Server) OnFrame(fn func(Frame))

+ func (s *Server) RequestFrame(moduleID uint64) error

+ type ServerOption func(*serverConfig)

+ func WithCompression(algo string) ServerOption

+ func WithMaxModules(n int) ServerOption