mirror of
				https://gitlab.freedesktop.org/wayland/wayland.git
				synced 2025-11-03 09:01:42 -05:00 
			
		
		
		
	server: document wl_resource_post_event() arguments
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
This commit is contained in:
		
							parent
							
								
									804d5dd348
								
							
						
					
					
						commit
						e04c137e86
					
				
					 1 changed files with 17 additions and 0 deletions
				
			
		| 
						 | 
					@ -180,10 +180,27 @@ struct wl_input_device {
 | 
				
			||||||
	struct wl_listener grab_listener;
 | 
						struct wl_listener grab_listener;
 | 
				
			||||||
};
 | 
					};
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/*
 | 
				
			||||||
 | 
					 * Post an event to the client's object referred to by 'resource'.
 | 
				
			||||||
 | 
					 * 'opcode' is the event number generated from the protocol XML
 | 
				
			||||||
 | 
					 * description (the event name). The variable arguments are the event
 | 
				
			||||||
 | 
					 * parameters, in the order they appear in the protocol XML specification.
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * The variable arguments' types are:
 | 
				
			||||||
 | 
					 * - type=uint: 	uint32_t
 | 
				
			||||||
 | 
					 * - type=int:		int32_t
 | 
				
			||||||
 | 
					 * - type=string:	(const char *) to a nil-terminated string
 | 
				
			||||||
 | 
					 * - type=array:	(struct wl_array *)
 | 
				
			||||||
 | 
					 * - type=fd:		int, that is an open file descriptor
 | 
				
			||||||
 | 
					 * - type=new_id:	(struct wl_object *) or (struct wl_resource *)
 | 
				
			||||||
 | 
					 * - type=object:	(struct wl_object *) or (struct wl_resource *)
 | 
				
			||||||
 | 
					 */
 | 
				
			||||||
void wl_resource_post_event(struct wl_resource *resource,
 | 
					void wl_resource_post_event(struct wl_resource *resource,
 | 
				
			||||||
			    uint32_t opcode, ...);
 | 
								    uint32_t opcode, ...);
 | 
				
			||||||
void wl_resource_queue_event(struct wl_resource *resource,
 | 
					void wl_resource_queue_event(struct wl_resource *resource,
 | 
				
			||||||
			     uint32_t opcode, ...);
 | 
								     uint32_t opcode, ...);
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/* msg is a printf format string, variable args are its args. */
 | 
				
			||||||
void wl_resource_post_error(struct wl_resource *resource,
 | 
					void wl_resource_post_error(struct wl_resource *resource,
 | 
				
			||||||
			    uint32_t code, const char *msg, ...);
 | 
								    uint32_t code, const char *msg, ...);
 | 
				
			||||||
void wl_resource_post_no_memory(struct wl_resource *resource);
 | 
					void wl_resource_post_no_memory(struct wl_resource *resource);
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue