Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Windows documentation #12013

Merged
merged 7 commits into from
Sep 10, 2023
Merged

Refactor Windows documentation #12013

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b87bea6
Small changes
Tamir91 Jul 18, 2023
3e67c2b
Note added
Tamir91 Jul 25, 2023
1923071
Note refactored
Tamir91 Jul 25, 2023
32f5255
small updates
Tamir91 Jul 31, 2023
7c5e356
CMake and Visual Studio versions updated
Tamir91 Aug 9, 2023
3b3f24f
typo fixed
Tamir91 Aug 30, 2023
dce9942
MSVC2015 updated
Tamir91 Sep 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified doc/img/windows_cmake.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/img/winver_Win10.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 14 additions & 11 deletions doc/installation_windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
# Windows 8.1 & Windows 10 Installation
# Windows 10 & Windows 11 Installation

**Note:** Due to the USB 3.0 translation layer between native hardware and virtual machine, the librealsense team does not recommend or support installation in a VM.

librealsense shall be built on Windows using [CMake v3.8+](https://cmake.org/download/) and Visual Studio 2015 / 2017:
librealsense shall be built on Windows using [CMake v3.8+](https://cmake.org/download/) and Visual Studio 2017 / 2019 / 2022:
(MSVC2013 and older are not fully compatible with the C++11 feature-set).
maloel marked this conversation as resolved.
Show resolved Hide resolved
<a name="cmake_snapshot_win">
![Windows CMake](./img/windows_cmake.png)
</a>
![link text][Win_cmake_image]

Don't forget to check `BUILD_EXAMPLES` if you wish to use librealsense samples.
![Windows CMake](./img/windows_cmake.png)

## Windows 8.1:
When working on Windows 8.1, make sure you have [KB3075872](https://support.microsoft.com/en-us/kb/3075872) and [KB2919355](https://support.microsoft.com/en-us/kb/2919355) installed. These patches are addressing issues specific to 8.1 video drivers, that were later resolved in Windows 10.
Don't forget to check `BUILD_EXAMPLES` if you wish to use librealsense samples.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Down in the document please update according to this:
Windows 10 (Build 15063 or later, 17763+ recommended) and Windows 11
The winver image needs to change too

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Windows 10 SDK version 1809 | 10.0.17763.0 is being validated by RS.
Lets write only this
Windows 10 (Build 15063 or later, 17763+ recommended) and Windows 11

Instead of both and give this screenshot
image

Thanks

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A build number and screenshot updated.


## Enabling metadata on Windows
Metadata attributes is an advanced capability provided by librealsense.
Expand All @@ -25,14 +20,16 @@ Prerequisites:

#### Installation:
- Verify OS version:
- Run `winver` command from desktop/terminal - "Version 1607" or later is expected.
- Run `winver` command from desktop/terminal - "Windows 10 (Build 15063 or later, 17763+ recommended) or Windows 11" is expected.

![winver](./img/winver_Win10.png)

- Install WinSDK ver10:
- Navigate to "Control Panel" -> "Programs and Features"
- Double-click on "Microsoft Visual Studio" and select "Modify"
- Check that SDK version 10.0.10586 or later is present, install if needed:
![winsdk](./img/WinSDK_10.0.10586.png)

- ![winsdk](./img/WinSDK_10.0.10586.png)

##### Update Registry:
- Windows OS requires a dedicated registry entry to be present for each unique video device in order to provide metadata.
Expand Down Expand Up @@ -92,3 +89,9 @@ When set, the compiler will check the target WinSDK version, and abort the build

**Note** In case of multiple WinSDK version installed, CMake automatically selects the latest version of SDK. In some cases, however, the automatic selection may fail. Then you need to manually retarget the solution for the proper WinSDK version:
![win_retarget_platform](./img/win_retarget_platform.png)

## Troubleshooting Issues

| Error | Cause | Correction Steps |
|-----------------------------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
| The camera is not recognized by the SDK | The SDK has not access to camera | Make sure that "Allow desktop apps to access your camera" setting is set to on in Windows OS (Setting -> Privacy -> Camera) |
maloel marked this conversation as resolved.
Show resolved Hide resolved