wlroots/include/wlr/interfaces/wlr_output.h

159 lines
4.8 KiB
C
Raw Normal View History

/*
* This an unstable interface of wlroots. No guarantees are made regarding the
* future consistency of this API.
*/
#ifndef WLR_USE_UNSTABLE
#error "Add -DWLR_USE_UNSTABLE to enable unstable wlroots features"
#endif
#ifndef WLR_INTERFACES_WLR_OUTPUT_H
#define WLR_INTERFACES_WLR_OUTPUT_H
#include <stdbool.h>
2018-02-12 20:29:23 +00:00
#include <wlr/backend.h>
#include <wlr/types/wlr_box.h>
#include <wlr/types/wlr_output.h>
2020-06-19 15:44:32 +00:00
/**
* A backend implementation of wlr_output.
*
* The commit function is mandatory. Other functions are optional.
2020-06-19 15:44:32 +00:00
*/
struct wlr_output_impl {
2020-06-19 15:44:32 +00:00
/**
* Set the output cursor plane image.
*
* If buffer is NULL, the cursor should be hidden.
2020-06-19 15:44:32 +00:00
*
* The hotspot indicates the offset that needs to be applied to the
* top-left corner of the image to match the cursor position. In other
* words, the image should be displayed at (x - hotspot_x, y - hotspot_y).
2021-03-09 21:29:32 +00:00
* The hotspot is given in the texture's coordinate space.
2020-06-19 15:44:32 +00:00
*/
bool (*set_cursor)(struct wlr_output *output, struct wlr_buffer *buffer,
int hotspot_x, int hotspot_y);
2020-06-19 15:44:32 +00:00
/**
* Set the output cursor plane position.
*
* The position is relative to the cursor hotspot, see set_cursor.
*/
bool (*move_cursor)(struct wlr_output *output, int x, int y);
2020-06-19 15:44:32 +00:00
/**
* Cleanup backend-specific resources tied to the output.
*/
void (*destroy)(struct wlr_output *output);
2020-06-19 15:44:32 +00:00
/**
* Make the output's back-buffer current for the renderer.
*
* buffer_age must be set to the buffer age in number of frames, or -1 if
* unknown.
*/
bool (*attach_render)(struct wlr_output *output, int *buffer_age);
2020-06-19 15:44:32 +00:00
/**
* Unset the current renderer's buffer.
*
* This is the opposite of attach_render.
*/
void (*rollback_render)(struct wlr_output *output);
/**
* Check that the pending output state is a valid configuration.
*
* If this function returns true, commit can only fail due to a runtime
* error.
*/
2020-04-02 10:41:19 +00:00
bool (*test)(struct wlr_output *output);
2020-06-19 15:44:32 +00:00
/**
* Commit the pending output state.
*
* If a buffer has been attached, a frame event is scheduled.
*/
bool (*commit)(struct wlr_output *output);
2020-06-19 15:44:32 +00:00
/**
* Get the maximum number of gamma LUT elements for each channel.
*
* Zero can be returned if the output doesn't support gamma LUTs.
*/
size_t (*get_gamma_size)(struct wlr_output *output);
2020-06-19 15:44:32 +00:00
/**
* Export the output's current back-buffer as a DMA-BUF.
*/
bool (*export_dmabuf)(struct wlr_output *output,
struct wlr_dmabuf_attributes *attribs);
/**
* Get the list of formats suitable for the cursor, assuming a buffer with
* the specified capabilities.
*
* If unimplemented, the cursor buffer has no format constraint. If NULL is
* returned, no format is suitable.
*/
const struct wlr_drm_format_set *(*get_cursor_formats)(
struct wlr_output *output, uint32_t buffer_caps);
/**
* Get the size suitable for the cursor buffer. Attempts to use a different
* size for the cursor may fail.
*/
void (*get_cursor_size)(struct wlr_output *output, int *width, int *height);
/**
* Get the list of DMA-BUF formats suitable for the primary buffer,
* assuming a buffer with the specified capabilities.
*
* If unimplemented, the primary buffer has no format constraint. If NULL
* is returned, no format is suitable.
*/
const struct wlr_drm_format_set *(*get_primary_formats)(
struct wlr_output *output, uint32_t buffer_caps);
};
2020-06-19 15:44:32 +00:00
/**
* Initialize a new output.
*/
void wlr_output_init(struct wlr_output *output, struct wlr_backend *backend,
2018-01-04 11:46:15 +00:00
const struct wlr_output_impl *impl, struct wl_display *display);
2020-06-19 15:44:32 +00:00
/**
* Update the current output mode.
*
* The backend must call this function when the mode is updated to notify
* compositors about the change.
*/
void wlr_output_update_mode(struct wlr_output *output,
struct wlr_output_mode *mode);
2020-06-19 15:44:32 +00:00
/**
* Update the current output custom mode.
*
* The backend must call this function when the mode is updated to notify
* compositors about the change.
*/
void wlr_output_update_custom_mode(struct wlr_output *output, int32_t width,
int32_t height, int32_t refresh);
2020-06-19 15:44:32 +00:00
/**
* Update the current output status.
*
* The backend must call this function when the status is updated to notify
* compositors about the change.
*/
2018-01-04 11:46:15 +00:00
void wlr_output_update_enabled(struct wlr_output *output, bool enabled);
2020-06-19 15:44:32 +00:00
/**
* Notify compositors that they need to submit a new frame in order to apply
* output changes.
*/
void wlr_output_update_needs_frame(struct wlr_output *output);
2020-06-19 15:44:32 +00:00
/**
* Notify compositors that the output needs to be fully repainted.
*/
void wlr_output_damage_whole(struct wlr_output *output);
2020-06-19 15:44:32 +00:00
/**
* Send a frame event.
*
* See wlr_output.events.frame.
*/
2018-01-26 21:39:23 +00:00
void wlr_output_send_frame(struct wlr_output *output);
2020-06-19 15:44:32 +00:00
/**
* Send a present event.
*
* See wlr_output.events.present.
*/
void wlr_output_send_present(struct wlr_output *output,
struct wlr_output_event_present *event);
#endif