Skip to content
Snippets Groups Projects
Commit b07a77d8 authored by pippin's avatar pippin Committed by moon2
Browse files

mypy: sprinkle ctx docs

parent 716a767a
No related branches found
No related tags found
1 merge request!226ctx: update from upstream - more enabled features
Pipeline #7364 passed
...@@ -75,22 +75,6 @@ class Context(Protocol): ...@@ -75,22 +75,6 @@ class Context(Protocol):
should be balanced. should be balanced.
""" """
pass pass
def start_frame(self) -> "Context":
"""
Prepare for rendering a new frame, clears internal drawlist and
initializes the state.
TODO(q3k): we probably shouldn't expose this
"""
pass
def end_frame(self) -> "Context":
"""
We're done rendering a frame, this does nothing on a context created for
a framebuffer, where drawing commands are immediate.
TODO(q3k): we probably shouldn't expose this
"""
pass
def start_group(self) -> "Context": def start_group(self) -> "Context":
""" """
Start a compositing group. Start a compositing group.
...@@ -195,24 +179,30 @@ class Context(Protocol): ...@@ -195,24 +179,30 @@ class Context(Protocol):
pass pass
def rel_line_to(self, x: float, y: float) -> "Context": def rel_line_to(self, x: float, y: float) -> "Context":
""" """
TOD(q3k): document Adds a line segment from the current point to current_x + x,
current_y + y.
""" """
pass pass
def rel_move_to(self, x: float, y: float) -> "Context": def rel_move_to(self, x: float, y: float) -> "Context":
""" """
TOD(q3k): document Moves the virtual pen a relative amount without adding a segment to
the current path.
""" """
pass pass
def rel_curve_to( def rel_curve_to(
self, cx0: float, cy0: float, cx1: float, cy1: float, x: float, y: float self, cx0: float, cy0: float, cx1: float, cy1: float, x: float, y: float
) -> "Context": ) -> "Context":
""" """
TOD(q3k): document Adds a cubic bezier segment using relative coordinates, behaves
like curve_to but all coordinate arguments are relative to the
coordinates of the virtual pen when called.
""" """
pass pass
def rel_quad_to(self, cx: float, cy: float, x: float, y: float) -> "Context": def rel_quad_to(self, cx: float, cy: float, x: float, y: float) -> "Context":
""" """
TOD(q3k): document Adds a quadratic bezier segment using relative coordinates, behaves
like quad_to but all coordinate arguments are relative to the
coordinates of the virtual pen when called.
""" """
pass pass
def rel_arc_to( def rel_arc_to(
...@@ -263,17 +253,14 @@ class Context(Protocol): ...@@ -263,17 +253,14 @@ class Context(Protocol):
pass pass
def fill(self) -> "Context": def fill(self) -> "Context":
""" """
TOD(q3k): document Fill the current path with the current source (color, gradient or
texture).
""" """
pass pass
def stroke(self) -> "Context": def stroke(self) -> "Context":
""" """
TOD(q3k): document Stroke the current path with the current source (color, gradient or
""" texture), with current line_width
pass
def paint(self) -> "Context":
"""
TOD(q3k): document
""" """
pass pass
def add_stop( def add_stop(
...@@ -324,12 +311,13 @@ class Context(Protocol): ...@@ -324,12 +311,13 @@ class Context(Protocol):
pass pass
def logo(self, x: float, y: float, dim: float) -> "Context": def logo(self, x: float, y: float, dim: float) -> "Context":
""" """
TOD(q3k): document Draws the ctx logo, centered at x,y with a footprint of roughly dim
units.
""" """
pass pass
def text(self, text: str) -> "Context": def text(self, text: str) -> "Context":
""" """
TOD(q3k): document Add a text fragment using the current fill source, font and font size.
""" """
pass pass
def scope(self) -> "Context": def scope(self) -> "Context":
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment