{"id":15146571,"url":"https://github.com/immersive-web/hit-test","last_synced_at":"2025-10-19T16:32:15.174Z","repository":{"id":30483868,"uuid":"125090468","full_name":"immersive-web/hit-test","owner":"immersive-web","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-11T22:04:55.000Z","size":738,"stargazers_count":80,"open_issues_count":17,"forks_count":28,"subscribers_count":37,"default_branch":"main","last_synced_at":"2025-01-29T21:23:47.610Z","etag":null,"topics":["webxr"],"latest_commit_sha":null,"homepage":"https://immersive-web.github.io/hit-test/","language":"Bikeshed","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/immersive-web.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"security-privacy-questionnaire.md","support":null}},"created_at":"2018-03-13T17:36:17.000Z","updated_at":"2024-10-20T16:37:38.000Z","dependencies_parsed_at":"2023-02-19T15:55:14.067Z","dependency_job_id":null,"html_url":"https://github.com/immersive-web/hit-test","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/immersive-web%2Fhit-test","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/immersive-web%2Fhit-test/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/immersive-web%2Fhit-test/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/immersive-web%2Fhit-test/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/immersive-web","download_url":"https://codeload.github.com/immersive-web/hit-test/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237172128,"owners_count":19266616,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["webxr"],"created_at":"2024-09-26T12:02:46.382Z","updated_at":"2025-10-19T16:32:14.834Z","avatar_url":"https://github.com/immersive-web.png","language":"Bikeshed","readme":"# hit-testing Specification\n\n[![Build Status](https://travis-ci.org/immersive-web/hit-test.svg?branch=master)](https://travis-ci.org/immersive-web/hit-test)\n\nThe [hit-testing](https://github.com/immersive-web/hit-test) is to expose hit-testing (raycasting) capability for WebXR\n\nThe [DOM Overlays](https://immersive-web.github.io/dom-overlays/) is the \nrepository of the [Immersive Web Working Group][webxrwg].\n\n## Taking Part\n\n1. Read the [code of conduct][CoC]\n2. See if your issue is being discussed in the [issues](https://github.com/immersive-web/dom-overlays/issues), or if your idea is being discussed in the [proposals repo][cgproposals].\n3. We will be publishing the minutes from the bi-weekly calls.\n4. You can also join the working group to participate in these discussions.\n\n## Specifications\n\n* [Hit Test](https://immersive-web.github.io/hit-test/): Hit Test module specification for WebXR\n* [Explainer](hit-testing-explainer.md)\n* [Security and Privacy Questionnaire](security-privacy-questionnaire.md)\n\n### Related specifications\n* [WebXR Device API - Level 1][webxrspec]: Main specification for JavaScript API for accessing VR and AR devices, including sensors and head-mounted displays.\n\nSee also [list of all specifications with detailed status in Working Group and Community Group](https://www.w3.org/immersive-web/list_spec.html). \n\n## Relevant Links\n\n* [Immersive Web Community Group][webxrcg]\n* [Immersive Web Early Adopters Guide][webxrref]\n* [Immersive Web Working Group Charter][wgcharter]\n\n## Communication\n\n* [Immersive Web Working Group][webxrwg]\n* [Immersive Web Community Group][webxrcg]\n* [GitHub issues list](https://github.com/immersive-web/dom-overlays/issues)\n* [`public-immersive-web` mailing list][publiclist]\n\n## Maintainers\n\nTo generate the spec document (`index.html`) from the `index.bs` [Bikeshed][bikeshed] document:\n\n```sh\nmake\n```\n\n## Tests\n\nFor normative changes, a corresponding\n[web-platform-tests][wpt] PR is highly appreciated. Typically,\nboth PRs will be merged at the same time. Note that a test change that contradicts the spec should\nnot be merged before the corresponding spec change. If testing is not practical, please explain why\nand if appropriate [file a web-platform-tests issue][wptissue]\nto follow up later. Add the `type:untestable` or `type:missing-coverage` label as appropriate.\n\n\n## License\n\nPer the [`LICENSE.md`](LICENSE.md) file:\n\n\u003e All documents in this Repository are licensed by contributors under the  [W3C Software and Document License](https://www.w3.org/Consortium/Legal/copyright-software).\n\n# Summary\n\nIn order for web applications to make use of Augmented Reality (AR) capabilities, they must be able to identify real-world geometry. For example, a web application may wish to detect a horizontal plane (e.g, the floor) in the camera feed, and render an object (e.g, a chair) on that plane.\n\nThere are many ways that real-world geometry could be exposed through a web API. We propose starting by adding a hit-test API. This API would allow the developer to cast a ray into the real world and return a list of intersection points for that ray against whatever world understanding the underlying system gathers.\n\nThis approach abstracts the understanding of the world with a high level primitive that will work across many underlying technologies. A hit-test API would unlock a significant number of use cases for AR while allowing the work to expose other types of world understanding in a web-friendly way to proceed in parallel.\n\nFor more information about this proposal, please read the [explainer](hit-testing-explainer.md) and issues/PRs.\n\n\u003c!-- Links --\u003e\n[CoC]: https://immersive-web.github.io/homepage/code-of-conduct.html\n[webxrwg]: https://w3.org/immersive-web\n[cgproposals]: https://github.com/immersive-web/proposals\n[webxrspec]: https://immersive-web.github.io/webxr/\n[webxrcg]: https://www.w3.org/community/immersive-web/\n[wgcharter]: https://www.w3.org/2020/05/immersive-Web-wg-charter.html\n[webxrref]: https://immersive-web.github.io/webxr-reference/\n[publiclist]: https://lists.w3.org/Archives/Public/public-immersive-web-wg/\n[bikeshed]: https://github.com/tabatkins/bikeshed\n[wpt]: https://github.com/web-platform-tests/wpt\n[wptissue]: https://github.com/web-platform-tests/wpt/issues/new\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimmersive-web%2Fhit-test","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimmersive-web%2Fhit-test","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimmersive-web%2Fhit-test/lists"}