#include #include #include #include #include #include #include #include #include #include #include "render/allocator/allocator.h" #include "types/wlr_buffer.h" #include "types/wlr_output.h" static bool output_set_hardware_cursor(struct wlr_output *output, struct wlr_buffer *buffer, int hotspot_x, int hotspot_y) { if (!output->impl->set_cursor) { return false; } if (!output->impl->set_cursor(output, buffer, hotspot_x, hotspot_y)) { return false; } wlr_buffer_unlock(output->cursor_front_buffer); output->cursor_front_buffer = NULL; if (buffer != NULL) { output->cursor_front_buffer = wlr_buffer_lock(buffer); } return true; } static void output_cursor_damage_whole(struct wlr_output_cursor *cursor); void wlr_output_lock_software_cursors(struct wlr_output *output, bool lock) { if (lock) { ++output->software_cursor_locks; } else { assert(output->software_cursor_locks > 0); --output->software_cursor_locks; } wlr_log(WLR_DEBUG, "%s hardware cursors on output '%s' (locks: %d)", lock ? "Disabling" : "Enabling", output->name, output->software_cursor_locks); if (output->software_cursor_locks > 0 && output->hardware_cursor != NULL) { output_set_hardware_cursor(output, NULL, 0, 0); output_cursor_damage_whole(output->hardware_cursor); output->hardware_cursor = NULL; } // If it's possible to use hardware cursors again, don't switch immediately // since a recorder is likely to lock software cursors for the next frame // again. } /** * Returns the cursor box, scaled for its output. */ static void output_cursor_get_box(struct wlr_output_cursor *cursor, struct wlr_box *box) { box->x = cursor->x - cursor->hotspot_x; box->y = cursor->y - cursor->hotspot_y; box->width = cursor->width; box->height = cursor->height; } void wlr_output_add_software_cursors_to_render_pass(struct wlr_output *output, struct wlr_render_pass *render_pass, const pixman_region32_t *damage) { int width, height; wlr_output_transformed_resolution(output, &width, &height); pixman_region32_t render_damage; pixman_region32_init_rect(&render_damage, 0, 0, width, height); if (damage != NULL) { pixman_region32_intersect(&render_damage, &render_damage, damage); } struct wlr_output_cursor *cursor; wl_list_for_each(cursor, &output->cursors, link) { if (!cursor->enabled || !cursor->visible || output->hardware_cursor == cursor) { continue; } struct wlr_texture *texture = cursor->texture; if (texture == NULL) { continue; } struct wlr_box box; output_cursor_get_box(cursor, &box); pixman_region32_t cursor_damage; pixman_region32_init_rect(&cursor_damage, box.x, box.y, box.width, box.height); pixman_region32_intersect(&cursor_damage, &cursor_damage, &render_damage); if (!pixman_region32_not_empty(&cursor_damage)) { pixman_region32_fini(&cursor_damage); continue; } enum wl_output_transform transform = wlr_output_transform_invert(output->transform); wlr_box_transform(&box, &box, transform, width, height); wlr_region_transform(&cursor_damage, &cursor_damage, transform, width, height); wlr_render_pass_add_texture(render_pass, &(struct wlr_render_texture_options) { .texture = texture, .src_box = cursor->src_box, .dst_box = box, .clip = &cursor_damage, .transform = output->transform, }); pixman_region32_fini(&cursor_damage); } pixman_region32_fini(&render_damage); } static void output_cursor_damage_whole(struct wlr_output_cursor *cursor) { struct wlr_box box; output_cursor_get_box(cursor, &box); pixman_region32_t damage; pixman_region32_init_rect(&damage, box.x, box.y, box.width, box.height); struct wlr_output_event_damage event = { .output = cursor->output, .damage = &damage, }; wl_signal_emit_mutable(&cursor->output->events.damage, &event); pixman_region32_fini(&damage); } static void output_cursor_reset(struct wlr_output_cursor *cursor) { if (cursor->output->hardware_cursor != cursor) { output_cursor_damage_whole(cursor); } } static void output_cursor_update_visible(struct wlr_output_cursor *cursor) { struct wlr_box output_box; output_box.x = output_box.y = 0; wlr_output_transformed_resolution(cursor->output, &output_box.width, &output_box.height); struct wlr_box cursor_box; output_cursor_get_box(cursor, &cursor_box); struct wlr_box intersection; cursor->visible = wlr_box_intersection(&intersection, &output_box, &cursor_box); } static bool output_pick_cursor_format(struct wlr_output *output, struct wlr_drm_format *format) { struct wlr_allocator *allocator = output->allocator; assert(allocator != NULL); const struct wlr_drm_format_set *display_formats = NULL; if (output->impl->get_cursor_formats) { display_formats = output->impl->get_cursor_formats(output, allocator->buffer_caps); if (display_formats == NULL) { wlr_log(WLR_DEBUG, "Failed to get cursor display formats"); return false; } } return output_pick_format(output, display_formats, format, DRM_FORMAT_ARGB8888); } static struct wlr_buffer *render_cursor_buffer(struct wlr_output_cursor *cursor) { struct wlr_output *output = cursor->output; struct wlr_texture *texture = cursor->texture; if (texture == NULL) { return NULL; } struct wlr_allocator *allocator = output->allocator; struct wlr_renderer *renderer = output->renderer; assert(allocator != NULL && renderer != NULL); int width = cursor->width; int height = cursor->height; if (output->impl->get_cursor_size) { // Apply hardware limitations on buffer size output->impl->get_cursor_size(cursor->output, &width, &height); if ((int)texture->width > width || (int)texture->height > height) { wlr_log(WLR_DEBUG, "Cursor texture too large (%dx%d), " "exceeds hardware limitations (%dx%d)", texture->width, texture->height, width, height); return NULL; } } if (output->cursor_swapchain == NULL || output->cursor_swapchain->width != width || output->cursor_swapchain->height != height) { struct wlr_drm_format format = {0}; if (!output_pick_cursor_format(output, &format)) { wlr_log(WLR_DEBUG, "Failed to pick cursor format"); return NULL; } wlr_swapchain_destroy(output->cursor_swapchain); output->cursor_swapchain = wlr_swapchain_create(allocator, width, height, &format); wlr_drm_format_finish(&format); if (output->cursor_swapchain == NULL) { wlr_log(WLR_ERROR, "Failed to create cursor swapchain"); return NULL; } } struct wlr_buffer *buffer = wlr_swapchain_acquire(output->cursor_swapchain, NULL); if (buffer == NULL) { return NULL; } struct wlr_box dst_box = { .width = cursor->width, .height = cursor->height, }; wlr_box_transform(&dst_box, &dst_box, wlr_output_transform_invert(output->transform), buffer->width, buffer->height); struct wlr_render_pass *pass = wlr_renderer_begin_buffer_pass(renderer, buffer, NULL); if (pass == NULL) { wlr_buffer_unlock(buffer); return NULL; } enum wl_output_transform transform = wlr_output_transform_invert(cursor->transform); transform = wlr_output_transform_compose(transform, output->transform); wlr_render_pass_add_rect(pass, &(struct wlr_render_rect_options){ .box = { .width = buffer->width, .height = buffer->height }, .blend_mode = WLR_RENDER_BLEND_MODE_NONE, }); wlr_render_pass_add_texture(pass, &(struct wlr_render_texture_options){ .texture = texture, .src_box = cursor->src_box, .dst_box = dst_box, .transform = transform, }); if (!wlr_render_pass_submit(pass)) { wlr_buffer_unlock(buffer); return NULL; } return buffer; } static bool output_cursor_attempt_hardware(struct wlr_output_cursor *cursor) { struct wlr_output *output = cursor->output; if (!output->impl->set_cursor || output->software_cursor_locks > 0) { return false; } struct wlr_output_cursor *hwcur = output->hardware_cursor; if (hwcur != NULL && hwcur != cursor) { return false; } struct wlr_texture *texture = cursor->texture; // If the cursor was hidden or was a software cursor, the hardware // cursor position is outdated output->impl->move_cursor(cursor->output, (int)cursor->x, (int)cursor->y); struct wlr_buffer *buffer = NULL; if (texture != NULL) { buffer = render_cursor_buffer(cursor); if (buffer == NULL) { wlr_log(WLR_DEBUG, "Failed to render cursor buffer"); return false; } } struct wlr_box hotspot = { .x = cursor->hotspot_x, .y = cursor->hotspot_y, }; wlr_box_transform(&hotspot, &hotspot, wlr_output_transform_invert(output->transform), buffer ? buffer->width : 0, buffer ? buffer->height : 0); bool ok = output_set_hardware_cursor(output, buffer, hotspot.x, hotspot.y); wlr_buffer_unlock(buffer); if (ok) { output->hardware_cursor = cursor; } return ok; } bool wlr_output_cursor_set_buffer(struct wlr_output_cursor *cursor, struct wlr_buffer *buffer, int32_t hotspot_x, int32_t hotspot_y) { struct wlr_renderer *renderer = cursor->output->renderer; assert(renderer != NULL); struct wlr_texture *texture = NULL; struct wlr_fbox src_box = {0}; int dst_width = 0, dst_height = 0; if (buffer != NULL) { texture = wlr_texture_from_buffer(renderer, buffer); if (texture == NULL) { return false; } src_box = (struct wlr_fbox){ .width = texture->width, .height = texture->height, }; dst_width = texture->width / cursor->output->scale; dst_height = texture->height / cursor->output->scale; } hotspot_x /= cursor->output->scale; hotspot_y /= cursor->output->scale; return output_cursor_set_texture(cursor, texture, true, &src_box, dst_width, dst_height, WL_OUTPUT_TRANSFORM_NORMAL, hotspot_x, hotspot_y); } static void output_cursor_handle_renderer_destroy(struct wl_listener *listener, void *data) { struct wlr_output_cursor *cursor = wl_container_of(listener, cursor, renderer_destroy); output_cursor_set_texture(cursor, NULL, false, NULL, 0, 0, WL_OUTPUT_TRANSFORM_NORMAL, 0, 0); } bool output_cursor_set_texture(struct wlr_output_cursor *cursor, struct wlr_texture *texture, bool own_texture, const struct wlr_fbox *src_box, int dst_width, int dst_height, enum wl_output_transform transform, int32_t hotspot_x, int32_t hotspot_y) { struct wlr_output *output = cursor->output; output_cursor_reset(cursor); cursor->enabled = texture != NULL; if (texture != NULL) { cursor->width = (int)roundf(dst_width * output->scale); cursor->height = (int)roundf(dst_height * output->scale); cursor->src_box = *src_box; cursor->transform = transform; } else { cursor->width = 0; cursor->height = 0; } cursor->hotspot_x = (int)roundf(hotspot_x * output->scale); cursor->hotspot_y = (int)roundf(hotspot_y * output->scale); output_cursor_update_visible(cursor); if (cursor->own_texture) { wlr_texture_destroy(cursor->texture); } cursor->texture = texture; cursor->own_texture = own_texture; wl_list_remove(&cursor->renderer_destroy.link); if (texture != NULL) { cursor->renderer_destroy.notify = output_cursor_handle_renderer_destroy; wl_signal_add(&texture->renderer->events.destroy, &cursor->renderer_destroy); } else { wl_list_init(&cursor->renderer_destroy.link); } if (output_cursor_attempt_hardware(cursor)) { return true; } wlr_log(WLR_DEBUG, "Falling back to software cursor on output '%s'", cursor->output->name); output_cursor_damage_whole(cursor); return true; } bool wlr_output_cursor_move(struct wlr_output_cursor *cursor, double x, double y) { // Scale coordinates for the output x *= cursor->output->scale; y *= cursor->output->scale; if (cursor->x == x && cursor->y == y) { return true; } if (cursor->output->hardware_cursor != cursor) { output_cursor_damage_whole(cursor); } cursor->x = x; cursor->y = y; bool was_visible = cursor->visible; output_cursor_update_visible(cursor); if (!was_visible && !cursor->visible) { // Cursor is still hidden, do nothing return true; } if (cursor->output->hardware_cursor != cursor) { output_cursor_damage_whole(cursor); return true; } assert(cursor->output->impl->move_cursor); return cursor->output->impl->move_cursor(cursor->output, (int)x, (int)y); } struct wlr_output_cursor *wlr_output_cursor_create(struct wlr_output *output) { struct wlr_output_cursor *cursor = calloc(1, sizeof(*cursor)); if (cursor == NULL) { return NULL; } cursor->output = output; wl_list_insert(&output->cursors, &cursor->link); cursor->visible = true; // default position is at (0, 0) wl_list_init(&cursor->renderer_destroy.link); return cursor; } void wlr_output_cursor_destroy(struct wlr_output_cursor *cursor) { if (cursor == NULL) { return; } output_cursor_reset(cursor); if (cursor->output->hardware_cursor == cursor) { // If this cursor was the hardware cursor, disable it output_set_hardware_cursor(cursor->output, NULL, 0, 0); cursor->output->hardware_cursor = NULL; } wl_list_remove(&cursor->renderer_destroy.link); if (cursor->own_texture) { wlr_texture_destroy(cursor->texture); } wl_list_remove(&cursor->link); free(cursor); }