NAME

       wl_resource

SYNOPSIS

       #include <wayland-server.h>

   Public Member Functions
       void wl_resource_post_error_vargs (struct wl_resource *resource, uint32_t code, const char *msg, va_list
           argp)
       void wl_resource_post_error (struct wl_resource *resource, uint32_t code, const char *msg,...)
       const char * wl_resource_get_class (const struct wl_resource *resource)
       const struct wl_interface * wl_resource_get_interface (struct wl_resource *resource)
       struct wl_resource * wl_resource_create (struct wl_client *client, const struct wl_interface *interface,
           int version, uint32_t id)

   Data Fields
       struct wl_object object
       wl_resource_destroy_func_t destroy
       struct wl_list link
       struct wl_signal deprecated_destroy_signal
       struct wl_client * client
       void * data
       int version
       wl_dispatcher_func_t dispatcher
       struct wl_priv_signal destroy_signal
       struct wl_signal destroy_signal

Member Function Documentation

   struct wl_resource * wl_resource_create (struct wl_client * client, const struct wl_interface * interface,
       int version, uint32_t id)
       Create a new resource object

       Parameters
           client The client owner of the new resource.
           interface The interface of the new resource.
           version The version of the new resource.
           id The id of the new resource. If 0, an available id will be used.

       Listeners added with wl_client_add_resource_created_listener will be notified at the end of this
       function.

   const char * wl_resource_get_class (const struct wl_resource * resource)
       Retrieve the interface name (class) of a resource object.

       Parameters
           resource The resource object

   const struct wl_interface * wl_resource_get_interface (struct wl_resource * resource)
       Get the interface of a resource object

       Parameters
           resource The resource object

       Returns
           The interface of the object associated with the resource

       Since
           1.24

   void wl_resource_post_error (struct wl_resource * resource, uint32_t code, const char * msg,  ...)
       Post a protocol error

       Parameters
           resource The resource object
           code The error code
           msg The error message format string
           ... The format string arguments

   void wl_resource_post_error_vargs (struct wl_resource * resource, uint32_t code, const char * msg, va_list
       argp)
       Post a protocol error

       Parameters
           resource The resource object
           code The error code
           msg The error message format string
           argp The format string argument list

Field Documentation

   struct wl_client * wl_resource::client
   void * wl_resource::data
   struct wl_signal wl_resource::deprecated_destroy_signal
   wl_resource_destroy_func_t wl_resource::destroy
   struct wl_priv_signal wl_resource::destroy_signal
   struct wl_signal wl_resource::destroy_signal
   wl_dispatcher_func_t wl_resource::dispatcher
   struct wl_list wl_resource::link
   struct wl_object wl_resource::object
   int wl_resource::version

Author

       Generated automatically by Doxygen for Wayland from the source code.

Version 1.24.0                               Sat Sep 6 2025 15:39:15                              wl_resource(3)