knight Namespace Reference

Classes
class	KnightsTourWindow
class	Position
class	Tour

Functions
int	lround (float value)
int	main ()
	parse_args ()
tuple[int, int]	parse_resolution (str value)

Variables
	EXAMPLE_DIR = Path(__file__).resolve().parent

Function Documentation

lround()

int lround

(

float

value

)

Definition at line 41 of file knight.py.

def lround(value: float) -> int:
    if (value >= 0.0):
        return math.floor(value + 0.5)
 
    return math.ceil(value - 0.5)
 
 
@dataclass(frozen=True, slots=True)

main()

int main

(

void

)

Definition at line 453 of file knight.py.

def main() -> int:
    args = parse_args()
    width, height = args.resolution
    window = None
 
    try:
        window = KnightsTourWindow(args.path, width, height, args.fullscreen, args.enable_vsync)
        window.loop()
 
    except mxvk.MXVKError as exception:
        print(f"mxvk: Exception: {exception}", file=sys.stderr)
        return 1
 
    finally:
        if window is not None:
            window.close()
 
    return 0
 
 

parse_args()

parse_args

(

)

Definition at line 442 of file knight.py.

def parse_args():
    parser = argparse.ArgumentParser(description="Knights Tour using the MXVK Python bindings")
 
    parser.add_argument("-p", "--path", default=str(EXAMPLE_DIR), help="resource root containing the data directory")
    parser.add_argument("-r", "--resolution", type=parse_resolution, default=(960, 720), metavar="WIDTHxHEIGHT", help="window resolution (default: 960x720)")
    parser.add_argument("-f", "--fullscreen", action="store_true", help="start fullscreen")
    parser.add_argument("--enable-vsync", action="store_true", help="enable vertical synchronization")
 
    return parser.parse_args()
 
 

parse_resolution()

tuple[int, int] parse_resolution

(

str

value

)

Definition at line 427 of file knight.py.

def parse_resolution(value: str) -> tuple[int, int]:
    try:
        width_text, height_text = value.lower().split("x", 1)
        width = int(width_text)
        height = int(height_text)
 
    except ValueError as exception:
        raise argparse.ArgumentTypeError("resolution must use WIDTHxHEIGHT, for example 960x720") from exception
 
    if (width <= 0 or height <= 0):
        raise argparse.ArgumentTypeError("resolution width and height must be greater than zero")
 
    return width, height
 
 

Variable Documentation

EXAMPLE_DIR

knight.EXAMPLE_DIR = Path(__file__).resolve().parent

Definition at line 38 of file knight.py.