diff options
author | Myoungwoon Roy, Kim <myoungwoon.kim@samsung.com> | 2017-02-27 19:35:52 +0900 |
---|---|---|
committer | Jean-Philippe Andre <jp.andre@samsung.com> | 2017-02-27 19:37:43 +0900 |
commit | 8c19d9251d2d243922057363b738780d770b4de5 (patch) | |
tree | 70467aa795a5b07c22d386cb0e4010cb22c0cfa8 /src/lib/ecore_drm/Ecore_Drm.h | |
parent | 726994d175fb758b0b904418dbce13efd7f0cef6 (diff) |
docs: Fix typos and some wrong expressions
Covers: Ecore_Drm, Ecore_Evas, Ecore_File, Ecore_IMF, and
Ecore_IMF_Evas API reference doxygen.
Summary: I had fixed some typos and wrong expressions, such
as capital letters, singular Etc. in Ecore_Drm, Ecore_Evas,
Ecore_File, Ecore_IMF, and Ecore_IMF_Evas API reference doxygen.
Test Plan: Doxygen Revision
Reviewers: stefan, cedric, raster, jpeg, Jaehyun_Cho
Subscribers: conr2d
Differential Revision: https://phab.enlightenment.org/D4680
Diffstat (limited to '')
-rw-r--r-- | src/lib/ecore_drm/Ecore_Drm.h | 327 |
1 files changed, 161 insertions, 166 deletions
diff --git a/src/lib/ecore_drm/Ecore_Drm.h b/src/lib/ecore_drm/Ecore_Drm.h index 62717e5ba6..c70e04eabb 100644 --- a/src/lib/ecore_drm/Ecore_Drm.h +++ b/src/lib/ecore_drm/Ecore_Drm.h | |||
@@ -218,12 +218,11 @@ EAPI extern int ECORE_DRM_EVENT_SEAT_ADD; /**< @since 1.14 */ | |||
218 | 218 | ||
219 | /** | 219 | /** |
220 | * @file | 220 | * @file |
221 | * @brief Ecore functions for dealing with drm, virtual terminals | ||
222 | * | ||
223 | * @defgroup Ecore_Drm_Group Ecore_Drm - Drm Integration | 221 | * @defgroup Ecore_Drm_Group Ecore_Drm - Drm Integration |
224 | * @ingroup Ecore | 222 | * @ingroup Ecore |
223 | * @brief Ecore functions for dealing with drm, virtual terminals. | ||
225 | * | 224 | * |
226 | * Ecore_Drm provides a wrapper and functions for using libdrm | 225 | * Ecore_Drm provides a wrapper and functions for using libdrm. |
227 | * | 226 | * |
228 | * @li @ref Ecore_Drm_Init_Group | 227 | * @li @ref Ecore_Drm_Init_Group |
229 | * @li @ref Ecore_Drm_Device_Group | 228 | * @li @ref Ecore_Drm_Device_Group |
@@ -239,7 +238,8 @@ EAPI int ecore_drm_init(void); | |||
239 | EAPI int ecore_drm_shutdown(void); | 238 | EAPI int ecore_drm_shutdown(void); |
240 | 239 | ||
241 | /** | 240 | /** |
242 | * Find a drm device in the system. | 241 | * @ingroup Ecore_Drm_Device_Group |
242 | * @brief Finds a drm device in the system. | ||
243 | * | 243 | * |
244 | * @param name The name of the device to find. If NULL, this function will | 244 | * @param name The name of the device to find. If NULL, this function will |
245 | * search for the default drm device. | 245 | * search for the default drm device. |
@@ -248,188 +248,183 @@ EAPI int ecore_drm_shutdown(void); | |||
248 | * | 248 | * |
249 | * @return An opaque Ecore_Drm_Device structure representing the card. | 249 | * @return An opaque Ecore_Drm_Device structure representing the card. |
250 | * | 250 | * |
251 | * @ingroup Ecore_Drm_Device_Group | ||
252 | */ | 251 | */ |
253 | EAPI Ecore_Drm_Device *ecore_drm_device_find(const char *name, const char *seat); | 252 | EAPI Ecore_Drm_Device *ecore_drm_device_find(const char *name, const char *seat); |
254 | 253 | ||
255 | /** | 254 | /** |
256 | * Free an Ecore_Drm_Device | 255 | * @ingroup Ecore_Drm_Device_Group |
256 | * @brief Frees an Ecore_Drm_Device. | ||
257 | * | 257 | * |
258 | * This function will cleanup and free any previously allocated Ecore_Drm_Device. | 258 | * This function will cleanup and free any previously allocated Ecore_Drm_Device. |
259 | * | 259 | * |
260 | * @param dev The Ecore_Drm_Device to free | 260 | * @param dev The Ecore_Drm_Device to free |
261 | * | 261 | * |
262 | * @ingroup Ecore_Drm_Device_Group | ||
263 | */ | 262 | */ |
264 | EAPI void ecore_drm_device_free(Ecore_Drm_Device *dev); | 263 | EAPI void ecore_drm_device_free(Ecore_Drm_Device *dev); |
265 | 264 | ||
266 | /** | 265 | /** |
267 | * Open an Ecore_Drm_Device | 266 | * @ingroup Ecore_Drm_Device_Group |
267 | * @brief Opens an Ecore_Drm_Device. | ||
268 | * | 268 | * |
269 | * This function will open an existing Ecore_Drm_Device for use. | 269 | * This function will open an existing Ecore_Drm_Device for use. |
270 | * | 270 | * |
271 | * @param dev The Ecore_Drm_Device to try and open | 271 | * @param dev The Ecore_Drm_Device to try and open |
272 | * | 272 | * |
273 | * @return EINA_TRUE on success, EINA_FALSE on failure | 273 | * @return @c EINA_TRUE on success, @c EINA_FALSE on failure |
274 | * | 274 | * |
275 | * @ingroup Ecore_Drm_Device_Group | ||
276 | */ | 275 | */ |
277 | EAPI Eina_Bool ecore_drm_device_open(Ecore_Drm_Device *dev); | 276 | EAPI Eina_Bool ecore_drm_device_open(Ecore_Drm_Device *dev); |
278 | 277 | ||
279 | /** | 278 | /** |
280 | * Close an Ecore_Drm_Device | 279 | * @ingroup Ecore_Drm_Device_Group |
280 | * @brief Closes an Ecore_Drm_Device. | ||
281 | * | 281 | * |
282 | * This function will close a previously opened Ecore_Drm_Device | 282 | * This function will close a previously opened Ecore_Drm_Device |
283 | * | 283 | * |
284 | * @param dev The Ecore_Drm_Device to free | 284 | * @param dev The Ecore_Drm_Device to free |
285 | * | 285 | * |
286 | * @return EINA_TRUE on success, EINA_FALSE on failure | 286 | * @return @c EINA_TRUE on success, @c EINA_FALSE on failure |
287 | * | 287 | * |
288 | * @ingroup Ecore_Drm_Device_Group | ||
289 | */ | 288 | */ |
290 | EAPI Eina_Bool ecore_drm_device_close(Ecore_Drm_Device *dev); | 289 | EAPI Eina_Bool ecore_drm_device_close(Ecore_Drm_Device *dev); |
291 | 290 | ||
292 | /** | 291 | /** |
293 | * Get if a given Ecore_Drm_Device is master | 292 | * @ingroup Ecore_Drm_Device_Group |
293 | * @brief Gets if a given Ecore_Drm_Device is master. | ||
294 | * | 294 | * |
295 | * This function will check if the given drm device is set to master | 295 | * This function will check if the given drm device is set to master |
296 | * | 296 | * |
297 | * @param dev The Ecore_Drm_Device to check | 297 | * @param dev The Ecore_Drm_Device to check |
298 | * | 298 | * |
299 | * @return EINA_TRUE if device is master, EINA_FALSE otherwise | 299 | * @return @c EINA_TRUE if device is master, @c EINA_FALSE otherwise |
300 | * | 300 | * |
301 | * @ingroup Ecore_Drm_Device_Group | ||
302 | */ | 301 | */ |
303 | EAPI Eina_Bool ecore_drm_device_master_get(Ecore_Drm_Device *dev); | 302 | EAPI Eina_Bool ecore_drm_device_master_get(Ecore_Drm_Device *dev); |
304 | 303 | ||
305 | /** | 304 | /** |
306 | * Set a given Ecore_Drm_Device to master | 305 | * @ingroup Ecore_Drm_Device_Group |
306 | * @brief Sets a given Ecore_Drm_Device to master. | ||
307 | * | 307 | * |
308 | * This function will attempt to set a given drm device to be master | 308 | * This function will attempt to set a given drm device to be master |
309 | * | 309 | * |
310 | * @param dev The Ecore_Drm_Device to set | 310 | * @param dev The Ecore_Drm_Device to set |
311 | * | 311 | * |
312 | * @return EINA_TRUE on success, EINA_FALSE on failure | 312 | * @return @c EINA_TRUE on success, @c EINA_FALSE on failure |
313 | * | 313 | * |
314 | * @ingroup Ecore_Drm_Device_Group | ||
315 | */ | 314 | */ |
316 | EAPI Eina_Bool ecore_drm_device_master_set(Ecore_Drm_Device *dev); | 315 | EAPI Eina_Bool ecore_drm_device_master_set(Ecore_Drm_Device *dev); |
317 | 316 | ||
318 | /** | 317 | /** |
319 | * Tell a given Ecore_Drm_Device to stop being master | 318 | * @ingroup Ecore_Drm_Device_Group |
319 | * @brief Tells a given Ecore_Drm_Device to stop being master. | ||
320 | * | 320 | * |
321 | * This function will attempt to ask a drm device to stop being master | 321 | * This function will attempt to ask a drm device to stop being master |
322 | * | 322 | * |
323 | * @param dev The Ecore_Drm_Device to set | 323 | * @param dev The Ecore_Drm_Device to set |
324 | * | 324 | * |
325 | * @return EINA_TRUE on success, EINA_FALSE on failure | 325 | * @return @c EINA_TRUE on success, @c EINA_FALSE on failure |
326 | * | 326 | * |
327 | * @ingroup Ecore_Drm_Device_Group | ||
328 | */ | 327 | */ |
329 | EAPI Eina_Bool ecore_drm_device_master_drop(Ecore_Drm_Device *dev); | 328 | EAPI Eina_Bool ecore_drm_device_master_drop(Ecore_Drm_Device *dev); |
330 | 329 | ||
331 | /** | 330 | /** |
332 | * Get the file descriptor of Ecore_Drm_Device | 331 | * @ingroup Ecore_Drm_Device_Group |
332 | * @brief Gets the file descriptor of Ecore_Drm_Devices. | ||
333 | * | 333 | * |
334 | * This function will get the file descriptor of drm device | 334 | * This function will get the file descriptor of drm device |
335 | * | 335 | * |
336 | * @param dev The Ecore_Drm_Device to get | 336 | * @param dev The Ecore_Drm_Device to get |
337 | * | 337 | * |
338 | * @return fd value on success, -1 on failure | 338 | * @return fd Value on success, @c -1 on failure |
339 | * | ||
340 | * @ingroup Ecore_Drm_Device_Group | ||
341 | * | 339 | * |
342 | */ | 340 | */ |
343 | EAPI int ecore_drm_device_fd_get(Ecore_Drm_Device *dev); | 341 | EAPI int ecore_drm_device_fd_get(Ecore_Drm_Device *dev); |
344 | 342 | ||
345 | /** | 343 | /** |
346 | * Set the window of Ecore_Drm_Device | 344 | * @ingroup Ecore_Drm_Device_Group |
345 | * @brief Sets the window of Ecore_Drm_Devices. | ||
347 | * | 346 | * |
348 | * This function will set the window for given drm device | 347 | * This function will set the window for given drm devices. |
349 | * | 348 | * |
350 | * @param dev The Ecore_Drm_Device for which window is set | 349 | * @param dev The Ecore_Drm_Device for which window is set |
351 | * @param window The window to set | 350 | * @param window The window to set |
352 | * | 351 | * |
353 | * @ingroup Ecore_Drm_Device_Group | ||
354 | * | ||
355 | * @since 1.10 | 352 | * @since 1.10 |
356 | */ | 353 | */ |
357 | EAPI void ecore_drm_device_window_set(Ecore_Drm_Device *dev, unsigned int window); | 354 | EAPI void ecore_drm_device_window_set(Ecore_Drm_Device *dev, unsigned int window); |
358 | 355 | ||
359 | /** | 356 | /** |
360 | * Get the name of the Ecore_Drm_Device | 357 | * @ingroup Ecore_Drm_Device_Group |
358 | * @brief Gets the name of the Ecore_Drm_Device. | ||
361 | * | 359 | * |
362 | * This function will return the name of Ecore_Drm_Device | 360 | * This function will return the name of Ecore_Drm_Device. |
363 | * | 361 | * |
364 | * @param dev The Ecore_Drm_Device to get name | 362 | * @param dev The Ecore_Drm_Device to get name |
365 | * | 363 | * |
366 | * @return device name on success, NULL on failure | 364 | * @return device name on success, NULL on failure |
367 | * | 365 | * |
368 | * @ingroup Ecore_Drm_Device_Group | ||
369 | * | 366 | * |
370 | * @since 1.10 | 367 | * @since 1.10 |
371 | */ | 368 | */ |
372 | EAPI const char *ecore_drm_device_name_get(Ecore_Drm_Device *dev); | 369 | EAPI const char *ecore_drm_device_name_get(Ecore_Drm_Device *dev); |
373 | 370 | ||
374 | /** | 371 | /** |
375 | * Setup an Ecore_Drm_Device for software rendering | 372 | * @ingroup Ecore_Drm_Device_Group |
373 | * @brief Sets up an Ecore_Drm_Device for software rendering. | ||
376 | * | 374 | * |
377 | * This function will setup an Ecore_Drm_Device for software rendering | 375 | * This function will setup an Ecore_Drm_Device for software rendering |
378 | * which includes creating dumb buffers to render into | 376 | * which includes creating dumb buffers to render into. |
379 | * | 377 | * |
380 | * @param dev The Ecore_Drm_Device to setup for software rendering | 378 | * @param dev The Ecore_Drm_Device to setup for software rendering |
381 | * | 379 | * |
382 | * @return EINA_TRUE on success, EINA_FALSE on failure | 380 | * @return EINA_TRUE on success, EINA_FALSE on failure |
383 | * | 381 | * |
384 | * @ingroup Ecore_Drm_Device_Group | ||
385 | * @since 1.14 | 382 | * @since 1.14 |
386 | */ | 383 | */ |
387 | EAPI Eina_Bool ecore_drm_device_software_setup(Ecore_Drm_Device *dev); | 384 | EAPI Eina_Bool ecore_drm_device_software_setup(Ecore_Drm_Device *dev); |
388 | 385 | ||
389 | /** | 386 | /** |
390 | * Set a left handed mode at the given Ecore_Drm_Device | 387 | * @ingroup Ecore_Drm_Device_Group |
391 | * | 388 | * @brief Sets a left handed mode at the given Ecore_Drm_Device. |
392 | * This function will loop all the registered inputs in Ecore_Drm_Device and | 389 | * This function will loop all the registered inputs in Ecore_Drm_Device and |
393 | * set/unset left handed mode. | 390 | * set/unset left handed mode. |
394 | * | 391 | * |
395 | * @param dev The Ecore_Drm_Device to set left handed mode | 392 | * @param dev The Ecore_Drm_Device to set left handed mode |
396 | * @param left_handed The flag of enable/disable left handed mode | 393 | * @param left_handed The flag of enable/disable left handed mode |
397 | * | 394 | * |
398 | * @return EINA_TRUE on success, EINA_FALSE on failure | 395 | * @return @c EINA_TRUE on success, @c EINA_FALSE on failure |
399 | * | 396 | * |
400 | * @ingroup Ecore_Drm_Device_Group | ||
401 | * @since 1.17 | 397 | * @since 1.17 |
402 | */ | 398 | */ |
403 | EAPI Eina_Bool ecore_drm_device_pointer_left_handed_set(Ecore_Drm_Device *dev, Eina_Bool left_handed); | 399 | EAPI Eina_Bool ecore_drm_device_pointer_left_handed_set(Ecore_Drm_Device *dev, Eina_Bool left_handed); |
404 | 400 | ||
405 | /** | 401 | /** |
406 | * Setup a cached context to use same context for each devices | 402 | * @ingroup Ecore_Drm_Device_Group |
407 | * | 403 | * @brief Sets up a cached context to use same context for each devices. |
408 | * This function will setup a cached context to use same context for each devices | 404 | * This function will setup a cached context to use same context for each devices. |
409 | * This function will be called before initialize Ecore_Drm. | 405 | * This function will be called before initialize Ecore_Drm. |
410 | * | 406 | * |
411 | * @param ctx struct xkb_context used in libxkbcommon | 407 | * @param ctx struct xkb_context used in libxkbcommon |
412 | * | 408 | * |
413 | * @ingroup Ecore_Drm_Device_Group | ||
414 | * @since 1.17 | 409 | * @since 1.17 |
415 | */ | 410 | */ |
416 | EAPI void ecore_drm_device_keyboard_cached_context_set(struct xkb_context *ctx); | 411 | EAPI void ecore_drm_device_keyboard_cached_context_set(struct xkb_context *ctx); |
417 | 412 | ||
418 | /** | 413 | /** |
419 | * Setup a cached keymap to use same keymap for each devices | 414 | * @ingroup Ecore_Drm_Device_Group |
420 | * | 415 | * @brief Sets up a cached keymap to use same keymap for each devices |
421 | * This function will setup a cached keymap to use same keymap for each devices | 416 | * This function will setup a cached keymap to use same keymap for each devices. |
422 | * This function will be called before initialize Ecore_Drm. | 417 | * This function will be called before initialize Ecore_Drm. |
423 | * | 418 | * |
424 | * @param map struct xkb_keymap used in libxkbcommon | 419 | * @param map struct xkb_keymap used in libxkbcommon |
425 | * | 420 | * |
426 | * @ingroup Ecore_Drm_Device_Group | ||
427 | * @since 1.17 | 421 | * @since 1.17 |
428 | */ | 422 | */ |
429 | EAPI void ecore_drm_device_keyboard_cached_keymap_set(struct xkb_keymap *map); | 423 | EAPI void ecore_drm_device_keyboard_cached_keymap_set(struct xkb_keymap *map); |
430 | 424 | ||
431 | /** | 425 | /** |
432 | * Find an Ecore_Drm_Output at the given coordinates | 426 | * @ingroup Ecore_Drm_Device_Group |
427 | * @brief Finds an Ecore_Drm_Output at the given coordinates. | ||
433 | * | 428 | * |
434 | * This function will loop all the existing outputs in Ecore_Drm_Device and | 429 | * This function will loop all the existing outputs in Ecore_Drm_Device and |
435 | * return an output if one exists that encapsulates the given coordinates. | 430 | * return an output if one exists that encapsulates the given coordinates. |
@@ -438,131 +433,130 @@ EAPI void ecore_drm_device_keyboard_cached_keymap_set(struct xkb_keymap *map); | |||
438 | * @param x The x coordinate | 433 | * @param x The x coordinate |
439 | * @param y The y coordinate | 434 | * @param y The y coordinate |
440 | * | 435 | * |
441 | * @return An Ecore_Drm_Output if one exists at these coordinates or NULL | 436 | * @return An Ecore_Drm_Output if one exists at these coordinates, or NULL |
442 | * | 437 | * |
443 | * @ingroup Ecore_Drm_Device_Group | ||
444 | * @since 1.14 | 438 | * @since 1.14 |
445 | */ | 439 | */ |
446 | EAPI Ecore_Drm_Output *ecore_drm_device_output_find(Ecore_Drm_Device *dev, int x, int y); | 440 | EAPI Ecore_Drm_Output *ecore_drm_device_output_find(Ecore_Drm_Device *dev, int x, int y); |
447 | 441 | ||
448 | /** | 442 | /** |
449 | * Open a tty for use | 443 | * @ingroup Ecore_Drm_Tty_Group |
444 | * @brief Opens a tty for use. | ||
450 | * | 445 | * |
451 | * @param dev The Ecore_Drm_Device that this tty will belong to. | 446 | * @param dev The Ecore_Drm_Device that this tty will belong to. |
452 | * @param name The name of the tty to try and open. | 447 | * @param name The name of the tty to try and open. |
453 | * If NULL, /dev/tty0 will be used. | 448 | * If NULL, /dev/tty0 will be used. |
454 | * | 449 | * |
455 | * @return EINA_TRUE on success, EINA_FALSE on failure | 450 | * @return @c EINA_TRUE on success, @c EINA_FALSE on failure |
456 | * | 451 | * |
457 | * @ingroup Ecore_Drm_Tty_Group | ||
458 | */ | 452 | */ |
459 | EAPI Eina_Bool ecore_drm_tty_open(Ecore_Drm_Device *dev, const char *name); | 453 | EAPI Eina_Bool ecore_drm_tty_open(Ecore_Drm_Device *dev, const char *name); |
460 | 454 | ||
461 | /** | 455 | /** |
462 | * Close an already opened tty | 456 | * @ingroup Ecore_Drm_Tty_Group |
457 | * @brief Closes an already opened tty. | ||
463 | * | 458 | * |
464 | * @param dev The Ecore_Drm_Device which owns this tty. | 459 | * @param dev The Ecore_Drm_Device which owns this tty. |
465 | * | 460 | * |
466 | * @return EINA_TRUE on success, EINA_FALSE on failure | 461 | * @return @c EINA_TRUE on success, @c EINA_FALSE on failure |
467 | * | 462 | * |
468 | * @ingroup Ecore_Drm_Tty_Group | ||
469 | */ | 463 | */ |
470 | EAPI Eina_Bool ecore_drm_tty_close(Ecore_Drm_Device *dev); | 464 | EAPI Eina_Bool ecore_drm_tty_close(Ecore_Drm_Device *dev); |
471 | 465 | ||
472 | /** | 466 | /** |
473 | * Release a virtual terminal | 467 | * @ingroup Ecore_Drm_Tty_Group |
468 | * @brief Releases a virtual terminal. | ||
474 | * | 469 | * |
475 | * @param dev The Ecore_Drm_Device which owns this tty. | 470 | * @param dev The Ecore_Drm_Device which owns this tty. |
476 | * | 471 | * |
477 | * @return EINA_TRUE on success, EINA_FALSE on failure | 472 | * @return @c EINA_TRUE on success, @c EINA_FALSE on failure |
478 | * | 473 | * |
479 | * @ingroup Ecore_Drm_Tty_Group | ||
480 | */ | 474 | */ |
481 | EAPI Eina_Bool ecore_drm_tty_release(Ecore_Drm_Device *dev); | 475 | EAPI Eina_Bool ecore_drm_tty_release(Ecore_Drm_Device *dev); |
482 | 476 | ||
483 | /** | 477 | /** |
484 | * Acquire a virtual terminal | 478 | * @ingroup Ecore_Drm_Tty_Group |
479 | * @brief Acquires a virtual terminal. | ||
485 | * | 480 | * |
486 | * @param dev The Ecore_Drm_Device which owns this tty. | 481 | * @param dev The Ecore_Drm_Device which owns this tty. |
487 | * | 482 | * |
488 | * @return EINA_TRUE on success, EINA_FALSE on failure | 483 | * @return @c EINA_TRUE on success, @c EINA_FALSE on failure |
489 | * | 484 | * |
490 | * @ingroup Ecore_Drm_Tty_Group | ||
491 | */ | 485 | */ |
492 | EAPI Eina_Bool ecore_drm_tty_acquire(Ecore_Drm_Device *dev); | 486 | EAPI Eina_Bool ecore_drm_tty_acquire(Ecore_Drm_Device *dev); |
493 | 487 | ||
494 | /** | 488 | /** |
495 | * Get the opened virtual terminal file descriptor | 489 | * @ingroup Ecore_Drm_Tty_Group |
496 | * | 490 | * @brief Gets the opened virtual terminal file descriptor. |
491 | * | ||
497 | * @param dev The Ecore_Drm_Device which owns this tty. | 492 | * @param dev The Ecore_Drm_Device which owns this tty. |
498 | * | 493 | * |
499 | * @return The tty fd opened from previous call to ecore_drm_tty_open | 494 | * @return The tty fd opened from previous call to ecore_drm_tty_open |
500 | * | 495 | * |
501 | * @ingroup Ecore_Drm_Tty_Group | ||
502 | * | 496 | * |
503 | * @since 1.10 | 497 | * @since 1.10 |
504 | */ | 498 | */ |
505 | EAPI int ecore_drm_tty_get(Ecore_Drm_Device *dev); | 499 | EAPI int ecore_drm_tty_get(Ecore_Drm_Device *dev); |
506 | 500 | ||
507 | /** | 501 | /** |
508 | * Create outputs for a drm device | 502 | * @ingroup Ecore_Drm_Output_Group |
503 | * @brief Creates outputs for a drm device. | ||
509 | * | 504 | * |
510 | * This function will create outputs for Ecore_Drm_Device | 505 | * This function will create outputs for Ecore_Drm_Device. |
511 | * | 506 | * |
512 | * @param dev The Ecore_Drm_Device device for which outputs | 507 | * @param dev The Ecore_Drm_Device device for which outputs |
513 | * needs to be created | 508 | * needs to be created |
514 | * | 509 | * |
515 | * @return EINA_TRUE on success, EINA_FALSE on failure. | 510 | * @return EINA_TRUE on success, EINA_FALSE on failure. |
516 | * | 511 | * |
517 | * @ingroup Ecore_Drm_Output_Group | ||
518 | */ | 512 | */ |
519 | EAPI Eina_Bool ecore_drm_outputs_create(Ecore_Drm_Device *dev); | 513 | EAPI Eina_Bool ecore_drm_outputs_create(Ecore_Drm_Device *dev); |
520 | 514 | ||
521 | /** | 515 | /** |
522 | * Free an Ecore_Drm_Output | 516 | * @ingroup Ecore_Drm_Output_Group |
517 | * @brief Frees an Ecore_Drm_Output. | ||
523 | * | 518 | * |
524 | * This function will cleanup and free any previously allocated Ecore_Drm_Output | 519 | * This function will cleanup and free any previously allocated Ecore_Drm_Output. |
525 | * | 520 | * |
526 | * @param output The Ecore_Drm_Output to free | 521 | * @param output The Ecore_Drm_Output to free |
527 | * | 522 | * |
528 | * @ingroup Ecore_Drm_Output_Group | ||
529 | */ | 523 | */ |
530 | EAPI void ecore_drm_output_free(Ecore_Drm_Output *output); | 524 | EAPI void ecore_drm_output_free(Ecore_Drm_Output *output); |
531 | 525 | ||
532 | /** | 526 | /** |
533 | * Set the cursor size for Ecore_Drm_Output | 527 | * @ingroup Ecore_Drm_Output_Group |
528 | * @brief Sets the cursor size for Ecore_Drm_Output. | ||
534 | * | 529 | * |
535 | * This function will set the cursor size of Ecore_Drm_Output | 530 | * This function will set the cursor size of Ecore_Drm_Output. |
536 | * | 531 | * |
537 | * @param output The Ecore_Drm_Output to set | 532 | * @param output The Ecore_Drm_Output to set |
538 | * @param handle The Drm handle | 533 | * @param handle The Drm handle |
539 | * @param w The width of cursor | 534 | * @param w The width of cursor |
540 | * @param h The height of cursor | 535 | * @param h The height of cursor |
541 | * | 536 | * |
542 | * @ingroup Ecore_Drm_Output_Group | ||
543 | */ | 537 | */ |
544 | EAPI void ecore_drm_output_cursor_size_set(Ecore_Drm_Output *output, int handle, int w, int h); | 538 | EAPI void ecore_drm_output_cursor_size_set(Ecore_Drm_Output *output, int handle, int w, int h); |
545 | 539 | ||
546 | /** | 540 | /** |
547 | * Enable a Ecore_Drm_Output | 541 | * @ingroup Ecore_Drm_Output_Group |
542 | * @brief Enables a Ecore_Drm_Output. | ||
548 | * | 543 | * |
549 | * This function will enable an Ecore_Drm_Output | 544 | * This function will enable an Ecore_Drm_Output |
550 | * | 545 | * |
551 | * @param output The Ecore_Drm_Output to enable | 546 | * @param output The Ecore_Drm_Output to enable |
552 | * | 547 | * |
553 | * @ingroup Ecore_Drm_Output_Group | ||
554 | * @since 1.14 | 548 | * @since 1.14 |
555 | */ | 549 | */ |
556 | EAPI Eina_Bool ecore_drm_output_enable(Ecore_Drm_Output *output); | 550 | EAPI Eina_Bool ecore_drm_output_enable(Ecore_Drm_Output *output); |
557 | 551 | ||
558 | /** | 552 | /** |
559 | * Disable a Ecore_Drm_Output | 553 | * @ingroup Ecore_Drm_Output_Group |
554 | * @brief Disables a Ecore_Drm_Output. | ||
560 | * | 555 | * |
561 | * This function will disable an Ecore_Drm_Output | 556 | * This function will disable an Ecore_Drm_Output |
562 | * | 557 | * |
563 | * @param output The Ecore_Drm_Output to disable | 558 | * @param output The Ecore_Drm_Output to disable |
564 | * | 559 | * |
565 | * @ingroup Ecore_Drm_Output_Group | ||
566 | * @since 1.14 | 560 | * @since 1.14 |
567 | */ | 561 | */ |
568 | EAPI void ecore_drm_output_disable(Ecore_Drm_Output *output); | 562 | EAPI void ecore_drm_output_disable(Ecore_Drm_Output *output); |
@@ -574,16 +568,16 @@ EAPI void ecore_drm_output_fb_release(Ecore_Drm_Output *output, Ecore_Drm_Fb *fb | |||
574 | EAPI void ecore_drm_output_repaint(Ecore_Drm_Output *output); | 568 | EAPI void ecore_drm_output_repaint(Ecore_Drm_Output *output); |
575 | 569 | ||
576 | /** | 570 | /** |
577 | * Get the output size of Ecore_Drm_Device | 571 | * @ingroup Ecore_Drm_Output_Group |
572 | * @brief Gets the output size of Ecore_Drm_Device. | ||
578 | * | 573 | * |
579 | * This function will give the output size of Ecore_Drm_Device | 574 | * This function will give the output size of Ecore_Drm_Device. |
580 | * | 575 | * |
581 | * @param dev The Ecore_Drm_Device to get output size | 576 | * @param dev The Ecore_Drm_Device to get output size |
582 | * @param output The output id whose information needs to be retrived | 577 | * @param output The output id whose information needs to be retrieved |
583 | * @param *w The parameter in which output width is stored | 578 | * @param *w The parameter in which output width is stored |
584 | * @param *h The parameter in which output height is stored | 579 | * @param *h The parameter in which output height is stored |
585 | * | 580 | * |
586 | * @ingroup Ecore_Drm_Output_Group | ||
587 | */ | 581 | */ |
588 | EAPI void ecore_drm_output_size_get(Ecore_Drm_Device *dev, int output, int *w, int *h); | 582 | EAPI void ecore_drm_output_size_get(Ecore_Drm_Device *dev, int output, int *w, int *h); |
589 | 583 | ||
@@ -594,43 +588,43 @@ EAPI void ecore_drm_output_size_get(Ecore_Drm_Device *dev, int output, int *w, i | |||
594 | EAPI void ecore_drm_outputs_geometry_get(Ecore_Drm_Device *dev, int *x, int *y, int *w, int *h); | 588 | EAPI void ecore_drm_outputs_geometry_get(Ecore_Drm_Device *dev, int *x, int *y, int *w, int *h); |
595 | 589 | ||
596 | /** | 590 | /** |
597 | * Get the crtc id of an output | 591 | * @ingroup Ecore_Drm_Output_Group |
592 | * @brief Gets the crtc id of an output. | ||
598 | * | 593 | * |
599 | * This function will return the default crtc id for an output | 594 | * This function will return the default crtc id for an output. |
600 | * | 595 | * |
601 | * @param output The Ecore_Drm_Output to get the default crtc of | 596 | * @param output The Ecore_Drm_Output to get the default crtc of |
602 | * | 597 | * |
603 | * @return The id of the default crtc for this output | 598 | * @return The id of the default crtc for this output |
604 | * | 599 | * |
605 | * @ingroup Ecore_Drm_Output_Group | ||
606 | * @since 1.14 | 600 | * @since 1.14 |
607 | */ | 601 | */ |
608 | EAPI unsigned int ecore_drm_output_crtc_id_get(Ecore_Drm_Output *output); | 602 | EAPI unsigned int ecore_drm_output_crtc_id_get(Ecore_Drm_Output *output); |
609 | 603 | ||
610 | /** | 604 | /** |
611 | * Get the crtc buffer of an output | 605 | * @ingroup Ecore_Drm_Output_Group |
606 | * @brief Gets the crtc buffer of an output. | ||
612 | * | 607 | * |
613 | * This function will return the default buffer id for an output | 608 | * This function will return the default buffer id for an output. |
614 | * | 609 | * |
615 | * @param output The Ecore_Drm_Output to get the default buffer of | 610 | * @param output The Ecore_Drm_Output to get the default buffer of |
616 | * | 611 | * |
617 | * @return The id of the default buffer for this output | 612 | * @return The id of the default buffer for this output |
618 | * | 613 | * |
619 | * @ingroup Ecore_Drm_Output_Group | ||
620 | * @since 1.14 | 614 | * @since 1.14 |
621 | */ | 615 | */ |
622 | EAPI unsigned int ecore_drm_output_crtc_buffer_get(Ecore_Drm_Output *output); | 616 | EAPI unsigned int ecore_drm_output_crtc_buffer_get(Ecore_Drm_Output *output); |
623 | 617 | ||
624 | /** | 618 | /** |
625 | * Get the connector id of an output | 619 | * @ingroup Ecore_Drm_Output_Group |
620 | * @brief Gets the connector id of an output. | ||
626 | * | 621 | * |
627 | * This function will return the default connector id for an output | 622 | * This function will return the default connector id for an output. |
628 | * | 623 | * |
629 | * @param output The Ecore_Drm_Output to get the default connector of | 624 | * @param output The Ecore_Drm_Output to get the default connector of |
630 | * | 625 | * |
631 | * @return The id of the default connector id for this output | 626 | * @return The id of the default connector id for this output |
632 | * | 627 | * |
633 | * @ingroup Ecore_Drm_Output_Group | ||
634 | * @since 1.14 | 628 | * @since 1.14 |
635 | */ | 629 | */ |
636 | EAPI unsigned int ecore_drm_output_connector_id_get(Ecore_Drm_Output *output); | 630 | EAPI unsigned int ecore_drm_output_connector_id_get(Ecore_Drm_Output *output); |
@@ -651,47 +645,48 @@ EAPI Ecore_Drm_Fb *ecore_drm_fb_create(Ecore_Drm_Device *dev, int width, int hei | |||
651 | EAPI void ecore_drm_fb_destroy(Ecore_Drm_Fb *fb); | 645 | EAPI void ecore_drm_fb_destroy(Ecore_Drm_Fb *fb); |
652 | 646 | ||
653 | /** | 647 | /** |
654 | * Mark an Ecore_Drm_Fb as dirty | 648 | * @ingroup Ecore_Drm_Fb_Group |
649 | * @brief Marks an Ecore_Drm_Fb as dirty. | ||
655 | * | 650 | * |
656 | * This function mark an Ecore_Drm_Fb as being dirty | 651 | * This function mark an Ecore_Drm_Fb as being dirty. |
657 | * | 652 | * |
658 | * @param fb The Ecore_Drm_Fb to mark as dirty | 653 | * @param fb The Ecore_Drm_Fb to mark as dirty |
659 | * @param rects The regions of the Ecore_Drm_Fb which are dirty | 654 | * @param rects The regions of the Ecore_Drm_Fb which are dirty |
660 | * @param count The number of regions | 655 | * @param count The number of regions |
661 | * | 656 | * |
662 | * @ingroup Ecore_Drm_Fb_Group | ||
663 | * @since 1.14 | 657 | * @since 1.14 |
664 | */ | 658 | */ |
665 | EAPI void ecore_drm_fb_dirty(Ecore_Drm_Fb *fb, Eina_Rectangle *rects, unsigned int count); | 659 | EAPI void ecore_drm_fb_dirty(Ecore_Drm_Fb *fb, Eina_Rectangle *rects, unsigned int count); |
666 | 660 | ||
667 | /** | 661 | /** |
668 | * Set an Ecore_Drm_Fb as the current framebuffer | 662 | * @ingroup Ecore_Drm_Fb_Group |
663 | * @brief Sets an Ecore_Drm_Fb as the current framebuffer. | ||
669 | * | 664 | * |
670 | * This function will set the given Ecore_Drm_Fb as the framebuffer used | 665 | * This function will set the given Ecore_Drm_Fb as the framebuffer used |
671 | * across all outputs | 666 | * across all outputs. |
672 | * | 667 | * |
673 | * @param dev The Ecore_Drm_Device to use | 668 | * @param dev The Ecore_Drm_Device to use |
674 | * @param fb The Ecore_Drm_Fb to make the current framebuffer | 669 | * @param fb The Ecore_Drm_Fb to make the current framebuffer |
675 | * | 670 | * |
676 | * @deprecated just call ecore_drm_fb_send() instead. | 671 | * @deprecated just call ecore_drm_fb_send() instead. |
677 | * | 672 | * |
678 | * @ingroup Ecore_Drm_Fb_Group | ||
679 | * @since 1.14 | 673 | * @since 1.14 |
680 | */ | 674 | */ |
681 | EINA_DEPRECATED EAPI void ecore_drm_fb_set(Ecore_Drm_Device *dev, Ecore_Drm_Fb *fb); | 675 | EINA_DEPRECATED EAPI void ecore_drm_fb_set(Ecore_Drm_Device *dev, Ecore_Drm_Fb *fb); |
682 | 676 | ||
683 | /** | 677 | /** |
684 | * Send an Ecore_Drm_Fb to the Ecore_Drm_Device | 678 | * @internal |
679 | * @ingroup Ecore_Drm_Fb_Group | ||
680 | * @brief Sends an Ecore_Drm_Fb to the Ecore_Drm_Device. | ||
685 | * | 681 | * |
686 | * This function will call drmModePageFlip for the given device using the | 682 | * This function will call drmModePageFlip for the given device using the |
687 | * given Ecore_Drm_Fb as the framebuffer | 683 | * given Ecore_Drm_Fb as the framebuffer. |
688 | * | 684 | * |
689 | * @param dev The Ecore_Drm_Device to use | 685 | * @param dev The Ecore_Drm_Device to use |
690 | * @param fb The Ecore_Drm_Fb to send | 686 | * @param fb The Ecore_Drm_Fb to send |
691 | * @param cb The function to call when the page flip has completed | 687 | * @param cb The function to call when the page flip has completed |
692 | * @param data The data to pass to the callback function | 688 | * @param data The data to pass to the callback function |
693 | * | 689 | * |
694 | * @ingroup Ecore_Drm_Fb_Group | ||
695 | * @since 1.14 | 690 | * @since 1.14 |
696 | */ | 691 | */ |
697 | EAPI void ecore_drm_fb_send(Ecore_Drm_Device *dev, Ecore_Drm_Fb *fb, Ecore_Drm_Pageflip_Cb func, void *data); | 692 | EAPI void ecore_drm_fb_send(Ecore_Drm_Device *dev, Ecore_Drm_Fb *fb, Ecore_Drm_Pageflip_Cb func, void *data); |
@@ -700,117 +695,118 @@ EAPI Eina_Bool ecore_drm_launcher_connect(Ecore_Drm_Device *dev); | |||
700 | EAPI void ecore_drm_launcher_disconnect(Ecore_Drm_Device *dev); | 695 | EAPI void ecore_drm_launcher_disconnect(Ecore_Drm_Device *dev); |
701 | 696 | ||
702 | /** | 697 | /** |
703 | * Get the output position of Ecore_Drm_Output | 698 | * @ingroup Ecore_Drm_Output_Group |
699 | * @brief Gets the output position of Ecore_Drm_Output. | ||
704 | * | 700 | * |
705 | * This function will give the output position of Ecore_Drm_Output | 701 | * This function will give the output position of Ecore_Drm_Output. |
706 | * | 702 | * |
707 | * @param output The Ecore_Drm_Output to get position for | 703 | * @param output The Ecore_Drm_Output to get position for |
708 | * @param *x The parameter in which output x co-ordinate is stored | 704 | * @param *x The parameter in which output x co-ordinate is stored |
709 | * @param *y The parameter in which output y co-ordinate is stored | 705 | * @param *y The parameter in which output y co-ordinate is stored |
710 | * | 706 | * |
711 | * @ingroup Ecore_Drm_Output_Group | ||
712 | * @since 1.14 | 707 | * @since 1.14 |
713 | */ | 708 | */ |
714 | EAPI void ecore_drm_output_position_get(Ecore_Drm_Output *output, int *x, int *y); | 709 | EAPI void ecore_drm_output_position_get(Ecore_Drm_Output *output, int *x, int *y); |
715 | 710 | ||
716 | /** | 711 | /** |
717 | * Get the current resolution of Ecore_Drm_Output | 712 | * @ingroup Ecore_Drm_Output_Group |
713 | * @brief Gets the current resolution of Ecore_Drm_Output. | ||
718 | * | 714 | * |
719 | * This function will give the current resolution of Ecore_Drm_Output | 715 | * This function will give the current resolution of Ecore_Drm_Output. |
720 | * | 716 | * |
721 | * @param output The Ecore_Drm_Output to get resolution for | 717 | * @param output The Ecore_Drm_Output to get resolution for |
722 | * @param *w The parameter in which output width is stored | 718 | * @param *w The parameter in which output width is stored |
723 | * @param *h The parameter in which output height is stored | 719 | * @param *h The parameter in which output height is stored |
724 | * @param *refresh The parameter in which output refresh rate is stored | 720 | * @param *refresh The parameter in which output refresh rate is stored |
725 | * | 721 | * |
726 | * @ingroup Ecore_Drm_Output_Group | ||
727 | * @since 1.14 | 722 | * @since 1.14 |
728 | */ | 723 | */ |
729 | EAPI void ecore_drm_output_current_resolution_get(Ecore_Drm_Output *output, int *w, int *h, unsigned int *refresh); | 724 | EAPI void ecore_drm_output_current_resolution_get(Ecore_Drm_Output *output, int *w, int *h, unsigned int *refresh); |
730 | 725 | ||
731 | /** | 726 | /** |
732 | * Get the physical size of Ecore_Drm_Output | 727 | * @ingroup Ecore_Drm_Output_Group |
728 | * @brief Gets the physical size of Ecore_Drm_Output. | ||
733 | * | 729 | * |
734 | * This function will give the physical size (in mm) of Ecore_Drm_Output | 730 | * This function will give the physical size (in mm) of Ecore_Drm_Output. |
735 | * | 731 | * |
736 | * @param output The Ecore_Drm_Output to get physical size for | 732 | * @param output The Ecore_Drm_Output to get physical size for |
737 | * @param *w The parameter in which output physical width is stored | 733 | * @param *w The parameter in which output physical width is stored |
738 | * @param *h The parameter in which output physical height is stored | 734 | * @param *h The parameter in which output physical height is stored |
739 | * | 735 | * |
740 | * @ingroup Ecore_Drm_Output_Group | ||
741 | * @since 1.14 | 736 | * @since 1.14 |
742 | */ | 737 | */ |
743 | EAPI void ecore_drm_output_physical_size_get(Ecore_Drm_Output *output, int *w, int *h); | 738 | EAPI void ecore_drm_output_physical_size_get(Ecore_Drm_Output *output, int *w, int *h); |
744 | 739 | ||
745 | /** | 740 | /** |
746 | * Get the subpixel order of Ecore_Drm_Output | 741 | * @ingroup Ecore_Drm_Output_Group |
742 | * @brief Gets the subpixel order of Ecore_Drm_Output. | ||
747 | * | 743 | * |
748 | * This function will give the subpixel order of Ecore_Drm_Output | 744 | * This function will give the subpixel order of Ecore_Drm_Output. |
749 | * | 745 | * |
750 | * @param output The Ecore_Drm_Output to get subpixel order for | 746 | * @param output The Ecore_Drm_Output to get subpixel order for |
751 | * @return The output subpixel order | 747 | * @return The output subpixel order |
752 | * | 748 | * |
753 | * @ingroup Ecore_Drm_Output_Group | ||
754 | * @since 1.14 | 749 | * @since 1.14 |
755 | */ | 750 | */ |
756 | EAPI unsigned int ecore_drm_output_subpixel_order_get(Ecore_Drm_Output *output); | 751 | EAPI unsigned int ecore_drm_output_subpixel_order_get(Ecore_Drm_Output *output); |
757 | 752 | ||
758 | /** | 753 | /** |
759 | * Get the model of Ecore_Drm_Output | 754 | * @ingroup Ecore_Drm_Output_Group |
755 | * @brief Gets the model of Ecore_Drm_Output. | ||
760 | * | 756 | * |
761 | * This function will give the model of Ecore_Drm_Output | 757 | * This function will give the model of Ecore_Drm_Output. |
762 | * | 758 | * |
763 | * @param output The Ecore_Drm_Output to get model for | 759 | * @param output The Ecore_Drm_Output to get model for |
764 | * @return The model (do NOT eina_stringshare_del this return!) | 760 | * @return The model (do NOT eina_stringshare_del this return!) |
765 | * | 761 | * |
766 | * @ingroup Ecore_Drm_Output_Group | ||
767 | * @since 1.14 | 762 | * @since 1.14 |
768 | */ | 763 | */ |
769 | EAPI Eina_Stringshare *ecore_drm_output_model_get(Ecore_Drm_Output *output); | 764 | EAPI Eina_Stringshare *ecore_drm_output_model_get(Ecore_Drm_Output *output); |
770 | 765 | ||
771 | /** | 766 | /** |
772 | * Get the make of Ecore_Drm_Output | 767 | * @ingroup Ecore_Drm_Output_Group |
768 | * @brief Gets the make of Ecore_Drm_Output. | ||
773 | * | 769 | * |
774 | * This function will give the make of Ecore_Drm_Output | 770 | * This function will give the make of Ecore_Drm_Output. |
775 | * | 771 | * |
776 | * @param output The Ecore_Drm_Output to get model for | 772 | * @param output The Ecore_Drm_Output to get model for |
777 | * @return The make (do NOT eina_stringshare_del this return!) | 773 | * @return The make (do NOT eina_stringshare_del this return!) |
778 | * | 774 | * |
779 | * @ingroup Ecore_Drm_Output_Group | ||
780 | * @since 1.14 | 775 | * @since 1.14 |
781 | */ | 776 | */ |
782 | EAPI Eina_Stringshare *ecore_drm_output_make_get(Ecore_Drm_Output *output); | 777 | EAPI Eina_Stringshare *ecore_drm_output_make_get(Ecore_Drm_Output *output); |
783 | 778 | ||
784 | /** | 779 | /** |
785 | * Get the name of Ecore_Drm_Output | 780 | * @ingroup Ecore_Drm_Output_Group |
781 | * @brief Gets the name of Ecore_Drm_Output. | ||
786 | * | 782 | * |
787 | * This function will give the name of Ecore_Drm_Output | 783 | * This function will give the name of Ecore_Drm_Output. |
788 | * | 784 | * |
789 | * @param output The Ecore_Drm_Output to get name for | 785 | * @param output The Ecore_Drm_Output to get name for |
790 | * @return The name. Caller should free this return. | 786 | * @return The name. Caller should free this return. |
791 | * | 787 | * |
792 | * @ingroup Ecore_Drm_Output_Group | ||
793 | * @since 1.15 | 788 | * @since 1.15 |
794 | */ | 789 | */ |
795 | EAPI char *ecore_drm_output_name_get(Ecore_Drm_Output *output); | 790 | EAPI char *ecore_drm_output_name_get(Ecore_Drm_Output *output); |
796 | 791 | ||
797 | /** | 792 | /** |
798 | * Set the dpms level of an Ecore_Drm_Output | 793 | * @ingroup Ecore_Drm_Output_Group |
794 | * @brief Sets the dpms level of an Ecore_Drm_Output. | ||
799 | * | 795 | * |
800 | * This function will set the DPMS level of an Ecore_Drm_Output | 796 | * This function will set the DPMS level of an Ecore_Drm_Output. |
801 | * | 797 | * |
802 | * @param output The Ecore_Drm_Output to set the dpms level on | 798 | * @param output The Ecore_Drm_Output to set the dpms level on |
803 | * @param level The level to set | 799 | * @param level The level to set |
804 | * | 800 | * |
805 | * @ingroup Ecore_Drm_Output_Group | ||
806 | * @since 1.14 | 801 | * @since 1.14 |
807 | */ | 802 | */ |
808 | EAPI void ecore_drm_output_dpms_set(Ecore_Drm_Output *output, int level); | 803 | EAPI void ecore_drm_output_dpms_set(Ecore_Drm_Output *output, int level); |
809 | 804 | ||
810 | /** | 805 | /** |
811 | * Set the gamma level of an Ecore_Drm_Output | 806 | * @ingroup Ecore_Drm_Output_Group |
807 | * @brief Sets the gamma level of an Ecore_Drm_Output. | ||
812 | * | 808 | * |
813 | * This function will set the gamma of an Ecore_Drm_Output | 809 | * This function will set the gamma of an Ecore_Drm_Output. |
814 | * | 810 | * |
815 | * @param output The Ecore_Drm_Output to set the gamma level on | 811 | * @param output The Ecore_Drm_Output to set the gamma level on |
816 | * @param size The gamma table size to set | 812 | * @param size The gamma table size to set |
@@ -818,51 +814,51 @@ EAPI void ecore_drm_output_dpms_set(Ecore_Drm_Output *output, int level); | |||
818 | * @param g The amount to scale the green channel | 814 | * @param g The amount to scale the green channel |
819 | * @param b The amount to scale the blue channel | 815 | * @param b The amount to scale the blue channel |
820 | * | 816 | * |
821 | * @ingroup Ecore_Drm_Output_Group | ||
822 | * @since 1.14 | 817 | * @since 1.14 |
823 | */ | 818 | */ |
824 | EAPI void ecore_drm_output_gamma_set(Ecore_Drm_Output *output, uint16_t size, uint16_t *r, uint16_t *g, uint16_t *b); | 819 | EAPI void ecore_drm_output_gamma_set(Ecore_Drm_Output *output, uint16_t size, uint16_t *r, uint16_t *g, uint16_t *b); |
825 | 820 | ||
826 | /** | 821 | /** |
827 | * Get the pointer position of Ecore_Drm_Device | 822 | * @ingroup Ecore_Drm_Device_Group |
823 | * @brief Gets the pointer position of Ecore_Drm_Device. | ||
828 | * | 824 | * |
829 | * This function will give the pointer position of Ecore_Drm_Device | 825 | * This function will give the pointer position of Ecore_Drm_Device. |
830 | * | 826 | * |
831 | * @param dev The Ecore_Drm_Device to get pointer position for | 827 | * @param dev The Ecore_Drm_Device to get pointer position for |
832 | * @param *x The parameter in which output x co-ordinate is stored | 828 | * @param *x The parameter in which output x co-ordinate is stored |
833 | * @param *y The parameter in which output y co-ordinate is stored | 829 | * @param *y The parameter in which output y co-ordinate is stored |
834 | * | 830 | * |
835 | * @ingroup Ecore_Drm_Device_Group | ||
836 | * @since 1.14 | 831 | * @since 1.14 |
837 | */ | 832 | */ |
838 | EAPI void ecore_drm_device_pointer_xy_get(Ecore_Drm_Device *dev, int *x, int *y); | 833 | EAPI void ecore_drm_device_pointer_xy_get(Ecore_Drm_Device *dev, int *x, int *y); |
839 | 834 | ||
840 | /** | 835 | /** |
841 | * Warp the pointer position of Ecore_Drm_Device | 836 | * @ingroup Ecore_Drm_Device_Group |
837 | * @brief Warps the pointer position of Ecore_Drm_Device. | ||
842 | * | 838 | * |
843 | * This function will set the pointer position of Ecore_Drm_Device | 839 | * This function will set the pointer position of Ecore_Drm_Device. |
844 | * | 840 | * |
845 | * @param dev The Ecore_Drm_Device to set pointer position for | 841 | * @param dev The Ecore_Drm_Device to set pointer position for |
846 | * @param x The new x co-ordinate | 842 | * @param x The new x co-ordinate |
847 | * @param y The new y co-ordinate | 843 | * @param y The new y co-ordinate |
848 | * | 844 | * |
849 | * @ingroup Ecore_Drm_Device_Group | ||
850 | * @since 1.18 | 845 | * @since 1.18 |
851 | */ | 846 | */ |
852 | EAPI void ecore_drm_device_pointer_warp(Ecore_Drm_Device *dev, int x, int y); | 847 | EAPI void ecore_drm_device_pointer_warp(Ecore_Drm_Device *dev, int x, int y); |
853 | 848 | ||
854 | /** | 849 | /** |
855 | * Get the list of drm devices which are allocated. | 850 | * @ingroup Ecore_Drm_Device_Group |
851 | * @brief Gets the list of drm devices which are allocated. | ||
856 | * | 852 | * |
857 | * @return Eina_List of drm devices, NULL otherwise | 853 | * @return Eina_List of drm devices, NULL otherwise |
858 | * | 854 | * |
859 | * @ingroup Ecore_Drm_Device_Group | ||
860 | * @since 1.14 | 855 | * @since 1.14 |
861 | */ | 856 | */ |
862 | EAPI const Eina_List *ecore_drm_devices_get(void); | 857 | EAPI const Eina_List *ecore_drm_devices_get(void); |
863 | 858 | ||
864 | /** | 859 | /** |
865 | * Get the minimum and maximum screen size range | 860 | * @ingroup Ecore_Drm_Device_Group |
861 | * @brief Gets the minimum and maximum screen size range. | ||
866 | * | 862 | * |
867 | * @param dev The Ecore_Drm_Device to get screen size range from | 863 | * @param dev The Ecore_Drm_Device to get screen size range from |
868 | * @param *minw The parameter in which smallest width is stored | 864 | * @param *minw The parameter in which smallest width is stored |
@@ -870,61 +866,61 @@ EAPI const Eina_List *ecore_drm_devices_get(void); | |||
870 | * @param *maxw The parameter in which largest width is stored | 866 | * @param *maxw The parameter in which largest width is stored |
871 | * @param *maxh The parameter in which largest height is stored | 867 | * @param *maxh The parameter in which largest height is stored |
872 | * | 868 | * |
873 | * @ingroup Ecore_Drm_Device_Group | ||
874 | * @since 1.15 | 869 | * @since 1.15 |
875 | */ | 870 | */ |
876 | EAPI void ecore_drm_screen_size_range_get(Ecore_Drm_Device *dev, int *minw, int *minh, int *maxw, int *maxh); | 871 | EAPI void ecore_drm_screen_size_range_get(Ecore_Drm_Device *dev, int *minw, int *minh, int *maxw, int *maxh); |
877 | 872 | ||
878 | /** | 873 | /** |
879 | * Get if a given output is connected | 874 | * @ingroup Ecore_Drm_Output_Group |
875 | * @brief Gets if a given output is connected. | ||
880 | * | 876 | * |
881 | * @param output The Ecore_Drm_Output to get the connected status of | 877 | * @param output The Ecore_Drm_Output to get the connected status of |
882 | * | 878 | * |
883 | * @return EINA_TRUE if output is connected, EINA_FALSE otherwise | 879 | * @return EINA_TRUE if output is connected, EINA_FALSE otherwise |
884 | * | 880 | * |
885 | * @ingroup Ecore_Drm_Output_Group | ||
886 | * @since 1.15 | 881 | * @since 1.15 |
887 | */ | 882 | */ |
888 | EAPI Eina_Bool ecore_drm_output_connected_get(Ecore_Drm_Output *output); | 883 | EAPI Eina_Bool ecore_drm_output_connected_get(Ecore_Drm_Output *output); |
889 | 884 | ||
890 | /** | 885 | /** |
891 | * Get the connector type of a given Ecore_Drm_Output | 886 | * @ingroup Ecore_Drm_Output_Group |
887 | * @brief Gets the connector type of a given Ecore_Drm_Output. | ||
892 | * | 888 | * |
893 | * @param output The Ecore_Drm_Output to get the connector type of | 889 | * @param output The Ecore_Drm_Output to get the connector type of |
894 | * | 890 | * |
895 | * @return An unsigned integer representing the type of connector for this output | 891 | * @return An unsigned integer representing the type of connector for this output |
896 | * | 892 | * |
897 | * @ingroup Ecore_Drm_Output_Group | ||
898 | * @since 1.15 | 893 | * @since 1.15 |
899 | */ | 894 | */ |
900 | EAPI unsigned int ecore_drm_output_connector_type_get(Ecore_Drm_Output *output); | 895 | EAPI unsigned int ecore_drm_output_connector_type_get(Ecore_Drm_Output *output); |
901 | 896 | ||
902 | /** | 897 | /** |
903 | * Get if a given output has a backlight | 898 | * @ingroup Ecore_Drm_Output_Group |
899 | * @brief Gets if a given output has a backlight. | ||
904 | * | 900 | * |
905 | * @param output The Ecore_Drm_Output to get the backlight of | 901 | * @param output The Ecore_Drm_Output to get the backlight of |
906 | * | 902 | * |
907 | * @return EINA_TRUE if this output has a backlight, EINA_FALSE otherwise | 903 | * @return EINA_TRUE if this output has a backlight, EINA_FALSE otherwise |
908 | * | 904 | * |
909 | * @ingroup Ecore_Drm_Output_Group | ||
910 | * @since 1.15 | 905 | * @since 1.15 |
911 | */ | 906 | */ |
912 | EAPI Eina_Bool ecore_drm_output_backlight_get(Ecore_Drm_Output *output); | 907 | EAPI Eina_Bool ecore_drm_output_backlight_get(Ecore_Drm_Output *output); |
913 | 908 | ||
914 | /** | 909 | /** |
915 | * Get the edid of a given output | 910 | * @ingroup Ecore_Drm_Output_Group |
911 | * @brief Gets the edid of a given output. | ||
916 | * | 912 | * |
917 | * @param output The Ecore_Drm_Output to get the edid of | 913 | * @param output The Ecore_Drm_Output to get the edid of |
918 | * | 914 | * |
919 | * @return A string representing the edid | 915 | * @return A string representing the edid |
920 | * | 916 | * |
921 | * @ingroup Ecore_Drm_Output_Group | ||
922 | * @since 1.15 | 917 | * @since 1.15 |
923 | */ | 918 | */ |
924 | EAPI char *ecore_drm_output_edid_get(Ecore_Drm_Output *output); | 919 | EAPI char *ecore_drm_output_edid_get(Ecore_Drm_Output *output); |
925 | 920 | ||
926 | /** | 921 | /** |
927 | * Get a list of the modes supported on a given output | 922 | * @ingroup Ecore_Drm_Output_Group |
923 | * @brief Gets a list of the modes supported on a given output. | ||
928 | * | 924 | * |
929 | * @param output The Ecore_Drm_Output to get the modes for | 925 | * @param output The Ecore_Drm_Output to get the modes for |
930 | * | 926 | * |
@@ -932,47 +928,47 @@ EAPI char *ecore_drm_output_edid_get(Ecore_Drm_Output *output); | |||
932 | * | 928 | * |
933 | * @note The returned list should not be freed | 929 | * @note The returned list should not be freed |
934 | * | 930 | * |
935 | * @ingroup Ecore_Drm_Output_Group | ||
936 | * @since 1.15 | 931 | * @since 1.15 |
937 | */ | 932 | */ |
938 | EAPI Eina_List *ecore_drm_output_modes_get(Ecore_Drm_Output *output); | 933 | EAPI Eina_List *ecore_drm_output_modes_get(Ecore_Drm_Output *output); |
939 | 934 | ||
940 | /** | 935 | /** |
941 | * Get the output which is marked as primary | 936 | * @ingroup Ecore_Drm_Output_Group |
937 | * @brief Gets the output which is marked as primary. | ||
942 | * | 938 | * |
943 | * @param dev The Ecore_Drm_Device to get the primary output from | 939 | * @param dev The Ecore_Drm_Device to get the primary output from |
944 | * | 940 | * |
945 | * @return The primary Ecore_Drm_Output or NULL if no primary output is set | 941 | * @return The primary Ecore_Drm_Output or NULL if no primary output is set |
946 | * | 942 | * |
947 | * @ingroup Ecore_Drm_Output_Group | ||
948 | * @since 1.15 | 943 | * @since 1.15 |
949 | */ | 944 | */ |
950 | EAPI Ecore_Drm_Output *ecore_drm_output_primary_get(Ecore_Drm_Device *dev); | 945 | EAPI Ecore_Drm_Output *ecore_drm_output_primary_get(Ecore_Drm_Device *dev); |
951 | 946 | ||
952 | /** | 947 | /** |
953 | * Set a given output as primary | 948 | * @ingroup Ecore_Drm_Output_Group |
949 | * @brief Sets a given output as primary. | ||
954 | * | 950 | * |
955 | * @param output The Ecore_Drm_Output to set as primary | 951 | * @param output The Ecore_Drm_Output to set as primary |
956 | * | 952 | * |
957 | * @ingroup Ecore_Drm_Output_Group | ||
958 | * @since 1.15 | 953 | * @since 1.15 |
959 | */ | 954 | */ |
960 | EAPI void ecore_drm_output_primary_set(Ecore_Drm_Output *output); | 955 | EAPI void ecore_drm_output_primary_set(Ecore_Drm_Output *output); |
961 | 956 | ||
962 | /** | 957 | /** |
963 | * Get the size of the crtc for a given output | 958 | * @ingroup Ecore_Drm_Output_Group |
959 | * @brief Gets the size of the crtc for a given output. | ||
964 | * | 960 | * |
965 | * @param output The Ecore_Drm_Output to get the crtc size of | 961 | * @param output The Ecore_Drm_Output to get the crtc size of |
966 | * @param *width The parameter in which width is stored | 962 | * @param *width The parameter in which width is stored |
967 | * @param *height The parameter in which height is stored | 963 | * @param *height The parameter in which height is stored |
968 | * | 964 | * |
969 | * @ingroup Ecore_Drm_Output_Group | ||
970 | * @since 1.15 | 965 | * @since 1.15 |
971 | */ | 966 | */ |
972 | EAPI void ecore_drm_output_crtc_size_get(Ecore_Drm_Output *output, int *width, int *height); | 967 | EAPI void ecore_drm_output_crtc_size_get(Ecore_Drm_Output *output, int *width, int *height); |
973 | 968 | ||
974 | /** | 969 | /** |
975 | * Find an Ecore_Drm_Output which has the given name | 970 | * @ingroup Ecore_Drm_Device_Group |
971 | * @brief Finds an Ecore_Drm_Output which has the given name. | ||
976 | * | 972 | * |
977 | * This function will loop all the existing outputs in Ecore_Drm_Device and | 973 | * This function will loop all the existing outputs in Ecore_Drm_Device and |
978 | * return an output if one exists that matches the given name. | 974 | * return an output if one exists that matches the given name. |
@@ -982,13 +978,13 @@ EAPI void ecore_drm_output_crtc_size_get(Ecore_Drm_Output *output, int *width, i | |||
982 | * | 978 | * |
983 | * @return An Ecore_Drm_Output if one exists at these coordinates or NULL | 979 | * @return An Ecore_Drm_Output if one exists at these coordinates or NULL |
984 | * | 980 | * |
985 | * @ingroup Ecore_Drm_Device_Group | ||
986 | * @since 1.15 | 981 | * @since 1.15 |
987 | */ | 982 | */ |
988 | EAPI Ecore_Drm_Output *ecore_drm_device_output_name_find(Ecore_Drm_Device *dev, const char *name); | 983 | EAPI Ecore_Drm_Output *ecore_drm_device_output_name_find(Ecore_Drm_Device *dev, const char *name); |
989 | 984 | ||
990 | /** | 985 | /** |
991 | * Get if an Ecore_Drm_Output can be used on a given crtc | 986 | * @ingroup Ecore_Drm_Output_Group |
987 | * @brief Gets if an Ecore_Drm_Output can be used on a given crtc. | ||
992 | * | 988 | * |
993 | * This function will loop the possible crtcs of an encoder to determine if | 989 | * This function will loop the possible crtcs of an encoder to determine if |
994 | * a given output can be assigned to a given crtc | 990 | * a given output can be assigned to a given crtc |
@@ -996,15 +992,15 @@ EAPI Ecore_Drm_Output *ecore_drm_device_output_name_find(Ecore_Drm_Device *dev, | |||
996 | * @param output The Ecore_Drm_Output to test if can be used on crtc | 992 | * @param output The Ecore_Drm_Output to test if can be used on crtc |
997 | * @param crtc The crtc to test an Ecore_Drm_Output against | 993 | * @param crtc The crtc to test an Ecore_Drm_Output against |
998 | * | 994 | * |
999 | * @return EINA_TRUE if the output can be assigned to given crtc, EINA_FALSE otherwise | 995 | * @return @c EINA_TRUE if the output can be assigned to given crtc, @c EINA_FALSE otherwise |
1000 | * | 996 | * |
1001 | * @ingroup Ecore_Drm_Output_Group | ||
1002 | * @since 1.15 | 997 | * @since 1.15 |
1003 | */ | 998 | */ |
1004 | EAPI Eina_Bool ecore_drm_output_possible_crtc_get(Ecore_Drm_Output *output, unsigned int crtc); | 999 | EAPI Eina_Bool ecore_drm_output_possible_crtc_get(Ecore_Drm_Output *output, unsigned int crtc); |
1005 | 1000 | ||
1006 | /** | 1001 | /** |
1007 | * Set a given mode to be used on an Ecore_Drm_Output | 1002 | * @ingroup Ecore_Drm_Output_Group |
1003 | * @brief Sets a given mode to be used on an Ecore_Drm_Output. | ||
1008 | * | 1004 | * |
1009 | * This function will set the given mode to be used on a given Ecore_Drm_Output | 1005 | * This function will set the given mode to be used on a given Ecore_Drm_Output |
1010 | * | 1006 | * |
@@ -1013,9 +1009,8 @@ EAPI Eina_Bool ecore_drm_output_possible_crtc_get(Ecore_Drm_Output *output, unsi | |||
1013 | * @param X The X position to set this output to | 1009 | * @param X The X position to set this output to |
1014 | * @param Y The Y position to set this output to | 1010 | * @param Y The Y position to set this output to |
1015 | * | 1011 | * |
1016 | * @return EINA_TRUE on success, EINA_FALSE on failure | 1012 | * @return @c EINA_TRUE on success, @c EINA_FALSE on failure |
1017 | * | 1013 | * |
1018 | * @ingroup Ecore_Drm_Output_Group | ||
1019 | * @since 1.15 | 1014 | * @since 1.15 |
1020 | */ | 1015 | */ |
1021 | EAPI Eina_Bool ecore_drm_output_mode_set(Ecore_Drm_Output *output, Ecore_Drm_Output_Mode *mode, int x, int y); | 1016 | EAPI Eina_Bool ecore_drm_output_mode_set(Ecore_Drm_Output *output, Ecore_Drm_Output_Mode *mode, int x, int y); |
@@ -1029,7 +1024,8 @@ EAPI unsigned int ecore_drm_output_supported_rotations_get(Ecore_Drm_Output *out | |||
1029 | EAPI Eina_Bool ecore_drm_output_rotation_set(Ecore_Drm_Output *output, Ecore_Drm_Plane_Type type, unsigned int rotation); | 1024 | EAPI Eina_Bool ecore_drm_output_rotation_set(Ecore_Drm_Output *output, Ecore_Drm_Plane_Type type, unsigned int rotation); |
1030 | 1025 | ||
1031 | /** | 1026 | /** |
1032 | * Enable key remap functionality on a Ecore_Drm_Evdev | 1027 | * @ingroup Ecore_Drm_Input_Group |
1028 | * @brief Enables key remap functionality on a Ecore_Drm_Evdev | ||
1033 | * | 1029 | * |
1034 | * This function will enable the key remap functionality to the given Ecore_Drm_Evdev | 1030 | * This function will enable the key remap functionality to the given Ecore_Drm_Evdev |
1035 | * | 1031 | * |
@@ -1039,13 +1035,13 @@ EAPI Eina_Bool ecore_drm_output_rotation_set(Ecore_Drm_Output *output, Ecore_Drm | |||
1039 | * @return EINA_FALSE is returned if the Ecore_Drm_Evdev is not valid, or if no libinput device has been | 1035 | * @return EINA_FALSE is returned if the Ecore_Drm_Evdev is not valid, or if no libinput device has been |
1040 | * assigned to it yet. EINA_TRUE will be returned if enabling key remap for this device succeeded. | 1036 | * assigned to it yet. EINA_TRUE will be returned if enabling key remap for this device succeeded. |
1041 | * | 1037 | * |
1042 | * @ingroup Ecore_Drm_Input_Group | ||
1043 | * @since 1.17 | 1038 | * @since 1.17 |
1044 | */ | 1039 | */ |
1045 | EAPI Eina_Bool ecore_drm_evdev_key_remap_enable(Ecore_Drm_Evdev *edev, Eina_Bool enable); | 1040 | EAPI Eina_Bool ecore_drm_evdev_key_remap_enable(Ecore_Drm_Evdev *edev, Eina_Bool enable); |
1046 | 1041 | ||
1047 | /** | 1042 | /** |
1048 | * Set a given set of keys as remapped keys on a Ecore_Drm_Evdev | 1043 | * @ingroup Ecore_Drm_Input_Group |
1044 | * @brief Sets a given set of keys as remapped keys on a Ecore_Drm_Evdev | ||
1049 | * | 1045 | * |
1050 | * This function will create a hash table of remapping keys as a member of the given Ecore_Drm_Evdev | 1046 | * This function will create a hash table of remapping keys as a member of the given Ecore_Drm_Evdev |
1051 | * | 1047 | * |
@@ -1058,7 +1054,6 @@ EAPI Eina_Bool ecore_drm_evdev_key_remap_enable(Ecore_Drm_Evdev *edev, Eina_Bool | |||
1058 | * assigned to it yet, if key remap is not enabled yet, or the some of the given parameters such as | 1054 | * assigned to it yet, if key remap is not enabled yet, or the some of the given parameters such as |
1059 | * from_keys, to_keys, num are not valid. EINA_TRUE will be returned if setting key remap for this device succeeded. | 1055 | * from_keys, to_keys, num are not valid. EINA_TRUE will be returned if setting key remap for this device succeeded. |
1060 | * | 1056 | * |
1061 | * @ingroup Ecore_Drm_Input_Group | ||
1062 | * @since 1.17 | 1057 | * @since 1.17 |
1063 | */ | 1058 | */ |
1064 | EAPI Eina_Bool ecore_drm_evdev_key_remap_set(Ecore_Drm_Evdev *edev, int *from_keys, int *to_keys, int num); | 1059 | EAPI Eina_Bool ecore_drm_evdev_key_remap_set(Ecore_Drm_Evdev *edev, int *from_keys, int *to_keys, int num); |