Documentation
¶
Overview ¶
Package framebuffer provides direct framebuffer access and capture helpers.
It is intended to wrap private framebuffer, framebuffer view, and graphics scanout APIs so callers can capture images, inspect framebuffer geometry, and manage headless or off-screen presentation without relying on window server screenshots.
The package should cover:
Framebuffer and view wrappers Screenshot helpers for headed and headless VMs Scanout enumeration and reconfiguration
This package is the low-level display primitive for higher-level packages such as vnc and remote automation tooling.
Index ¶
- type Display
- type Framebuffer
- type View
- func (v View) AttachFramebuffer(framebuffer *pvz.VZFramebuffer) error
- func (v View) DisplayProtectionOptions() objectivec.IObject
- func (v View) Framebuffer() *pvz.VZFramebuffer
- func (v View) FramebufferSize() corefoundation.CGSize
- func (v View) Raw() pvz.VZFramebufferView
- func (v View) SetFramebuffer(framebuffer *pvz.VZFramebuffer)
- func (v View) SetShowsCursor(shows bool)
- func (v View) SetSuppressFrameUpdates(suppress bool)
- func (v View) ShowsCursor() bool
- func (v View) SuppressFrameUpdates() bool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Display ¶
type Display struct {
// contains filtered or unexported fields
}
Display wraps a private graphics display.
func FromGraphicsDisplay ¶
func FromGraphicsDisplay(display pvz.VZGraphicsDisplay) Display
FromGraphicsDisplay wraps a private graphics display.
func FromGraphicsDisplayID ¶
func FromGraphicsDisplayID(id objectivec.IObject) Display
FromGraphicsDisplayID wraps a private graphics display from an objc.ID.
func (Display) Configuration ¶
func (d Display) Configuration() objectivec.IObject
Configuration returns the private display configuration object.
func (Display) GraphicsDevice ¶
func (d Display) GraphicsDevice() objectivec.IObject
GraphicsDevice returns the underlying graphics device object.
func (Display) GraphicsOrientation ¶
GraphicsOrientation returns the display orientation.
func (Display) Raw ¶
func (d Display) Raw() pvz.VZGraphicsDisplay
Raw returns the underlying display.
func (Display) TakeScreenshot ¶
TakeScreenshot triggers a screenshot on the display and waits for completion.
func (Display) Uuid ¶
func (d Display) Uuid() objectivec.IObject
Uuid returns the display UUID object.
type Framebuffer ¶
type Framebuffer struct {
// contains filtered or unexported fields
}
Framebuffer wraps a private framebuffer object.
func FromFramebuffer ¶
func FromFramebuffer(raw pvz.VZFramebuffer) Framebuffer
FromFramebuffer wraps an existing framebuffer.
func NewFramebuffer ¶
func NewFramebuffer() Framebuffer
NewFramebuffer creates a new framebuffer wrapper.
func (Framebuffer) Raw ¶
func (f Framebuffer) Raw() pvz.VZFramebuffer
Raw returns the underlying framebuffer.
func (Framebuffer) TakeScreenshot ¶
func (f Framebuffer) TakeScreenshot(ctx context.Context) error
TakeScreenshot triggers the private framebuffer screenshot path. The generated binding currently exposes only completion and conversion blocks without typed image payloads, so this helper just waits for completion.
type View ¶
type View struct {
// contains filtered or unexported fields
}
View wraps a framebuffer view.
func NewViewWithFrame ¶
func NewViewWithFrame(frame corefoundation.CGRect) View
NewViewWithFrame creates a framebuffer view for the given frame.
func (View) AttachFramebuffer ¶
func (v View) AttachFramebuffer(framebuffer *pvz.VZFramebuffer) error
AttachFramebuffer allocates a framebuffer and attaches it to the view.
func (View) DisplayProtectionOptions ¶
func (v View) DisplayProtectionOptions() objectivec.IObject
DisplayProtectionOptions returns the current display protection options.
func (View) Framebuffer ¶
func (v View) Framebuffer() *pvz.VZFramebuffer
Framebuffer returns the attached framebuffer.
func (View) FramebufferSize ¶
func (v View) FramebufferSize() corefoundation.CGSize
FramebufferSize returns the framebuffer size.
func (View) Raw ¶
func (v View) Raw() pvz.VZFramebufferView
Raw returns the underlying framebuffer view.
func (View) SetFramebuffer ¶
func (v View) SetFramebuffer(framebuffer *pvz.VZFramebuffer)
SetFramebuffer attaches a framebuffer to the view.
func (View) SetShowsCursor ¶
SetShowsCursor toggles cursor visibility.
func (View) SetSuppressFrameUpdates ¶
SetSuppressFrameUpdates toggles frame update suppression.
func (View) ShowsCursor ¶
ShowsCursor reports whether the cursor is visible.
func (View) SuppressFrameUpdates ¶
SuppressFrameUpdates reports whether frame updates are suppressed.
Source Files