Clarify --cpu-mask option values

Clarify that the --cpu-mask option reads values from left to right
and modify the example in the description so it's clearer.

Author: MarkY-LunarG

USAGE_android.md

@@ -759,9 +759,10 @@ optional arguments:
               by <file>
   --cpu-mask <binary-mask>
               Set of CPU cores used by the replayer.
-              `binary-mask` is a succession of '0' and '1' that specifies
-              used/unused cores. For example '1010' activates the first and
-              third cores and deactivate all other cores.
+              `binary-mask` is a succession of '0' and '1' read from left
+              to right that specifies used/unused cores.
+              For example '10010' activates the first and
+              fourth cores and deactivate all other cores.
               If the option is not set, all cores can be used. If the option
               is set only for some cores, the other cores are not used.
   --screenshot-all

USAGE_desktop_D3D12.md

@@ -273,9 +273,10 @@ Optional arguments:
                         Direct3D 12 capture.
   --cpu-mask <binary-mask>
                         Set of CPU cores used by the replayer.
-                        `binary-mask` is a succession of '0' and '1' that specifies
-                        used/unused cores. For example '1010' activates the first and
-                        third cores and deactivate all other cores.
+                        `binary-mask` is a succession of '0' and '1' read from left
+                        to right that specifies used/unused cores.
+                        For example '10010' activates the first and
+                        fourth cores and deactivate all other cores.
                         If the option is not set, all cores can be used. If the option
                         is set only for some cores, the other cores are not used.
   --gpu <index>         Use the specified device for replay, where index

USAGE_desktop_Vulkan.md

@@ -593,9 +593,10 @@ Optional arguments:
   --log-debugview       Log messages with OutputDebugStringA. Windows only.
   --cpu-mask <binary-mask>
                         Set of CPU cores used by the replayer.
-                        `binary-mask` is a succession of '0' and '1' that specifies
-                        used/unused cores. For example '1010' activates the first and
-                        third cores and deactivate all other cores.
+                        `binary-mask` is a succession of '0' and '1' read from left
+                        to right that specifies used/unused cores.
+                        For example '10010' activates the first and
+                        fourth cores and deactivate all other cores.
                         If the option is not set, all cores can be used. If the option
                         is set only for some cores, the other cores are not used.
   --gpu <index>         Use the specified device for replay, where index

android/scripts/gfxrecon.py

@@ -95,7 +95,7 @@ def CreateReplayParser():
     parser.add_argument('--log-file', metavar='DEVICE_FILE', help='Write log messages to a file at the specified path instead of logcat (forwarded to replay tool)')
     parser.add_argument('--pause-frame', metavar='N', help='Pause after replaying frame number N (forwarded to replay tool)')
     parser.add_argument('--paused', action='store_true', default=False, help='Pause after replaying the first frame (same as "--pause-frame 1"; forwarded to replay tool)')
-    parser.add_argument('--cpu-mask', metavar='binary_mask', help='Set of CPU cores used by the replayer. `binary-mask` is a succession of "0" and "1" that specifies used/unused cores. For example "1010" activates the first and third cores and deactivate all other cores. If the option is not set, all cores can be used. If the option is set only for some cores, the other cores are not used. (forwarded to replay tool)')
+    parser.add_argument('--cpu-mask', metavar='binary_mask', help='Set of CPU cores used by the replayer. `binary-mask` is a succession of "0" and "1" that specifies used/unused cores read from left to right. For example "10010" activates the first and fourth cores and deactivate all other cores. If the option is not set, all cores can be used. If the option is set only for some cores, the other cores are not used. (forwarded to replay tool)')
     parser.add_argument('--screenshot-all', action='store_true', default=False, help='Generate screenshots for all frames.  When this option is specified, --screenshots is ignored (forwarded to replay tool)')
     parser.add_argument('--screenshots', metavar='RANGES', help='Generate screenshots for the specified frames.  Target frames are specified as a comma separated list of frame ranges.  A frame range can be specified as a single value, to specify a single frame, or as two hyphenated values, to specify the first and last frames to process.  Frame ranges should be specified in ascending order and cannot overlap.  Note that frame numbering is 1-based (i.e. the first frame is frame 1).  Example: 200,301-305 will generate six screenshots (forwarded to replay tool)')
     parser.add_argument('--screenshot-format', metavar='FORMAT', choices=['bmp', 'png'], help='Image file format to use for screenshot generation.  Available formats are: bmp, png (forwarded to replay tool)')

framework/util/platform.h

@@ -623,7 +623,7 @@ inline std::string GetCpuAffinity()
     std::string affinity;
 
 #ifdef __linux__
-    cpu_set_t   mask;
+    cpu_set_t mask;
     if (sched_getaffinity(0, sizeof(mask), &mask))
     {
         return affinity;
@@ -638,7 +638,7 @@ inline std::string GetCpuAffinity()
     {
         affinity.pop_back();
     }
-#endif
+#endif // __linux__
 
     return affinity;
 }
@@ -661,7 +661,7 @@ static bool SetCpuAffinity(const std::string& affinity)
     }
 
     return (sched_setaffinity(0, sizeof(mask), &mask) == 0);
-#else
+#else // !__linux__
     return false;
 #endif
 }

tools/replay/replay_settings.h

@@ -163,9 +163,10 @@ static void PrintUsage(const char* exe_name)
     GFXRECON_WRITE_CONSOLE("            \t\tDirect3D 12 capture.");
     GFXRECON_WRITE_CONSOLE("  --cpu-mask <binary-mask>");
     GFXRECON_WRITE_CONSOLE("          \t\tSet of CPU cores used by the replayer.");
-    GFXRECON_WRITE_CONSOLE("          \t\t`binary-mask` is a succession of '0' and '1' that specifies");
-    GFXRECON_WRITE_CONSOLE("          \t\tused/unused cores. For example '1010' activates the first and");
-    GFXRECON_WRITE_CONSOLE("          \t\tthird cores and deactivate all other cores.");
+    GFXRECON_WRITE_CONSOLE("          \t\t`binary-mask` is a succession of '0' and '1' read from left to right");
+    GFXRECON_WRITE_CONSOLE("          \t\tthat specifies used/unused cores.");
+    GFXRECON_WRITE_CONSOLE("          \t\tFor example '10010' activates the first and");
+    GFXRECON_WRITE_CONSOLE("          \t\tfourth cores and deactivate all other cores.");
     GFXRECON_WRITE_CONSOLE("          \t\tIf the option is not set, all cores can be used. If the option");
     GFXRECON_WRITE_CONSOLE("          \t\tis set only for some cores, the other cores are not used.");
     GFXRECON_WRITE_CONSOLE("  --gpu <index>\t\tUse the specified device for replay, where index");