The open source OpenXR runtime
c/render: Docs improvements
+70
-3
+70
-3
src/xrt/compositor/render/render_interface.h
+70
-3
src/xrt/compositor/render/render_interface.h
···
318
318
* Allocate pools and static resources.
319
319
*
320
320
* @ingroup comp_main
321
+
*
322
+
* @public @memberof render_resources
321
323
*/
322
324
bool
323
325
render_resources_init(struct render_resources *r,
···
327
329
328
330
/*!
329
331
* Free all pools and static resources, does not free the struct itself.
332
+
*
333
+
* @public @memberof render_resources
330
334
*/
331
335
void
332
336
render_resources_close(struct render_resources *r);
···
334
338
/*!
335
339
* Returns the timestamps for when the latest GPU work started and stopped that
336
340
* was submitted using @ref render_gfx or @ref render_compute cmd buf builders.
337
-
* Returned in the same time domain as returned by @ref os_monotonic_get_ns.
341
+
*
342
+
* Returned in the same time domain as returned by @ref os_monotonic_get_ns .
338
343
* Behaviour for this function is undefined if the GPU has not completed before
339
344
* calling this function, so make sure to call vkQueueWaitIdle or wait on the
340
345
* fence that the work was submitted with have fully completed. See other
341
-
* limitation mentioned for @ref vk_convert_timestamps_to_host_ns.
346
+
* limitation mentioned for @ref vk_convert_timestamps_to_host_ns .
342
347
*
343
348
* @see vk_convert_timestamps_to_host_ns
349
+
*
350
+
* @public @memberof render_resources
344
351
*/
345
352
bool
346
353
render_resources_get_timestamps(struct render_resources *r, uint64_t *out_gpu_start_ns, uint64_t *out_gpu_end_ns);
···
421
428
422
429
/*!
423
430
* Init a target resource struct, caller has to keep target alive until closed.
431
+
*
432
+
* @public @memberof render_gfx_target_resources
424
433
*/
425
434
bool
426
435
render_gfx_target_resources_init(struct render_gfx_target_resources *rtr,
···
430
439
431
440
/*!
432
441
* Frees all resources held by the target, does not free the struct itself.
442
+
*
443
+
* @public @memberof render_gfx_target_resources
433
444
*/
434
445
void
435
446
render_gfx_target_resources_close(struct render_gfx_target_resources *rtr);
···
479
490
480
491
/*!
481
492
* Init struct and create resources needed for rendering.
493
+
*
494
+
* @public @memberof render_gfx
482
495
*/
483
496
bool
484
497
render_gfx_init(struct render_gfx *rr, struct render_resources *r);
485
498
486
499
/*!
487
500
* Begins the rendering, takes the vk_bundle's pool lock and leaves it locked.
501
+
*
502
+
* @public @memberof render_gfx
488
503
*/
489
504
bool
490
505
render_gfx_begin(struct render_gfx *rr);
···
492
507
/*!
493
508
* Frees any unneeded resources and ends the command buffer so it can be used,
494
509
* also unlocks the vk_bundle's pool lock that was taken by begin.
510
+
*
511
+
* @public @memberof render_gfx
495
512
*/
496
513
bool
497
514
render_gfx_end(struct render_gfx *rr);
498
515
499
516
/*!
500
517
* Frees all resources held by the rendering, does not free the struct itself.
518
+
*
519
+
* @public @memberof render_gfx
501
520
*/
502
521
void
503
522
render_gfx_close(struct render_gfx *rr);
···
518
537
519
538
struct xrt_normalized_rect post_transform;
520
539
};
540
+
541
+
/*!
542
+
* @name Drawing functions
543
+
* @{
544
+
*/
521
545
522
546
/*!
523
547
* This function allocates everything to start a single rendering. This is the
524
548
* first function you call when you start rendering, you follow up with a call
525
549
* to render_gfx_begin_view.
550
+
*
551
+
* @public @memberof render_gfx
526
552
*/
527
553
bool
528
554
render_gfx_begin_target(struct render_gfx *rr, struct render_gfx_target_resources *rtr);
529
555
556
+
/*!
557
+
* @public @memberof render_gfx
558
+
*/
530
559
void
531
560
render_gfx_end_target(struct render_gfx *rr);
532
561
562
+
/*!
563
+
* @public @memberof render_gfx
564
+
*/
533
565
void
534
566
render_gfx_begin_view(struct render_gfx *rr, uint32_t view, struct render_viewport_data *viewport_data);
535
567
568
+
/*!
569
+
* @public @memberof render_gfx
570
+
*/
536
571
void
537
572
render_gfx_end_view(struct render_gfx *rr);
538
573
574
+
/*!
575
+
* @public @memberof render_gfx
576
+
*/
539
577
void
540
578
render_gfx_distortion(struct render_gfx *rr);
541
579
580
+
/*!
581
+
* @}
582
+
*/
542
583
543
584
/*
544
585
*
···
546
587
*
547
588
*/
548
589
590
+
/*!
591
+
* @name Update functions
592
+
* @{
593
+
*/
594
+
/*!
595
+
* @public @memberof render_gfx
596
+
*/
549
597
void
550
598
render_gfx_update_distortion(struct render_gfx *rr,
551
599
uint32_t view,
552
600
VkSampler sampler,
553
601
VkImageView image_view,
554
602
struct render_gfx_mesh_ubo_data *data);
555
-
603
+
//! @}
556
604
557
605
558
606
/*
···
580
628
581
629
/*!
582
630
* UBO data that is sent to the compute distortion shaders.
631
+
*
632
+
* Used in @ref render_compute
583
633
*/
584
634
struct render_compute_distortion_ubo_data
585
635
···
592
642
593
643
/*!
594
644
* Init struct and create resources needed for compute rendering.
645
+
*
646
+
* @public @memberof render_compute
595
647
*/
596
648
bool
597
649
render_compute_init(struct render_compute *crc, struct render_resources *r);
598
650
599
651
/*!
600
652
* Frees all resources held by the compute rendering, does not free the struct itself.
653
+
*
654
+
* @public @memberof render_compute
601
655
*/
602
656
void
603
657
render_compute_close(struct render_compute *crc);
···
605
659
/*!
606
660
* Begin the compute command buffer building, takes the vk_bundle's pool lock
607
661
* and leaves it locked.
662
+
*
663
+
* @public @memberof render_compute
608
664
*/
609
665
bool
610
666
render_compute_begin(struct render_compute *crc);
···
612
668
/*!
613
669
* Frees any unneeded resources and ends the command buffer so it can be used,
614
670
* also unlocks the vk_bundle's pool lock that was taken by begin.
671
+
*
672
+
* @public @memberof render_compute
615
673
*/
616
674
bool
617
675
render_compute_end(struct render_compute *crc);
618
676
677
+
/*!
678
+
* @public @memberof render_compute
679
+
*/
619
680
void
620
681
render_compute_projection_timewarp(struct render_compute *crc,
621
682
VkSampler src_samplers[2],
···
628
689
VkImageView target_image_view,
629
690
const struct render_viewport_data views[2]);
630
691
692
+
/*!
693
+
* @public @memberof render_compute
694
+
*/
631
695
void
632
696
render_compute_projection(struct render_compute *crc, //
633
697
VkSampler src_samplers[2], //
···
637
701
VkImageView target_image_view, //
638
702
const struct render_viewport_data views[2]); //
639
703
704
+
/*!
705
+
* @public @memberof render_compute
706
+
*/
640
707
void
641
708
render_compute_clear(struct render_compute *crc, //
642
709
VkImage target_image, //