forked from 12to11/12to11

EGL support is still incomplete; stuff like scaling is missing. * 12to11.c (PickVisual, XLMain): Remove function. Initialize renderers, and rely on that to initialize the visuals. * 12to11.man: Document new environment variables. * Imakefile (SRCS, OBJS): Add picture_renderer.c and renderer.c and their associated objects. (GENHEADERS): New variable for generated headers. (EGL_SRCS, EGL_OBJS): New variables. (LOCAL_LIBRARIES, SRCS, OBJS, DEFINES): [HaveEglSupport]: Add EGL defines, libraries, and objects.:(shaders.h): New rule. (depend, cleandir): Depend on generated headers and SRCs. $($(OBJS)): Depend on $(GENHEADERS). * README: Write how to build with EGL support and update content descriptions. * buffer.c (XLPictureFromBuffer): Delete function. (XLRenderBufferFromBuffer): New function. (XLPixmapFromBuffer): Delete function. * compositor.h (enum _Operation, struct _SharedMemoryAttributes) (struct _DmaBufAttributes, union _RenderTarget) (union _RenderBuffer, struct _RenderFuncs, struct _DrmFormat) (struct _ShmFormat, struct _BufferFuncs, struct _ExtBufferFuncs): New structures. (Fallthrough): New define. Define to __attribute__ ((fallthrough)) wherever supported. Replace uses of Picture with RenderBuffer. * dmabuf.c (struct _DrmFormatInfo): Remove structures. (struct _BufferParams): Remove link. (struct _Buffer): Replace pixmap and picture with render buffer object. (dri3_opcode, all_formats, pending_success, next_roundtrip_id) (round_trip_window): Delete. (ReleaseBufferParams, HandleParamsResourceDestroy, ForceRoundTrip) (DepthForFormat, XLHandleErrorForDmabuf, PictFormatForFormat) (DestroyBacking, GetPictureFunc, GetPixmapFunc, GetBufferFunc) (CreateBufferFor, ModifierHigh, FinishBufferCreation) (XLHandleOneXEventForDmabuf, CreateHeader, Create, CreateImmed) (FindFormatMatching, FindSupportedModifiers, FindSupportedFormats) (SendSupportedFormats, HandleBind, InitDrmDevice, WriteFormatTable) (ReallyInitDmabuf, ReadSupportedFormats, XLInitDmabuf): Remove various functions and reimplement as a wrapper around the renderer abstraction, instead of DRI3. * fns.c (struct _Busfault): New structure. (busfault_tree, bus_handler_installed): New variables. (GetHeight, FixHeights, RotateLeft, RotateRight, RebalanceBusfault) (RecordBusfault, DetectBusfault, DeleteMin, RemoveBusfault) (HandleBusfault, MaybeInstallBusHandler, BlockSigbus) (UnblockSigbus, XLRecordBusfault, XLRemoveBusfaults): New functions to store non-overlapping regions of mapped memory in an AVL tree, and to ignore SIGBUS events that trap within. * icon_surface.c (struct _IconSurface): Replace picture with rendering target. (ReleaseBacking, XLGetIconSurface): Use rendering targets instead of pictures. * libraries.def: Add defines for EGL. * run.c (HandleOneXEvent): Replace old dmabuf code with renderer code. * seat.c (CursorFromRole, PictureForCursor, ApplyCursor) (UpdateCursorFromSubcompositor, Subframe, EndSubframe): Rewrite cursor code to use rendering targets and not pictures. * shm.c (Buffer, DereferencePool): Remove SIGBUS protection. (DereferenceBuffer): Reimplement in terms of renderer functions. (GetPictureFunc): Delete function. (GetBufferFunc): New function. (GetPixmapFunc): Delete function. (PrintBuffer): Remove now-broken implementation. (DepthForFormat, PictFormatForFormat): Delete functions, as they are now part of the rendering backend. (IsFormatSupported): New function. (CreateBuffer): Reimplement in terms of renderer functions. (ResizePool): Change SIGBUS protection for resize. (CreatePool): Protect buffer data from SIGBUS should a client truncate the file. (PostFormats): Reimplement in terms of RenderGetShmFormats. (XLInitShm): Stop initializing MIT-SHM. * subcompositor.c (IsTargetAttached): New flag and associated macros. (struct _View): Remove useless field. (struct _Subcompositor): Change target to RenderTarget. Add fields for prior damage. (MakeSubcompositor): Initialize new fields. (SubcompositorSetTarget): Accept RenderTarget, not picture, and set target attached flag. (ViewGetTransform): Delete function. (ViewApplyTransform): New function. (FillBoxesWithTransparency): Reimplement in terms of renderer functions. (StorePreviousDamage): New function. (SubcompositorUpdate): Reimplement in terms of renderer functions. Also, learn to deal with situations where the buffer reflects the state 1 to 2 swaps ago. (SubcompositorExpose): Reimplement in terms of renderer functions. (SubcompositorFree): Free new fields. (SubcompositorInit): Remove no longer required initialization of identity matrix. * xdata.c (ReceiveBody): Fix coding style. * xdg_surface.c (struct _XdgRole, ReleaseBacking, XLGetXdgSurface): Switch from pictures to RenderTargets. * xerror.c (ErrorHandler): Handle errors for picture renderer instead of dmabuf.c.
104 lines
3.3 KiB
Groff
104 lines
3.3 KiB
Groff
.TH 12to11
|
|
.SH NAME
|
|
12to11 - Wayland to X protocol translator
|
|
.SH SYNOPSIS
|
|
.B 12to11
|
|
.SH DESCRIPTION
|
|
.I 12to11
|
|
starts a Wayland compositor on the next available socket;
|
|
Wayland programs will then be displayed through the X server.
|
|
.SH OPTIONS
|
|
None.
|
|
.SH ENVIRONMENT
|
|
Several environment variables exist that modify the behavior of the
|
|
protocol translator in one way or another. Most of these are used for
|
|
debugging, but some may be relevant to users as well.
|
|
.PP
|
|
The
|
|
.B USE_BUILTIN_RESIZE
|
|
environment variable, if set, forces the use of the built-in
|
|
drag-to-resize support provided by the protocol translator, even if
|
|
the X window manager provides its own.
|
|
.PP
|
|
The
|
|
.B DEBUG_REFRESH_PREDICTION
|
|
environment variable, if set, forces the frame clock to predict the
|
|
presentation deadline of the X compositing manager. This is used to
|
|
debug code that is otherwise not run without subsurfaces being
|
|
present.
|
|
.PP
|
|
The
|
|
.B DISABLE_FRAME_SYNCHRONIZATION
|
|
environment variable, if set, disables frame synchronization with the
|
|
X compositing manager. Setting this variable is probably not a good
|
|
idea.
|
|
.PP
|
|
The
|
|
.B SYNCHRONIZE
|
|
environment variable, if set, causes the X library to check for errors
|
|
immediately after issuing a request. The resulting backtraces from
|
|
the error handler then reflect the protocol request that actually
|
|
caused the error, instead of some unpredictable request in the future.
|
|
.PP
|
|
The
|
|
.B APPLY_STATE_WORKAROUND
|
|
environment variable, if set, causes the protocol translator to handle
|
|
toplevel window state changes differently. If Wayland programs do not
|
|
make the transition between fullscreen and maximized states correctly,
|
|
try setting this variable.
|
|
.PP
|
|
The
|
|
.B GLOBAL_SCALE
|
|
environment variable, if set to an integer, overrides the global
|
|
program scale factor normally provided by the
|
|
.I Gdk/WindowScalingFactor
|
|
X setting.
|
|
.PP
|
|
The
|
|
.B OUTPUT_SCALE
|
|
environment variable, if set to an integer, overrides the output scale
|
|
factor that is otherwise set to the global program scale factor.
|
|
Setting this option is only useful to debug Wayland program
|
|
downscaling.
|
|
.PP
|
|
The
|
|
.B DIRECT_STATE_CHANGES
|
|
variable, if set, forces ConfigureNotify events from the window
|
|
manager to be handled directly, without waiting some time for a
|
|
corresponding _NET_WM_STATE event to arrive. This is only
|
|
useful for debugging the window resizing logic.
|
|
.PP
|
|
The
|
|
.B RENDERER
|
|
variable, if set, controls the rendering backend used by the
|
|
protocol translator. When set to
|
|
.I help
|
|
it prints a list of available rendering backends instead.
|
|
.PP
|
|
The
|
|
.B RENDER_VISUAL
|
|
variable, if set to a number, contains the ID of the visual used
|
|
when the EGL rendering backend is in use.
|
|
.SH BUGS
|
|
There is a hard to catch bug where Wayland programs leaving the
|
|
fullscreen or maximized state may abruptly return to their maximized
|
|
size. Setting the
|
|
.B APPLY_STATE_WORKAROUND
|
|
environment variable may help.
|
|
.PP
|
|
Mozilla Firefox also does not work correctly. Resizing the Firefox
|
|
window leads to screen tearing, and Firefox often resizes its toplevel
|
|
windows outside their normal boundaries, causing invalid screen
|
|
contents to be displayed over other applications.
|
|
.PP
|
|
Using this protocol translator under a window manager that does not at
|
|
least support the
|
|
.B _NET_WM_SYNC_REQUEST
|
|
and
|
|
.B _NET_WM_STATE
|
|
window manager hints will result in Wayland programs running
|
|
incorrectly.
|
|
.SH "SEE ALSO"
|
|
X(1), Xorg(1)
|
|
.SH AUTHOR
|
|
Various contributors.
|