diff --git a/docs/library_breakdown/data_structures.rst b/docs/library_breakdown/data_structures.rst index a9f832e..132a416 100644 --- a/docs/library_breakdown/data_structures.rst +++ b/docs/library_breakdown/data_structures.rst @@ -1,405 +1,447 @@ Stack (``pmma.Stack``) ====================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.Stack() -> pmma.Stack - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Stack.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Stack.push() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Stack.pop() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Stack.peek() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Stack.is_empty() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Stack.is_full() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Stack.size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Stack.clear() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Stack.changed() -> None - Not Yet Written + 🟩 **R** - + Queue (``pmma.Queue``) ====================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.Queue() -> pmma.Queue - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Queue.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Queue.enqueue() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Queue.dequeue() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Queue.peek() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Queue.is_empty() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Queue.is_full() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Queue.size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Queue.clear() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Queue.changed() -> None - Not Yet Written + 🟩 **R** - + Circular Queue (``pmma.CircularQueue``) ======================================= -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.CircularQueue() -> pmma.CircularQueue - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: CircularQueue.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: CircularQueue.clear() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: CircularQueue.enqueue() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: CircularQueue.dequeue() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: CircularQueue.peek() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: CircularQueue.size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: CircularQueue.is_empty() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: CircularQueue.is_full() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: CircularQueue.changed() -> None - Not Yet Written + 🟩 **R** - + Priority Queue (``pmma.PriorityQueue``) ======================================= -higher value, higher priority +🟩 **R** - higher value, higher priority Create ------ .. py:method:: pmma.PriorityQueue() -> pmma.PriorityQueue - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: PriorityQueue.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: PriorityQueue.enqueue() -> None - Insert a new value with the given priority into the priority queue. + 🟩 **R** - Insert a new value with the given priority into the priority queue. .. py:method:: PriorityQueue.dequeue() -> None - Remove and return the value with the highest priority from the queue. + 🟩 **R** - Remove and return the value with the highest priority from the queue. .. py:method:: PriorityQueue.peek_next_priority() -> None - Return the highest priority value without removing it from the queue. + 🟩 **R** - Return the highest priority value without removing it from the queue. .. py:method:: PriorityQueue.peek() -> None - Return the value with the highest priority without removing it from the queue. + 🟩 **R** - Return the value with the highest priority without removing it from the queue. .. py:method:: PriorityQueue.is_empty() -> None - Return True if the queue is empty, False otherwise. + 🟩 **R** - Return True if the queue is empty, False otherwise. .. py:method:: PriorityQueue.size() -> None - Return the number of elements in the queue. + 🟩 **R** - Return the number of elements in the queue. .. py:method:: PriorityQueue.clear() -> None - Remove all elements from the queue. + 🟩 **R** - Remove all elements from the queue. .. py:method:: PriorityQueue.changed() -> None - Not Yet Written + 🟩 **R** - + Inverted Priority Queue (``pmma.InvertedPriorityQueue``) ======================================================== -lower value, higher priority. +🟩 **R** - lower value, higher priority. Create ------ .. py:method:: pmma.InvertedPriorityQueue() -> pmma.InvertedPriorityQueue - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: InvertedPriorityQueue.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: InvertedPriorityQueue.enqueue() -> None - Insert a new value with the given priority into the priority queue. + 🟩 **R** - Insert a new value with the given priority into the priority queue. .. py:method:: InvertedPriorityQueue.dequeue() -> None - Remove and return the value with the highest priority (lowest priority value) from the queue. + 🟩 **R** - Remove and return the value with the highest priority (lowest priority value) from the queue. .. py:method:: InvertedPriorityQueue.peek_next_priority() -> None - Return the lowest priority value (highest priority) without removing it from the queue. + 🟩 **R** - Return the lowest priority value (highest priority) without removing it from the queue. .. py:method:: InvertedPriorityQueue.peek() -> None - Return the value with the highest priority (lowest priority value) without removing it from the queue. + 🟩 **R** - Return the value with the highest priority (lowest priority value) without removing it from the queue. .. py:method:: InvertedPriorityQueue.is_empty() -> None - Return True if the queue is empty, False otherwise. + 🟩 **R** - Return True if the queue is empty, False otherwise. .. py:method:: InvertedPriorityQueue.size() -> None - Return the number of elements in the queue. + 🟩 **R** - Return the number of elements in the queue. .. py:method:: InvertedPriorityQueue.clear() -> None - Remove all elements from the queue. + 🟩 **R** - Remove all elements from the queue. .. py:method:: InvertedPriorityQueue.changed() -> None - Not Yet Written + 🟩 **R** - + Priority List (``pmma.PriorityList``) ===================================== -higher value, higher priority +🟩 **R** - higher value, higher priority Create ------ .. py:method:: pmma.PriorityList() -> pmma.PriorityList - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: PriorityList.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: PriorityList.add() -> None - Insert a new value with the given priority into the priority queue. + 🟩 **R** - Insert a new value with the given priority into the priority queue. .. py:method:: PriorityList.remove_item() -> None - Remove a specific item from the queue. + 🟩 **R** - Remove a specific item from the queue. .. py:method:: PriorityList.remove_highest_priority() -> None - Remove and return the value with the highest priority from the queue. + 🟩 **R** - Remove and return the value with the highest priority from the queue. .. py:method:: PriorityList.update_priority() -> None - Update the priority of a value in the queue. + 🟩 **R** - Update the priority of a value in the queue. .. py:method:: PriorityList.peek_next_priority() -> None - Return the highest priority value without removing it from the queue. + 🟩 **R** - Return the highest priority value without removing it from the queue. .. py:method:: PriorityList.peek() -> None - Return the value with the highest priority without removing it from the queue. + 🟩 **R** - Return the value with the highest priority without removing it from the queue. .. py:method:: PriorityList.is_empty() -> None - Return True if the queue is empty, False otherwise. + 🟩 **R** - Return True if the queue is empty, False otherwise. .. py:method:: PriorityList.size() -> None - Return the number of elements in the queue. + 🟩 **R** - Return the number of elements in the queue. .. py:method:: PriorityList.clear() -> None - Remove all elements from the queue. + 🟩 **R** - Remove all elements from the queue. .. py:method:: PriorityList.changed() -> None - Not Yet Written + 🟩 **R** - + Inverted Priority List (``pmma.InvertedPriorityList``) ====================================================== -lower value, higher priority +🟩 **R** - Lower value, higher priority Create ------ .. py:method:: pmma.InvertedPriorityList() -> pmma.InvertedPriorityList - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: InvertedPriorityList.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: InvertedPriorityList.add() -> None - Insert a new value with the given priority into the priority queue. + 🟩 **R** - Insert a new value with the given priority into the priority queue. .. py:method:: InvertedPriorityList.remove_highest_priority() -> None - Remove and return the value with the highest priority (lowest priority value) from the queue. + 🟩 **R** - Remove and return the value with the highest priority (lowest priority value) from the queue. .. py:method:: InvertedPriorityList.update_priority() -> None - Update the priority of a value in the queue. + 🟩 **R** - Update the priority of a value in the queue. .. py:method:: InvertedPriorityList.remove_item() -> None - Remove a specific item from the queue. + 🟩 **R** - Remove a specific item from the queue. .. py:method:: InvertedPriorityList.peek_next_priority() -> None - Return the lowest priority value (highest priority) without removing it from the queue. + 🟩 **R** - Return the lowest priority value (highest priority) without removing it from the queue. .. py:method:: InvertedPriorityList.peek() -> None - Return the value with the highest priority (lowest priority value) without removing it from the queue. + 🟩 **R** - Return the value with the highest priority (lowest priority value) without removing it from the queue. .. py:method:: InvertedPriorityList.is_empty() -> None - Return True if the queue is empty, False otherwise. + 🟩 **R** - Return True if the queue is empty, False otherwise. .. py:method:: InvertedPriorityList.size() -> None - Return the number of elements in the queue. + 🟩 **R** - Return the number of elements in the queue. .. py:method:: InvertedPriorityList.clear() -> None - Remove all elements from the queue. + 🟩 **R** - Remove all elements from the queue. .. py:method:: InvertedPriorityList.changed() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/display.rst b/docs/library_breakdown/display.rst index 04e40c7..1743f50 100644 --- a/docs/library_breakdown/display.rst +++ b/docs/library_breakdown/display.rst @@ -1,95 +1,116 @@ Display (``pmma.Display``) ========================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.Display() -> pmma.Display - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Display.clear() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.set_window_in_focus() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.set_window_minimized() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.get_2D_hardware_accelerated_surface() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.get_3D_hardware_accelerated_surface() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.create() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.set_caption() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.set_icon() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.toggle_full_screen() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.get_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.get_frame_time() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.get_height() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.get_width() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.get_aspect_ratio() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.refresh() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.close() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.get_fps() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.get_refresh_rate() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Display.get_center() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/draw.rst b/docs/library_breakdown/draw.rst index f12e318..237873a 100644 --- a/docs/library_breakdown/draw.rst +++ b/docs/library_breakdown/draw.rst @@ -1,449 +1,542 @@ Line (``pmma.Line``) ==================== -Draws a basic line. +🟩 **R** -Draws a basic line. Create ------ .. py:method:: pmma.Line() -> pmma.Line - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Line.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Line.set_rotation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Line.get_rotation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Line.set_start() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Line.get_start() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Line.set_end() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Line.get_end() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Line.set_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Line.get_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Line.set_width() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Line.get_width() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Line.render() -> None - Not Yet Written + 🟩 **R** - + Radial Polygon (``pmma.RadialPolygon``) ======================================= -Draws a radial polygon. +🟩 **R** - Draws a radial polygon. Create ------ .. py:method:: pmma.RadialPolygon() -> pmma.RadialPolygon - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: RadialPolygon.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RadialPolygon.set_rotation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RadialPolygon.get_rotation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RadialPolygon.set_radius() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RadialPolygon.get_radius() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RadialPolygon.set_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RadialPolygon.get_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RadialPolygon.set_point_count() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RadialPolygon.get_point_count() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RadialPolygon.set_center() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RadialPolygon.get_center() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RadialPolygon.set_width() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RadialPolygon.get_width() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RadialPolygon.render() -> None - Not Yet Written + 🟩 **R** - + Rectangle (``pmma.Rectangle``) ============================== -Draws a rectangle. +🟩 **R** - Draws a rectangle. Create ------ .. py:method:: pmma.Rectangle() -> pmma.Rectangle - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Rectangle.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Rectangle.set_width() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Rectangle.get_width() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Rectangle.set_rotation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Rectangle.get_rotation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Rectangle.set_position() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Rectangle.get_position() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Rectangle.set_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Rectangle.get_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Rectangle.set_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Rectangle.get_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Rectangle.render() -> None - Not Yet Written + 🟩 **R** - + Arc (``pmma.Arc``) ================== -Draws am arc. +🟩 **R** - Draws an arc. Create ------ .. py:method:: pmma.Arc() -> pmma.Arc - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Arc.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.set_width() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.get_width() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.set_rotation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.get_rotation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.set_start_angle() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.get_start_angle() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.set_stop_angle() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.get_stop_angle() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.set_center() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.get_center() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.set_radius() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.get_radius() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.set_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.get_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Arc.render() -> None - Not Yet Written + 🟩 **R** - + Ellipse (``pmma.Ellipse``) ========================== -Draws an ellipse. +🟩 **R** - Draws an ellipse. Create ------ .. py:method:: pmma.Ellipse() -> pmma.Ellipse - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Ellipse.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Ellipse.set_width() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Ellipse.get_width() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Ellipse.set_rotation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Ellipse.get_rotation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Ellipse.set_position() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Ellipse.get_position() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Ellipse.set_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Ellipse.get_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Ellipse.set_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Ellipse.get_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Ellipse.render() -> None - Not Yet Written + 🟩 **R** - + Polygon (``pmma.Polygon``) ========================== -Draws a polygon. +🟩 **R** - Draws a polygon. Create ------ .. py:method:: pmma.Polygon() -> pmma.Polygon - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Polygon.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Polygon.set_rotation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Polygon.get_rotation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Polygon.set_curved() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Polygon.get_curved() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Polygon.set_closed() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Polygon.get_closed() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Polygon.set_points() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Polygon.get_points() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Polygon.set_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Polygon.get_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Polygon.set_width() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Polygon.get_width() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Polygon.render() -> None - Not Yet Written + 🟩 **R** - + Pixel (``pmma.Pixel``) ====================== -Draws a Pixel. +🟩 **R** - Draws a Pixel. Create ------ .. py:method:: pmma.Pixel() -> pmma.Pixel - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Pixel.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Pixel.set_position() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Pixel.get_position() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Pixel.set_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Pixel.get_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Pixel.render() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/executor.rst b/docs/library_breakdown/executor.rst index f87ef34..c5dbf62 100644 --- a/docs/library_breakdown/executor.rst +++ b/docs/library_breakdown/executor.rst @@ -1,62 +1,72 @@ Executor (``pmma.Executor``) ============================ -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.Executor() -> pmma.Executor - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Executor.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Executor.run() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Executor.get_exit_code() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Executor.get_result() -> None - Not Yet Written + 🟩 **R** - + Advanced Executor (``pmma.AdvancedExecutor``) ============================================= -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.AdvancedExecutor() -> pmma.AdvancedExecutor - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: AdvancedExecutor.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: AdvancedExecutor.run() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: AdvancedExecutor.get_busy() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: AdvancedExecutor.get_result() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/file.rst b/docs/library_breakdown/file.rst index f7481cf..c126103 100644 --- a/docs/library_breakdown/file.rst +++ b/docs/library_breakdown/file.rst @@ -1,110 +1,132 @@ File (``pmma.File``) ==================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.File() -> pmma.File - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: File.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: File.exists() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: File.get_path() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: File.get_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: File.get_file_name_and_type() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: File.get_file_name() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: File.get_file_type() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: File.move() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: File.delete() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: File.recycle() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: File.rename() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: File.read() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: File.write() -> None - Not Yet Written + 🟩 **R** - + File Core (``pmma.FileCore``) ============================= -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.FileCore() -> pmma.FileCore - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: FileCore.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: FileCore.update_locations() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: FileCore.scan() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: FileCore.refresh() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: FileCore.stop_passively_refreshing() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: FileCore.start_passively_refreshing() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: FileCore.identify() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/formatters.rst b/docs/library_breakdown/formatters.rst index adef996..a206a5e 100644 --- a/docs/library_breakdown/formatters.rst +++ b/docs/library_breakdown/formatters.rst @@ -1,83 +1,101 @@ Time Formatter (``pmma.TimeFormatter``) ======================================= -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.TimeFormatter() -> pmma.TimeFormatter - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: TimeFormatter.set_from_year() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.set_from_month() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.set_from_day() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.set_from_hour() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.set_from_minute() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.set_from_second() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.set_from_microsecond() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.get_year() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.get_month() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.get_day() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.get_hour() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.get_minute() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.get_second() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.get_microsecond() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.get_in_date_format() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.get_in_sentence_format() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: TimeFormatter.quit() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/gpu_distribution.rst b/docs/library_breakdown/gpu_distribution.rst index 7b07971..5e8c10d 100644 --- a/docs/library_breakdown/gpu_distribution.rst +++ b/docs/library_breakdown/gpu_distribution.rst @@ -1,31 +1,36 @@ GPU Distribution (``pmma.GPUDistribution``) =========================================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.GPUDistribution() -> pmma.GPUDistribution - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: GPUDistribution.get_render_gpu() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GPUDistribution.get_video_gpu() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GPUDistribution.get_all_video_gpus() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GPUDistribution.quit() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/image.rst b/docs/library_breakdown/image.rst index 01c6e3d..5b2ae1b 100644 --- a/docs/library_breakdown/image.rst +++ b/docs/library_breakdown/image.rst @@ -1,39 +1,46 @@ Image (``pmma.Image``) ====================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.Image() -> pmma.Image - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Image.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Image.create_from_file() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Image.create_from_bytes() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Image.image_to_PIL_object() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Image.image_to_display_renderable_object() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Image.blit() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/logging.rst b/docs/library_breakdown/logging.rst index 15d1d7f..2565562 100644 --- a/docs/library_breakdown/logging.rst +++ b/docs/library_breakdown/logging.rst @@ -1,111 +1,136 @@ Logger (``pmma.Logger``) ======================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.Logger() -> pmma.Logger - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Logger.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.set_pmma_log_lifetime() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.set_application_log_lifetime() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.set_log_development_messages_to_terminal() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.set_log_information_messages_to_terminal() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.set_log_warning_messages_to_terminal() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.set_log_error_messages_to_terminal() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.set_log_development_messages_to_file() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.set_log_information_messages_to_file() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.set_log_warning_messages_to_file() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.set_log_error_messages_to_file() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.get_log_development_messages_to_terminal() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.get_log_information_messages_to_terminal() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.get_log_warning_messages_to_terminal() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.get_log_error_messages_to_terminal() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.get_log_development_messages_to_file() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.get_log_information_messages_to_file() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.get_log_warning_messages_to_file() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.get_log_error_messages_to_file() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.set_log_levels() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.log_development() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.log_information() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.log_warning() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Logger.log_error() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/memory_manager.rst b/docs/library_breakdown/memory_manager.rst index 9983833..410f571 100644 --- a/docs/library_breakdown/memory_manager.rst +++ b/docs/library_breakdown/memory_manager.rst @@ -1,31 +1,36 @@ Memory Manager (``pmma.MemoryManager``) ======================================= -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.MemoryManager() -> pmma.MemoryManager - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: MemoryManager.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: MemoryManager.add() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: MemoryManager.get() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: MemoryManager.remove() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/miscellaneous.rst b/docs/library_breakdown/miscellaneous.rst index a753b42..8615b85 100644 --- a/docs/library_breakdown/miscellaneous.rst +++ b/docs/library_breakdown/miscellaneous.rst @@ -6,157 +6,196 @@ Here you will find all the subroutines that aren't grouped into a specific objec .. py:method:: pmma.path_builder() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.set_profile_result_path() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_profile_result_path() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.set_development_mode() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_development_mode() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.set_allow_compilation_of_math_functions() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_allow_compilation_of_math_functions() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_application_running() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.set_application_running() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.set_allow_anti_aliasing() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_allow_anti_aliasing() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.set_anti_aliasing_level() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_anti_aliasing_level() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_language() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.set_language() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.set_shape_quality() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_shape_quality() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.set_in_game_loop() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_in_game_loop() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.set_clean_profiling() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_clean_profiling() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.clean_up() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_application_startup_duration() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_application_run_time() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_execution_time() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_execution_inverse_time() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.targeted_profile_start() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.targeted_profile_end() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.profile_this() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.check_if_object_is_class_or_function() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_theme() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.convert_number_to_text() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.compute() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.register_application() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.get_operating_system() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.is_battery_saver_enabled() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.random_real_number() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: pmma.up() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/noise.rst b/docs/library_breakdown/noise.rst index 9debbf8..63f7de9 100644 --- a/docs/library_breakdown/noise.rst +++ b/docs/library_breakdown/noise.rst @@ -1,7 +1,7 @@ Perlin (``pmma.Perlin``) ======================== -Not Yet Written +🟩 **R** - Create ------ @@ -15,10 +15,44 @@ Methods .. py:method:: Perlin.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Perlin.prefill() -> None + 🟩 **R** - + + +.. py:method:: Perlin.generate_1D_perlin_noise() -> None + + Not Yet Written + +.. py:method:: Perlin.generate_2D_perlin_noise() -> None + + Not Yet Written + +.. py:method:: Perlin.generate_3D_perlin_noise() -> None + + Not Yet Written + +.. py:method:: Perlin.generate_1D_perlin_noise_from_array() -> None + + Not Yet Written + +.. py:method:: Perlin.generate_2D_perlin_noise_from_array() -> None + + Not Yet Written + +.. py:method:: Perlin.generate_3D_perlin_noise_from_array() -> None + + Not Yet Written + +.. py:method:: Perlin.generate_1D_perlin_noise_from_range() -> None + + Not Yet Written + +.. py:method:: Perlin.generate_2D_perlin_noise_from_range() -> None + Not Yet Written .. py:method:: Perlin.generate_3D_perlin_noise_from_range() -> None @@ -27,9 +61,11 @@ Methods .. py:method:: Perlin.set_seed() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Perlin.get_seed() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/number_converter.rst b/docs/library_breakdown/number_converter.rst index b76a78a..591ef9d 100644 --- a/docs/library_breakdown/number_converter.rst +++ b/docs/library_breakdown/number_converter.rst @@ -1,175 +1,205 @@ Angle Converter (``pmma.AngleConverter``) ========================================= -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.AngleConverter() -> pmma.AngleConverter - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: AngleConverter.set_angle() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: AngleConverter.get_angle_set() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: AngleConverter.get_angle() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: AngleConverter.quit() -> None - Not Yet Written + 🟩 **R** - + Proportion Converter (``pmma.ProportionConverter``) =================================================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.ProportionConverter() -> pmma.ProportionConverter - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: ProportionConverter.set_value() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ProportionConverter.get_proportion_set() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ProportionConverter.get_value() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ProportionConverter.quit() -> None - Not Yet Written + 🟩 **R** - + Color Converter (``pmma.ColorConverter``) ========================================= -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.ColorConverter() -> pmma.ColorConverter - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: ColorConverter.set_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorConverter.get_color_set() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorConverter.get_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorConverter.get_color_format() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorConverter.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorConverter.generate_random_color() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorConverter.generate_color_from_perlin_noise() -> None - Not Yet Written + 🟩 **R** - + Display Scalar Converter (``pmma.DisplayScalarConverter``) ========================================================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.DisplayScalarConverter() -> pmma.DisplayScalarConverter - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: DisplayScalarConverter.set_point() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: DisplayScalarConverter.get_point_set() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: DisplayScalarConverter.get_point() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: DisplayScalarConverter.quit() -> None - Not Yet Written + 🟩 **R** - + Display Coordinates Converter (``pmma.DisplayCoordinatesConverter``) ==================================================================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.DisplayCoordinatesConverter() -> pmma.DisplayCoordinatesConverter - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: DisplayCoordinatesConverter.set_coordinates() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: DisplayCoordinatesConverter.get_coordinate_set() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: DisplayCoordinatesConverter.get_coordinates() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: DisplayCoordinatesConverter.generate_random_coordinate() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: DisplayCoordinatesConverter.generate_coordinate_from_perlin_noise() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: DisplayCoordinatesConverter.quit() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/opengl.rst b/docs/library_breakdown/opengl.rst index 47f6693..5be0c0b 100644 --- a/docs/library_breakdown/opengl.rst +++ b/docs/library_breakdown/opengl.rst @@ -1,591 +1,714 @@ OpenGL (``pmma.OpenGL``) ======================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.OpenGL() -> pmma.OpenGL - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: OpenGL.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OpenGL.get_context() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OpenGL.blit_image_to_texture() -> None - Not Yet Written + 🟩 **R** - + Vertex Buffer Object (``pmma.VertexBufferObject``) ================================================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.VertexBufferObject() -> pmma.VertexBufferObject - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: VertexBufferObject.create() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexBufferObject.prepare_for_recreation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexBufferObject.recreate() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexBufferObject.update() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexBufferObject.read() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexBufferObject.get_buffer_object() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexBufferObject.clear() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexBufferObject.bind_to_uniform_block() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexBufferObject.bind_to_shader_storage_buffer() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexBufferObject.get_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexBufferObject.get_dynamic() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexBufferObject.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexBufferObject.get_created() -> None - Not Yet Written + 🟩 **R** - + Generic Buffer Object (``pmma.GenericBufferObject``) ==================================================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.GenericBufferObject() -> pmma.GenericBufferObject - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: GenericBufferObject.create() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GenericBufferObject.prepare_for_recreation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GenericBufferObject.recreate() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GenericBufferObject.update() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GenericBufferObject.read() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GenericBufferObject.get_buffer_object() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GenericBufferObject.clear() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GenericBufferObject.bind_to_uniform_block() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GenericBufferObject.bind_to_shader_storage_buffer() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GenericBufferObject.get_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GenericBufferObject.get_dynamic() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GenericBufferObject.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: GenericBufferObject.get_created() -> None - Not Yet Written + 🟩 **R** - + Color Buffer Object (``pmma.ColorBufferObject``) ================================================ -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.ColorBufferObject() -> pmma.ColorBufferObject - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: ColorBufferObject.create() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorBufferObject.prepare_for_recreation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorBufferObject.recreate() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorBufferObject.update() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorBufferObject.read() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorBufferObject.clear() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorBufferObject.bind_to_uniform_block() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorBufferObject.bind_to_shader_storage_buffer() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorBufferObject.get_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorBufferObject.get_buffer_object() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorBufferObject.get_dynamic() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorBufferObject.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: ColorBufferObject.get_created() -> None - Not Yet Written + 🟩 **R** - + Index Buffer Object (``pmma.IndexBufferObject``) ================================================ -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.IndexBufferObject() -> pmma.IndexBufferObject - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: IndexBufferObject.create() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: IndexBufferObject.prepare_for_recreation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: IndexBufferObject.recreate() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: IndexBufferObject.update() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: IndexBufferObject.read() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: IndexBufferObject.get_buffer_object() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: IndexBufferObject.clear() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: IndexBufferObject.bind_to_uniform_block() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: IndexBufferObject.bind_to_shader_storage_buffer() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: IndexBufferObject.get_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: IndexBufferObject.get_dynamic() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: IndexBufferObject.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: IndexBufferObject.get_created() -> None - Not Yet Written + 🟩 **R** - + Vertex Array Object (``pmma.VertexArrayObject``) ================================================ -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.VertexArrayObject() -> pmma.VertexArrayObject - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: VertexArrayObject.prepare_for_recreation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexArrayObject.create() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexArrayObject.recreate() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexArrayObject.render_wire_frame() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexArrayObject.render() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexArrayObject.get_vertex_array_object() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexArrayObject.get_program() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexArrayObject.get_vertex_buffer_object() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexArrayObject.get_vertex_buffer_shader_attributes() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexArrayObject.get_additional_buffers() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexArrayObject.get_additional_buffer_attributes() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexArrayObject.get_index_buffer_object() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexArrayObject.get_element_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexArrayObject.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: VertexArrayObject.get_created() -> None - Not Yet Written + 🟩 **R** - + Shader (``pmma.Shader``) ======================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.Shader() -> pmma.Shader - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Shader.prepare_for_recreation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.get_buffer_input_variable_names() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.get_using_gl_point_size_syntax() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.set_shader_variable() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.get_shader_variable() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.analyze() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.load_vertex_shader_from_file() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.load_fragment_shader_from_file() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.load_vertex_shader_from_string() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.load_fragment_shader_from_string() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.load_shader_from_string() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.load_shader_from_folder() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.create() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.recreate() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.get_program() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.use_program() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.get_vertex_shader() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.get_fragment_shader() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.get_program() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Shader.get_created() -> None - Not Yet Written + 🟩 **R** - + Texture (``pmma.Texture``) ========================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.Texture() -> pmma.Texture - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Texture.create() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.write() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.load_texture() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.set_scaling() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.get_samples() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.get_intended_samples() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.texture_to_PIL_image() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.get_texture() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.use() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.get_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.get_components() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.get_data() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.build_mipmaps() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.recreate() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Texture.get_created() -> None - Not Yet Written + 🟩 **R** - + Frame Buffer Object (``pmma.FrameBufferObject``) ================================================ -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.FrameBufferObject() -> pmma.FrameBufferObject - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: FrameBufferObject.prepare_for_recreation() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: FrameBufferObject.create() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: FrameBufferObject.recreate() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: FrameBufferObject.clear() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: FrameBufferObject.use() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: FrameBufferObject.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: FrameBufferObject.get_created() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/passport.rst b/docs/library_breakdown/passport.rst index b1fab15..b4c6775 100644 --- a/docs/library_breakdown/passport.rst +++ b/docs/library_breakdown/passport.rst @@ -1,7 +1,7 @@ Passport (``pmma.Passport``) ============================ -Not Yet Written +🟩 **R** - Create ------ @@ -15,149 +15,186 @@ Methods .. py:method:: Passport.get_project_log_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_name() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_sub_name() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_short_description() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_long_description() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_project_url() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_documentation_url() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_project_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_project_temporary_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_project_resources_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_project_python_src_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_project_c_src_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_project_pyx_src_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_license() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_author() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_version() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_supported_python_versions() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.get_project_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_project_log_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_name() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_sub_name() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_short_description() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_long_description() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_project_url() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_documentation_url() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_project_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_project_temporary_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_project_resources_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_project_python_src_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_project_c_src_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_project_pyx_src_directory() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_license() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_author() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_version() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_supported_python_versions() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.set_project_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Passport.quit() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/projection.rst b/docs/library_breakdown/projection.rst index 2e1dcab..c168f5a 100644 --- a/docs/library_breakdown/projection.rst +++ b/docs/library_breakdown/projection.rst @@ -1,153 +1,183 @@ Predefined Projections (``pmma.PredefinedProjections``) ======================================================= -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.PredefinedProjections() -> pmma.PredefinedProjections - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: PredefinedProjections.get_orthographic_projection() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: PredefinedProjections.get_perspective_projection() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: PredefinedProjections.quit() -> None - Not Yet Written + 🟩 **R** - + Perspective Projection (``pmma.PerspectiveProjection``) ======================================================= -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.PerspectiveProjection() -> pmma.PerspectiveProjection - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: PerspectiveProjection.get_fov() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: PerspectiveProjection.set_fov() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: PerspectiveProjection.get_aspect_ratio() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: PerspectiveProjection.set_aspect_ratio() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: PerspectiveProjection.get_near() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: PerspectiveProjection.set_near() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: PerspectiveProjection.get_far() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: PerspectiveProjection.set_far() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: PerspectiveProjection.get_projection_matrix() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: PerspectiveProjection.quit() -> None - Not Yet Written + 🟩 **R** - + Orthographic Projection (``pmma.OrthographicProjection``) ========================================================= -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.OrthographicProjection() -> pmma.OrthographicProjection - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: OrthographicProjection.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OrthographicProjection.set_minimum_x_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OrthographicProjection.get_minimum_x_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OrthographicProjection.set_maximum_x_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OrthographicProjection.get_maximum_x_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OrthographicProjection.set_maximum_y_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OrthographicProjection.get_maximum_y_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OrthographicProjection.set_minimum_y_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OrthographicProjection.get_minimum_y_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OrthographicProjection.set_near() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OrthographicProjection.get_near() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OrthographicProjection.set_far() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OrthographicProjection.get_far() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: OrthographicProjection.get_projection_matrix() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/quickstart.rst b/docs/library_breakdown/quickstart.rst index c7a63d0..0b12692 100644 --- a/docs/library_breakdown/quickstart.rst +++ b/docs/library_breakdown/quickstart.rst @@ -1,7 +1,7 @@ Quick Start (``pmma.QuickStart``) ================================= -Not Yet Written +🟩 **R** - Create ------ @@ -15,13 +15,16 @@ Methods .. py:method:: QuickStart.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: QuickStart.start() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: QuickStart.end() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/render_pipeline.rst b/docs/library_breakdown/render_pipeline.rst index 30b0040..421c230 100644 --- a/docs/library_breakdown/render_pipeline.rst +++ b/docs/library_breakdown/render_pipeline.rst @@ -1,35 +1,41 @@ Render Pipeline (``pmma.RenderPipeline``) ========================================= -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.RenderPipeline() -> pmma.RenderPipeline - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: RenderPipeline.set_render_wire_frame() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RenderPipeline.get_render_wire_frame() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RenderPipeline.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RenderPipeline.add() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: RenderPipeline.render() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/sampler.rst b/docs/library_breakdown/sampler.rst index ac8f187..dce9f0c 100644 --- a/docs/library_breakdown/sampler.rst +++ b/docs/library_breakdown/sampler.rst @@ -1,71 +1,86 @@ Sampler (``pmma.Sampler``) ========================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.Sampler() -> pmma.Sampler - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Sampler.print_input_devices() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Sampler.get_input_devices() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Sampler.set_input_device() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Sampler.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Sampler.get_default_input_device() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Sampler.sampler() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Sampler.start() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Sampler.stop() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Sampler.pause() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Sampler.unpause() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Sampler.get_volume() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Sampler.get_frequency() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Sampler.get_loudest_frequency() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Sampler.is_sampling() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/text.rst b/docs/library_breakdown/text.rst index eab1b1c..0054be3 100644 --- a/docs/library_breakdown/text.rst +++ b/docs/library_breakdown/text.rst @@ -1,12 +1,13 @@ Text (``pmma.Text``) ==================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.Text() -> pmma.Text - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/transitions.rst b/docs/library_breakdown/transitions.rst index 0b8f016..8c3b9f6 100644 --- a/docs/library_breakdown/transitions.rst +++ b/docs/library_breakdown/transitions.rst @@ -1,107 +1,131 @@ Transition (``pmma.Transition``) ================================ -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.Transition() -> pmma.Transition - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Transition.create() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_acceleration_time() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_deceleration_time() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_max_speed() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.set_animation_running() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_start_time() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_end_time() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_start() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_end() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_object() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_type() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_mode() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_duration() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_animated_value() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_animation_running() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.set_current_position() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.set_current_value() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_current_position() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.get_current_value() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.pause() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.resume() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.start() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Transition.quit() -> None - Not Yet Written + 🟩 **R** - + diff --git a/docs/library_breakdown/video.rst b/docs/library_breakdown/video.rst index 63252b2..bd81c2c 100644 --- a/docs/library_breakdown/video.rst +++ b/docs/library_breakdown/video.rst @@ -1,95 +1,116 @@ Video (``pmma.Video``) ====================== -Not Yet Written +🟩 **R** - Create ------ .. py:method:: pmma.Video() -> pmma.Video - Not Yet Written + 🟩 **R** - + Methods ------- .. py:method:: Video.quit() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.play() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.set_looping() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.get_looping() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.stop() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.resume() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.pause() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.set_surface() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.get_surface() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.autodetect_and_set_decoder() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.manually_set_decoder() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.load_from_file() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.has_audio_and_non_zero_data() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.set_position() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.get_position() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.set_target_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.get_target_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.get_video_size() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.get_audio_channel() -> None - Not Yet Written + 🟩 **R** - + .. py:method:: Video.render() -> None - Not Yet Written + 🟩 **R** - +