Skip to content

Commit

Permalink
Minor doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
einarf committed Nov 29, 2024
1 parent 2553a86 commit d1242bc
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/guide/resource_system.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Textures
textures.load(TextureDescription(path='wood.png', flip=True, mipmap=True, anisotropy=16.0))
# Load a texture array containing 10 vertically stacked tile textures
textures.load(TextureDescription(path='tiles.png', layers=10, mipmap=True, anisotrpy=8.0))
textures.load(TextureDescription(path='tiles.png', layers=10, mipmap=True, anisotropy=8.0))
Programs
~~~~~~~~
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Welcome to moderngl-window's documentation!
A cross platform helper library for ModernGL making window
creation and resource loading simple.

.. Note:: Please report documentation improvements/issues on github.
Writing documentation is difficult and we can't do it without you.
.. Note:: Please report documentation improvements/issues on github.

Writing documentation is difficult and we can't do it without you.
Pull requests with documentation improvements are also greatly appreciated.

.. toctree::
Expand Down
34 changes: 22 additions & 12 deletions moderngl_window/context/base/window.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,18 +101,28 @@ def __init__(
) -> None:
"""Initialize a window instance.
Args:
title (str): The window title
gl_version (tuple): Major and minor version of the opengl context to create
size (tuple): Window size x, y
resizable (bool): Should the window be resizable?
visible (bool): Should the window be visible when created?
fullscreen (bool): Open window in fullscreen mode
vsync (bool): Enable/disable vsync
aspect_ratio (float): The desired fixed aspect ratio. Can be set to ``None`` to make
aspect ratio be based on the actual window size.
samples (int): Number of MSAA samples for the default framebuffer
cursor (bool): Enable/disable displaying the cursor inside the window
Keyword Args:
title:
The window title
gl_version:
Major and minor version of the opengl context to create
size:
indow size x, y
resizable:
Should the window be resizable?
visible:
Should the window be visible when created?
fullscreen:
Open window in fullscreen mode
vsync:
Enable/disable vsync
aspect_ratio:
The desired fixed aspect ratio. Can be set to ``None`` to make
aspect ratio be based on the actual window size.
samples:
Number of MSAA samples for the default framebuffer
cursor:
Enable/disable displaying the cursor inside the window
"""
# Window parameters
self._title = title
Expand Down

0 comments on commit d1242bc

Please sign in to comment.