.\" Composed by Rylie Pavlik <rylie.pavlik@collabora.com>
.\" Copyright 2020, Collabora, Ltd.
.\" SPDX-License-Identifier: Apache-2.0
.Dd March 06, 2020
.Dt HELLO_XR 1
.Os
.Sh "نام (NAME)"
.Nm hello_xr
.Nd یک برنامه نمونه OpenXR.
.Sh "خلاصه دستور (SYNOPSIS)"
.Nm
.Op Fl h | Fl -help
.Nm
.Fl g | Fl -graphics Ar graphics_api
.Op Fl ff | Fl -formfactor Ar form_factor
.Op Fl vc | Fl -viewconfig Ar view_config
.Op Fl bm | Fl -blendmode Ar blend_mode
.Op Fl s | Fl -space Ar space
.Op Fl v | Fl -verbose
.Sh "توضیحات (DESCRIPTION)"
.Nm
یک برنامه نمونه است که با استفاده از رابط برنامه‌نویسی
.Tn OpenXR
نوشته شده است.
.Pp
آرگومان‌ها به شرح زیر هستند:
.Bl -tag -width -indent
.It Fl h | Fl -help
نمایش راهنمای مختصر نحوه استفاده.
.It g | Fl -graphics Ar graphics_api
.Em ضروری:
رابط برنامه‌نویسی گرافیکی (graphics API) مورد استفاده را مشخص می‌کند.
(توجه داشته باشید که لزوماً همه رابط‌های برنامه‌نویسی گرافیکی روی تمام سیستم‌ها موجود نیستند.)
پارامتر
.Ar graphics_api
باید یکی از موارد زیر باشد (غیرحساس به حروف کوچک و بزرگ):
.Bl -tag
.It Ql D3D11
Direct3D 11 (فقط در ویندوز)
.It Ql D3D12
Direct3D 12 (فقط در ویندوز)
.It Ql OpenGLES
.It Ql OpenGL
.It Ql Vulkan
.El
.It Fl ff | Fl -formfactor Ar form_factor
فرم فاکتور (form factor) مورد استفاده را مشخص می‌کند.
(توجه داشته باشید که برای کارکرد صحیح، به یک سیستم XR مناسب و یک زمان اجرا (runtime) که از فرم فاکتور مربوطه پشتیبانی کند نیاز است.)
پارامتر
.Ar form_factor
باید یکی از موارد زیر باشد (غیرحساس به حروف کوچک و بزرگ):
.Bl -tag
.It Ql Hmd
نمایشگر متصل به سر (پیش‌فرض)
.It Ql Handheld
.El
.It Fl vc | Fl -viewconfig Ar view_config
پیکربندی نما (view configuration) مورد استفاده را مشخص می‌کند.
(توجه داشته باشید که برای کارکرد صحیح، به یک سیستم XR مناسب و زمان اجرایی که از پیکربندی نمای مربوطه پشتیبانی کند نیاز است.)
پارامتر
.Ar view_config
باید یکی از موارد زیر باشد (غیرحساس به حروف کوچک و بزرگ):
.Bl -tag
.It Ql Mono
.It Ql Stereo
(پیش‌فرض)
.El
.It Fl bm | Fl -blendmode Ar blend_mode
حالت آمیختگی محیط (environment blend mode) مورد استفاده را مشخص می‌کند.
(توجه داشته باشید که برای کارکرد صحیح، به یک سیستم XR مناسب و زمان اجرایی که از حالت آمیختگی محیط مربوطه پشتیبانی کند نیاز است.)
پارامتر
.Ar blend_mode
باید یکی از موارد زیر باشد (غیرحساس به حروف کوچک و بزرگ):
.Bl -tag
.It Ql Opaque
.It Ql Additive
.It Ql AlphaBlend
.El
.It Fl s | Fl -space Ar space
فضای مورد استفاده را مشخص می‌کند.
پارامتر
.Ar space
باید یکی از موارد زیر باشد (غیرحساس به حروف کوچک و بزرگ):
.Bl -tag
.It Ql View
.It Ql Local
.It Ql Stage
.El
.It Fl v | Fl -verbose
فعال‌سازی خروجی پرجزئیات ثبت وقایع (verbose) از خود برنامه
.Nm .
.El
.Sh "وضعیت خروج (EXIT STATUS)"
.Ex -std
.Sh "همچنین ببینید (SEE ALSO)"
.Xr openxr_runtime_list 1 ,
https://registry.khronos.org/OpenXR ,
https://github.com/KhronosGroup/OpenXR-SDK-Source/tree/main/src/tests/hello_xr