bastd.ui.settings.graphics

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides UI for graphics settings."""
  4
  5from __future__ import annotations
  6
  7from typing import TYPE_CHECKING
  8
  9import ba
 10import ba.internal
 11
 12if TYPE_CHECKING:
 13    pass
 14
 15
 16class GraphicsSettingsWindow(ba.Window):
 17    """Window for graphics settings."""
 18
 19    def __init__(
 20        self,
 21        transition: str = 'in_right',
 22        origin_widget: ba.Widget | None = None,
 23    ):
 24        # pylint: disable=too-many-locals
 25        # pylint: disable=too-many-branches
 26        # pylint: disable=too-many-statements
 27        from bastd.ui import popup
 28        from bastd.ui.config import ConfigCheckBox, ConfigNumberEdit
 29
 30        # if they provided an origin-widget, scale up from that
 31        scale_origin: tuple[float, float] | None
 32        if origin_widget is not None:
 33            self._transition_out = 'out_scale'
 34            scale_origin = origin_widget.get_screen_space_center()
 35            transition = 'in_scale'
 36        else:
 37            self._transition_out = 'out_right'
 38            scale_origin = None
 39
 40        self._r = 'graphicsSettingsWindow'
 41        app = ba.app
 42
 43        spacing = 32
 44        self._have_selected_child = False
 45        uiscale = app.ui.uiscale
 46        width = 450.0
 47        height = 302.0
 48
 49        self._show_fullscreen = False
 50        fullscreen_spacing_top = spacing * 0.2
 51        fullscreen_spacing = spacing * 1.2
 52        if uiscale == ba.UIScale.LARGE and app.platform != 'android':
 53            self._show_fullscreen = True
 54            height += fullscreen_spacing + fullscreen_spacing_top
 55
 56        show_gamma = False
 57        gamma_spacing = spacing * 1.3
 58        if ba.internal.has_gamma_control():
 59            show_gamma = True
 60            height += gamma_spacing
 61
 62        show_vsync = False
 63        if app.platform == 'mac':
 64            show_vsync = True
 65
 66        show_resolution = True
 67        if app.vr_mode:
 68            show_resolution = (
 69                app.platform == 'android' and app.subplatform == 'cardboard'
 70            )
 71
 72        uiscale = ba.app.ui.uiscale
 73        base_scale = (
 74            2.4
 75            if uiscale is ba.UIScale.SMALL
 76            else 1.5
 77            if uiscale is ba.UIScale.MEDIUM
 78            else 1.0
 79        )
 80        popup_menu_scale = base_scale * 1.2
 81        v = height - 50
 82        v -= spacing * 1.15
 83        super().__init__(
 84            root_widget=ba.containerwidget(
 85                size=(width, height),
 86                transition=transition,
 87                scale_origin_stack_offset=scale_origin,
 88                scale=base_scale,
 89                stack_offset=(0, -30)
 90                if uiscale is ba.UIScale.SMALL
 91                else (0, 0),
 92            )
 93        )
 94
 95        btn = ba.buttonwidget(
 96            parent=self._root_widget,
 97            position=(35, height - 50),
 98            size=(120, 60),
 99            scale=0.8,
100            text_scale=1.2,
101            autoselect=True,
102            label=ba.Lstr(resource='backText'),
103            button_type='back',
104            on_activate_call=self._back,
105        )
106
107        ba.containerwidget(edit=self._root_widget, cancel_button=btn)
108
109        ba.textwidget(
110            parent=self._root_widget,
111            position=(0, height - 44),
112            size=(width, 25),
113            text=ba.Lstr(resource=self._r + '.titleText'),
114            color=ba.app.ui.title_color,
115            h_align='center',
116            v_align='top',
117        )
118
119        ba.buttonwidget(
120            edit=btn,
121            button_type='backSmall',
122            size=(60, 60),
123            label=ba.charstr(ba.SpecialChar.BACK),
124        )
125
126        self._fullscreen_checkbox: ba.Widget | None
127        if self._show_fullscreen:
128            v -= fullscreen_spacing_top
129            self._fullscreen_checkbox = ConfigCheckBox(
130                parent=self._root_widget,
131                position=(100, v),
132                maxwidth=200,
133                size=(300, 30),
134                configkey='Fullscreen',
135                displayname=ba.Lstr(
136                    resource=self._r
137                    + (
138                        '.fullScreenCmdText'
139                        if app.platform == 'mac'
140                        else '.fullScreenCtrlText'
141                    )
142                ),
143            ).widget
144            if not self._have_selected_child:
145                ba.containerwidget(
146                    edit=self._root_widget,
147                    selected_child=self._fullscreen_checkbox,
148                )
149                self._have_selected_child = True
150            v -= fullscreen_spacing
151        else:
152            self._fullscreen_checkbox = None
153
154        self._gamma_controls: ConfigNumberEdit | None
155        if show_gamma:
156            self._gamma_controls = gmc = ConfigNumberEdit(
157                parent=self._root_widget,
158                position=(90, v),
159                configkey='Screen Gamma',
160                displayname=ba.Lstr(resource=self._r + '.gammaText'),
161                minval=0.1,
162                maxval=2.0,
163                increment=0.1,
164                xoffset=-70,
165                textscale=0.85,
166            )
167            if ba.app.ui.use_toolbars:
168                ba.widget(
169                    edit=gmc.plusbutton,
170                    right_widget=ba.internal.get_special_widget('party_button'),
171                )
172            if not self._have_selected_child:
173                ba.containerwidget(
174                    edit=self._root_widget, selected_child=gmc.minusbutton
175                )
176                self._have_selected_child = True
177            v -= gamma_spacing
178        else:
179            self._gamma_controls = None
180
181        self._selected_color = (0.5, 1, 0.5, 1)
182        self._unselected_color = (0.7, 0.7, 0.7, 1)
183
184        # quality
185        ba.textwidget(
186            parent=self._root_widget,
187            position=(60, v),
188            size=(160, 25),
189            text=ba.Lstr(resource=self._r + '.visualsText'),
190            color=ba.app.ui.heading_color,
191            scale=0.65,
192            maxwidth=150,
193            h_align='center',
194            v_align='center',
195        )
196        popup.PopupMenu(
197            parent=self._root_widget,
198            position=(60, v - 50),
199            width=150,
200            scale=popup_menu_scale,
201            choices=['Auto', 'Higher', 'High', 'Medium', 'Low'],
202            choices_disabled=['Higher', 'High']
203            if ba.internal.get_max_graphics_quality() == 'Medium'
204            else [],
205            choices_display=[
206                ba.Lstr(resource='autoText'),
207                ba.Lstr(resource=self._r + '.higherText'),
208                ba.Lstr(resource=self._r + '.highText'),
209                ba.Lstr(resource=self._r + '.mediumText'),
210                ba.Lstr(resource=self._r + '.lowText'),
211            ],
212            current_choice=ba.app.config.resolve('Graphics Quality'),
213            on_value_change_call=self._set_quality,
214        )
215
216        # texture controls
217        ba.textwidget(
218            parent=self._root_widget,
219            position=(230, v),
220            size=(160, 25),
221            text=ba.Lstr(resource=self._r + '.texturesText'),
222            color=ba.app.ui.heading_color,
223            scale=0.65,
224            maxwidth=150,
225            h_align='center',
226            v_align='center',
227        )
228        textures_popup = popup.PopupMenu(
229            parent=self._root_widget,
230            position=(230, v - 50),
231            width=150,
232            scale=popup_menu_scale,
233            choices=['Auto', 'High', 'Medium', 'Low'],
234            choices_display=[
235                ba.Lstr(resource='autoText'),
236                ba.Lstr(resource=self._r + '.highText'),
237                ba.Lstr(resource=self._r + '.mediumText'),
238                ba.Lstr(resource=self._r + '.lowText'),
239            ],
240            current_choice=ba.app.config.resolve('Texture Quality'),
241            on_value_change_call=self._set_textures,
242        )
243        if ba.app.ui.use_toolbars:
244            ba.widget(
245                edit=textures_popup.get_button(),
246                right_widget=ba.internal.get_special_widget('party_button'),
247            )
248        v -= 80
249
250        h_offs = 0
251
252        if show_resolution:
253            # resolution
254            ba.textwidget(
255                parent=self._root_widget,
256                position=(h_offs + 60, v),
257                size=(160, 25),
258                text=ba.Lstr(resource=self._r + '.resolutionText'),
259                color=ba.app.ui.heading_color,
260                scale=0.65,
261                maxwidth=150,
262                h_align='center',
263                v_align='center',
264            )
265
266            # on standard android we have 'Auto', 'Native', and a few
267            # HD standards
268            if app.platform == 'android':
269                # on cardboard/daydream android we have a few
270                # render-target-scale options
271                if app.subplatform == 'cardboard':
272                    current_res_cardboard = (
273                        str(
274                            min(
275                                100,
276                                max(
277                                    10,
278                                    int(
279                                        round(
280                                            ba.app.config.resolve(
281                                                'GVR Render Target Scale'
282                                            )
283                                            * 100.0
284                                        )
285                                    ),
286                                ),
287                            )
288                        )
289                        + '%'
290                    )  # yapf: disable
291                    popup.PopupMenu(
292                        parent=self._root_widget,
293                        position=(h_offs + 60, v - 50),
294                        width=120,
295                        scale=popup_menu_scale,
296                        choices=['100%', '75%', '50%', '35%'],
297                        current_choice=current_res_cardboard,
298                        on_value_change_call=self._set_gvr_render_target_scale,
299                    )
300                else:
301                    native_res = ba.internal.get_display_resolution()
302                    assert native_res is not None
303                    choices = ['Auto', 'Native']
304                    choices_display = [
305                        ba.Lstr(resource='autoText'),
306                        ba.Lstr(resource='nativeText'),
307                    ]
308                    for res in [1440, 1080, 960, 720, 480]:
309                        # nav bar is 72px so lets allow for that in what
310                        # choices we show
311                        if native_res[1] >= res - 72:
312                            res_str = str(res) + 'p'
313                            choices.append(res_str)
314                            choices_display.append(ba.Lstr(value=res_str))
315                    current_res_android = ba.app.config.resolve(
316                        'Resolution (Android)'
317                    )
318                    popup.PopupMenu(
319                        parent=self._root_widget,
320                        position=(h_offs + 60, v - 50),
321                        width=120,
322                        scale=popup_menu_scale,
323                        choices=choices,
324                        choices_display=choices_display,
325                        current_choice=current_res_android,
326                        on_value_change_call=self._set_android_res,
327                    )
328            else:
329                # if we're on a system that doesn't allow setting resolution,
330                # set pixel-scale instead
331                current_res = ba.internal.get_display_resolution()
332                if current_res is None:
333                    current_res2 = (
334                        str(
335                            min(
336                                100,
337                                max(
338                                    10,
339                                    int(
340                                        round(
341                                            ba.app.config.resolve(
342                                                'Screen Pixel Scale'
343                                            )
344                                            * 100.0
345                                        )
346                                    ),
347                                ),
348                            )
349                        )
350                        + '%'
351                    )  # yapf: disable
352                    popup.PopupMenu(
353                        parent=self._root_widget,
354                        position=(h_offs + 60, v - 50),
355                        width=120,
356                        scale=popup_menu_scale,
357                        choices=['100%', '88%', '75%', '63%', '50%'],
358                        current_choice=current_res2,
359                        on_value_change_call=self._set_pixel_scale,
360                    )
361                else:
362                    raise Exception(
363                        'obsolete path; discrete resolutions'
364                        ' no longer supported'
365                    )
366
367        # vsync
368        if show_vsync:
369            ba.textwidget(
370                parent=self._root_widget,
371                position=(230, v),
372                size=(160, 25),
373                text=ba.Lstr(resource=self._r + '.verticalSyncText'),
374                color=ba.app.ui.heading_color,
375                scale=0.65,
376                maxwidth=150,
377                h_align='center',
378                v_align='center',
379            )
380
381            popup.PopupMenu(
382                parent=self._root_widget,
383                position=(230, v - 50),
384                width=150,
385                scale=popup_menu_scale,
386                choices=['Auto', 'Always', 'Never'],
387                choices_display=[
388                    ba.Lstr(resource='autoText'),
389                    ba.Lstr(resource=self._r + '.alwaysText'),
390                    ba.Lstr(resource=self._r + '.neverText'),
391                ],
392                current_choice=ba.app.config.resolve('Vertical Sync'),
393                on_value_change_call=self._set_vsync,
394            )
395
396        v -= 90
397        fpsc = ConfigCheckBox(
398            parent=self._root_widget,
399            position=(69, v - 6),
400            size=(210, 30),
401            scale=0.86,
402            configkey='Show FPS',
403            displayname=ba.Lstr(resource=self._r + '.showFPSText'),
404            maxwidth=130,
405        )
406
407        # (tv mode doesnt apply to vr)
408        if not ba.app.vr_mode:
409            tvc = ConfigCheckBox(
410                parent=self._root_widget,
411                position=(240, v - 6),
412                size=(210, 30),
413                scale=0.86,
414                configkey='TV Border',
415                displayname=ba.Lstr(resource=self._r + '.tvBorderText'),
416                maxwidth=130,
417            )
418            # grumble..
419            ba.widget(edit=fpsc.widget, right_widget=tvc.widget)
420        try:
421            pass
422
423        except Exception:
424            ba.print_exception('Exception wiring up graphics settings UI:')
425
426        v -= spacing
427
428        # make a timer to update our controls in case the config changes
429        # under us
430        self._update_timer = ba.Timer(
431            0.25,
432            ba.WeakCall(self._update_controls),
433            repeat=True,
434            timetype=ba.TimeType.REAL,
435        )
436
437    def _back(self) -> None:
438        from bastd.ui.settings import allsettings
439
440        ba.containerwidget(
441            edit=self._root_widget, transition=self._transition_out
442        )
443        ba.app.ui.set_main_menu_window(
444            allsettings.AllSettingsWindow(
445                transition='in_left'
446            ).get_root_widget()
447        )
448
449    def _set_quality(self, quality: str) -> None:
450        cfg = ba.app.config
451        cfg['Graphics Quality'] = quality
452        cfg.apply_and_commit()
453
454    def _set_textures(self, val: str) -> None:
455        cfg = ba.app.config
456        cfg['Texture Quality'] = val
457        cfg.apply_and_commit()
458
459    def _set_android_res(self, val: str) -> None:
460        cfg = ba.app.config
461        cfg['Resolution (Android)'] = val
462        cfg.apply_and_commit()
463
464    def _set_pixel_scale(self, res: str) -> None:
465        cfg = ba.app.config
466        cfg['Screen Pixel Scale'] = float(res[:-1]) / 100.0
467        cfg.apply_and_commit()
468
469    def _set_gvr_render_target_scale(self, res: str) -> None:
470        cfg = ba.app.config
471        cfg['GVR Render Target Scale'] = float(res[:-1]) / 100.0
472        cfg.apply_and_commit()
473
474    def _set_vsync(self, val: str) -> None:
475        cfg = ba.app.config
476        cfg['Vertical Sync'] = val
477        cfg.apply_and_commit()
478
479    def _update_controls(self) -> None:
480        if self._show_fullscreen:
481            ba.checkboxwidget(
482                edit=self._fullscreen_checkbox,
483                value=ba.app.config.resolve('Fullscreen'),
484            )