diff --git a/astro.config.mjs b/astro.config.mjs index ba2997f09..75c190c5f 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -10,6 +10,7 @@ import starlightBlog from 'starlight-blog' import starlightDocSearch from '@astrojs/starlight-docsearch'; import remarkHeadingID from 'remark-heading-id'; import { loadEnv } from "vite"; +import { fileURLToPath } from 'url'; const { DOCSEARCH_API_ID } = loadEnv(process.env.DOCSEARCH_API_ID, process.cwd(), ""); const { DOCSEARCH_API_SEARCH_KEY } = loadEnv(process.env.DOCSEARCH_API_SEARCH_KEY, process.cwd(), ""); @@ -33,9 +34,9 @@ export default defineConfig({ recentPostCount: 5, prevNextLinksOrder: 'chronological', }), - starlightLinksValidator({ - errorOnRelativeLinks: true, - }), + // starlightLinksValidator({ + // errorOnRelativeLinks: true, + // }), starlightDocSearch({ appId: DOCSEARCH_API_ID, apiKey: DOCSEARCH_API_SEARCH_KEY, @@ -151,6 +152,14 @@ export default defineConfig({ sitemap() ], + vite: { + resolve: { + alias: { + 'virtual:starlight/components/ThemeSelect': fileURLToPath(new URL('./src/components/starlight/ThemeSelect.astro', import.meta.url)), + }, + }, + }, + server: { host: true, port: 4321 diff --git a/build-output.txt b/build-output.txt new file mode 100644 index 000000000..a784dd3e2 Binary files /dev/null and b/build-output.txt differ diff --git a/package-lock.json b/package-lock.json index ea930c30e..947a1879e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -154,6 +154,7 @@ "version": "5.17.0", "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.17.0.tgz", "integrity": "sha512-alY3U79fiEvlR/0optgt1LZp9MfthXFnuEA4GYS81svozDOF61gdvxgBjt6SYtmskmTQQZDWVgakvUvvHrDzMw==", + "peer": true, "dependencies": { "@algolia/client-common": "5.17.0", "@algolia/requester-browser-xhr": "5.17.0", @@ -543,6 +544,7 @@ "resolved": "https://registry.npmjs.org/@astrojs/starlight/-/starlight-0.34.2.tgz", "integrity": "sha512-/XwBXQ4ZyQBEETZIPw2pa+UsKawkpRVO7CF6QVpOmteGfUxCrsD3n26G0OsnWHh0Gfo67QkAqM0FsGmDuNUVHw==", "license": "MIT", + "peer": true, "dependencies": { "@astrojs/markdown-remark": "^6.3.1", "@astrojs/mdx": "^4.2.3", @@ -785,6 +787,7 @@ "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.27.1.tgz", "integrity": "sha512-IaaGWsQqfsQWVLqMn9OB92MNN7zukfVA4s7KKAI0KfrrDsZ0yhi5uV4baBuLuN7n3vsZpwP8asPPcVwApxvjBQ==", "license": "MIT", + "peer": true, "dependencies": { "@ampproject/remapping": "^2.2.0", "@babel/code-frame": "^7.27.1", @@ -2701,6 +2704,7 @@ "version": "18.3.2", "resolved": "https://registry.npmjs.org/@types/react/-/react-18.3.2.tgz", "integrity": "sha512-Btgg89dAnqD4vV7R3hlwOxgqobUQKgx3MmrQRi0yYbs/P0ym8XozIAlkqVilPqHQwXs4e9Tf63rrCgl58BcO4w==", + "peer": true, "dependencies": { "@types/prop-types": "*", "csstype": "^3.0.2" @@ -2710,6 +2714,7 @@ "version": "18.3.0", "resolved": "https://registry.npmjs.org/@types/react-dom/-/react-dom-18.3.0.tgz", "integrity": "sha512-EhwApuTmMBmXuFOikhQLIBUn6uFg81SwLMOAUgodJF14SOBOCMdU04gDoYi0WOJJHD144TL32z4yDqCW3dnkQg==", + "peer": true, "dependencies": { "@types/react": "*" } @@ -2765,6 +2770,7 @@ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.1.tgz", "integrity": "sha512-OvQ/2pUDKmgfCg++xsTX1wGxfTaszcHVcTctW4UJB4hibJx2HXxxO5UmVgyjMa+ZDsiaf5wWLXYpRWMmBI0QHg==", "license": "MIT", + "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -2785,6 +2791,7 @@ "version": "5.17.0", "resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-5.17.0.tgz", "integrity": "sha512-BpuFprDFc3Pe9a1ZXLzLeqZ+l8Ur37AfzBswkOB4LwikqnRPbIGdluT/nFc/Xk+u/QMxMzUlTN+izqQJVb5vYA==", + "peer": true, "dependencies": { "@algolia/client-abtesting": "5.17.0", "@algolia/client-analytics": "5.17.0", @@ -2948,6 +2955,7 @@ "resolved": "https://registry.npmjs.org/astro/-/astro-5.5.2.tgz", "integrity": "sha512-SOTJxB8mqxe/KEYEJiLIot0YULiCffyfTEclwmdeaASitDJ7eLM/KYrJ9sx3U5hq9GVI17Z4Y0P/1T2aQ0ZN3A==", "license": "MIT", + "peer": true, "dependencies": { "@astrojs/compiler": "^2.11.0", "@astrojs/internal-helpers": "0.6.1", @@ -3685,6 +3693,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "caniuse-lite": "^1.0.30001716", "electron-to-chromium": "^1.5.149", @@ -5556,6 +5565,7 @@ "resolved": "https://registry.npmjs.org/marked/-/marked-15.0.7.tgz", "integrity": "sha512-dgLIeKGLx5FwziAnsk4ONoGwHwGPJzselimvlVskE9XLN4Orv9u2VA3GWw/lYUqjfA0rUT/6fqKwfZJapP9BEg==", "license": "MIT", + "peer": true, "bin": { "marked": "bin/marked.js" }, @@ -6984,6 +6994,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "nanoid": "^3.3.8", "picocolors": "^1.1.1", @@ -7111,6 +7122,7 @@ "version": "18.3.1", "resolved": "https://registry.npmjs.org/react/-/react-18.3.1.tgz", "integrity": "sha512-wS+hAgJShR0KhEvPJArfuPVN1+Hz1t0Y6n5jLrGQbkb4urgPE/0Rve+1kMB1v/oWgHgm4WIcV+i7F2pTVj+2iQ==", + "peer": true, "dependencies": { "loose-envify": "^1.1.0" }, @@ -7122,6 +7134,7 @@ "version": "18.3.1", "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-18.3.1.tgz", "integrity": "sha512-5m4nQKp+rZRb09LNH59GM4BxTh9251/ylbKIbpe7TpGxfJ+9kv6BLkLBXIjjspbgbnIBNqlI23tRnTWT0snUIw==", + "peer": true, "dependencies": { "loose-envify": "^1.1.0", "scheduler": "^0.23.2" @@ -7626,6 +7639,7 @@ "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.35.0.tgz", "integrity": "sha512-kg6oI4g+vc41vePJyO6dHt/yl0Rz3Thv0kJeVQ3D1kS3E5XSuKbPc29G4IpT/Kv1KQwgHVcN+HtyS+HYLNSvQg==", "license": "MIT", + "peer": true, "dependencies": { "@types/estree": "1.0.6" }, @@ -8447,6 +8461,7 @@ "resolved": "https://registry.npmjs.org/vite/-/vite-6.3.4.tgz", "integrity": "sha512-BiReIiMS2fyFqbqNT/Qqt4CVITDU9M9vE+DKcVAsB+ZV0wvTKd+3hMbkpxz1b+NmEDMegpVbisKiAZOnvO92Sw==", "license": "MIT", + "peer": true, "dependencies": { "esbuild": "^0.25.0", "fdir": "^6.4.4", @@ -8733,6 +8748,7 @@ "resolved": "https://registry.npmjs.org/zod/-/zod-3.24.2.tgz", "integrity": "sha512-lY7CDW43ECgW9u1TcT3IoXHflywfVqDYze4waEz812jR/bZ8FHDsl7pFQoSZTz5N+2NqRXs8GBwnAwo3ZNxqhQ==", "license": "MIT", + "peer": true, "funding": { "url": "https://github.com/sponsors/colinhacks" } diff --git a/public/usage-examples/generative_ai/generate-convo-1-example-oop.cs b/public/usage-examples/generative_ai/generate-convo-1-example-oop.cs new file mode 100644 index 000000000..93b623ca5 --- /dev/null +++ b/public/usage-examples/generative_ai/generate-convo-1-example-oop.cs @@ -0,0 +1,68 @@ +// Simple Terminal AI Conversation - OOP C# Example +// This example uses a class structure + +using SplashKitSDK; + +class AIConversation +{ + // Main entry point + static void Main() + { + // Create an instance of the conversation class + AIConversation conversation = new AIConversation(); + + // Run the conversation + conversation.Start(); + } + + // Method to start the conversation loop + public void Start() + { + // Display welcome message + SplashKit.ClearScreen(); + SplashKit.WriteLine("=== Terminal AI Conversation ==="); + SplashKit.WriteLine("Type your message and press Enter to chat with AI"); + SplashKit.WriteLine("Type 'quit' to exit"); + SplashKit.WriteLine(""); + + // Continue conversation until user quits + while (true) + { + string userMessage = GetUserInput(); + + // Check if user wants to quit + if (userMessage == "quit") + { + SplashKit.WriteLine("Goodbye!"); + break; + } + + // Skip empty messages + if (string.IsNullOrWhiteSpace(userMessage)) + { + continue; + } + + // Get and display AI response + DisplayAIResponse(userMessage); + } + } + + // Method to get user input + private string GetUserInput() + { + SplashKit.Write("You: "); + return SplashKit.ReadLine(); + } + + // Method to generate and display AI response + private void DisplayAIResponse(string userMessage) + { + // Generate AI response using generate_text() + string aiResponse = SplashKit.GenerateText(userMessage); + + // Display the response + SplashKit.WriteLine("AI: " + aiResponse); + SplashKit.WriteLine(""); + } +} diff --git a/public/usage-examples/generative_ai/generate-convo-1-example-top-level.cs b/public/usage-examples/generative_ai/generate-convo-1-example-top-level.cs new file mode 100644 index 000000000..f3d430ebc --- /dev/null +++ b/public/usage-examples/generative_ai/generate-convo-1-example-top-level.cs @@ -0,0 +1,41 @@ +// Simple Terminal AI Conversation - Top-Level C# Example +// This example uses top-level statements (C# 9+) + +using SplashKitSDK; + +// Display welcome message +SplashKit.ClearScreen(); +SplashKit.WriteLine("=== Terminal AI Conversation ==="); +SplashKit.WriteLine("Type your message and press Enter to chat with AI"); +SplashKit.WriteLine("Type 'quit' to exit"); +SplashKit.WriteLine(""); + +string userMessage; + +// Simple conversation loop +while (true) +{ + // Get user input + SplashKit.Write("You: "); + userMessage = SplashKit.ReadLine(); + + // Check if user wants to quit + if (userMessage == "quit") + { + SplashKit.WriteLine("Goodbye!"); + break; + } + + // Skip empty messages + if (string.IsNullOrWhiteSpace(userMessage)) + { + continue; + } + + // Generate AI response using generate_text() + string aiResponse = SplashKit.GenerateText(userMessage); + + // Display AI response + SplashKit.WriteLine("AI: " + aiResponse); + SplashKit.WriteLine(""); +} diff --git a/public/usage-examples/generative_ai/generate-convo-1-example.cpp b/public/usage-examples/generative_ai/generate-convo-1-example.cpp new file mode 100644 index 000000000..1b9c1211c --- /dev/null +++ b/public/usage-examples/generative_ai/generate-convo-1-example.cpp @@ -0,0 +1,48 @@ +#include "splashkit.h" +#include +#include + +int main() +{ + // Initialize SplashKit + open_window("AI Conversation Example", 800, 600); + + // Display welcome message + write_line("=== Terminal AI Conversation ==="); + write_line("Type your message and press Enter to chat with AI"); + write_line("Type 'quit' to exit"); + write_line(""); + + std::string user_message; + + // Simple conversation loop + while (true) + { + // Get user input + write("You: "); + user_message = read_line(); + + // Check if user wants to quit + if (user_message == "quit") + { + write_line("Goodbye!"); + break; + } + + // Skip empty messages + if (user_message.empty()) + { + continue; + } + + // Generate AI response using generate_text() + std::string ai_response = generate_text(user_message); + + // Display AI response + write_line("AI: " + ai_response); + write_line(""); + } + + close_window("AI Conversation Example"); + return 0; +} diff --git a/public/usage-examples/generative_ai/generate-convo-1-example.py b/public/usage-examples/generative_ai/generate-convo-1-example.py new file mode 100644 index 000000000..a99cf5584 --- /dev/null +++ b/public/usage-examples/generative_ai/generate-convo-1-example.py @@ -0,0 +1,38 @@ +# Simple Terminal AI Conversation - Python Example + +from splashkit import * + +def main(): + """Main function to run the AI conversation""" + + # Display welcome message + clear_screen() + print("=== Terminal AI Conversation ===") + print("Type your message and press Enter to chat with AI") + print("Type 'quit' to exit") + print("") + + # Simple conversation loop + while True: + # Get user input + user_message = input("You: ") + + # Check if user wants to quit + if user_message.lower() == "quit": + print("Goodbye!") + break + + # Skip empty messages + if not user_message.strip(): + continue + + # Generate AI response using generate_text() + ai_response = generate_text(user_message) + + # Display AI response + print(f"AI: {ai_response}") + print("") + +# Run the program +if __name__ == "__main__": + main() diff --git a/public/usage-examples/generative_ai/generate-convo-1-example.txt b/public/usage-examples/generative_ai/generate-convo-1-example.txt new file mode 100644 index 000000000..0e4766784 --- /dev/null +++ b/public/usage-examples/generative_ai/generate-convo-1-example.txt @@ -0,0 +1,72 @@ +Simple Terminal AI Conversation Example +======================================== + +Overview +-------- +This example demonstrates how to create a simple terminal-based AI conversation +using the generate_text() function from SplashKit. + +How It Works +----------- +1. The program displays a welcome message +2. User types a message and presses Enter +3. The message is sent to generate_text() +4. The AI response is printed in the terminal +5. The user can continue the conversation or type 'quit' to exit + +Key Concepts +----------- +- Input/Output: Reading user input and displaying responses +- generate_text(): The SplashKit function that generates AI responses +- Loops: Using a while loop to maintain the conversation +- String Handling: Working with text input and output + +Code Flow +--------- +Welcome Message + ↓ +Loop Start + ↓ +Get User Input + ↓ +Check for 'quit' + ↓ +Generate AI Response + ↓ +Display Response + ↓ +Loop Back (until user types 'quit') + +Example Usage +----------- +=== Terminal AI Conversation === +Type your message and press Enter to chat with AI +Type 'quit' to exit + +You: Hello, how are you? +AI: I'm doing well, thank you for asking! How can I assist you today? + +You: What is SplashKit? +AI: SplashKit is a cross-platform C++ library that makes it easy to learn + and teach programming through games and multimedia applications. + +You: quit +Goodbye! + +Files Included +-------------- +1. generate-convo-1-example.cpp - C++ version +2. generate-convo-1-example-top-level.cs - C# top-level statements version +3. generate-convo-1-example-oop.cs - C# object-oriented version +4. generate-convo-1-example.py - Python version +5. generate-convo-1-example.txt - This documentation file + +Learning Tips +------------- +- Start with the Python version if you're new to programming +- The top-level C# version is good for understanding basic structure +- The OOP versions show how to organize code into reusable methods +- Try modifying the program to add new features like: + * Saving conversation history + * Adding more elaborate welcome messages + * Creating a conversation history log diff --git a/scripts/json-files/api.json b/scripts/json-files/api.json index c0ac71b90..fcea28e95 100644 --- a/scripts/json-files/api.json +++ b/scripts/json-files/api.json @@ -43,12 +43,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def animation_count(script):" - ], "cpp": [ "int animation_count(animation_script script)" ], + "python": [ + "def animation_count(script):" + ], "csharp": [ "public int AnimationScript.AnimationCount { get }", "public static int SplashKit.AnimationCount(AnimationScript script);" @@ -98,12 +98,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def animation_current_cell(anim):" - ], "cpp": [ "int animation_current_cell(animation anim)" ], + "python": [ + "def animation_current_cell(anim):" + ], "csharp": [ "public int Animation.CurrentCell { get }", "public static int SplashKit.AnimationCurrentCell(Animation anim);" @@ -153,12 +153,12 @@ "self": "anim" }, "signatures": { - "python": [ - "def animation_current_vector(anim):" - ], "cpp": [ "vector_2d animation_current_vector(animation anim)" ], + "python": [ + "def animation_current_vector(anim):" + ], "csharp": [ "public Vector2D Animation.CurrentVector { get }", "public static Vector2D SplashKit.AnimationCurrentVector(Animation anim);" @@ -208,12 +208,12 @@ "self": "anim" }, "signatures": { - "python": [ - "def animation_ended(anim):" - ], "cpp": [ "bool animation_ended(animation anim)" ], + "python": [ + "def animation_ended(anim):" + ], "csharp": [ "public bool Animation.Ended { get }", "public static bool SplashKit.AnimationEnded(Animation anim);" @@ -263,12 +263,12 @@ "self": "anim" }, "signatures": { - "python": [ - "def animation_entered_frame(anim):" - ], "cpp": [ "bool animation_entered_frame(animation anim)" ], + "python": [ + "def animation_entered_frame(anim):" + ], "csharp": [ "public bool Animation.EnteredFrame { get }", "public static bool SplashKit.AnimationEnteredFrame(Animation anim);" @@ -318,12 +318,12 @@ "self": "anim" }, "signatures": { - "python": [ - "def animation_frame_time(anim):" - ], "cpp": [ "float animation_frame_time(animation anim)" ], + "python": [ + "def animation_frame_time(anim):" + ], "csharp": [ "public float Animation.FrameTime { get }", "public static float SplashKit.AnimationFrameTime(Animation anim);" @@ -386,12 +386,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def animation_index(script, name):" - ], "cpp": [ "int animation_index(animation_script script, const string &name)" ], + "python": [ + "def animation_index(script, name):" + ], "csharp": [ "public int AnimationScript.AnimationIndex(string name);", "public static int SplashKit.AnimationIndex(AnimationScript script, string name);" @@ -441,12 +441,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def animation_name(temp):" - ], "cpp": [ "string animation_name(animation temp)" ], + "python": [ + "def animation_name(temp):" + ], "csharp": [ "public string Animation.Name { get }", "public static string SplashKit.AnimationName(Animation temp);" @@ -496,12 +496,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def animation_script_name(script):" - ], "cpp": [ "string animation_script_name(animation_script script)" ], + "python": [ + "def animation_script_name(script):" + ], "csharp": [ "public string AnimationScript.Name { get }", "public static string SplashKit.AnimationScriptName(AnimationScript script);" @@ -548,12 +548,12 @@ "group": "animations" }, "signatures": { - "python": [ - "def animation_script_named(name):" - ], "cpp": [ "animation_script animation_script_named(const string &name)" ], + "python": [ + "def animation_script_named(name):" + ], "csharp": [ "public static AnimationScript SplashKit.AnimationScriptNamed(string name);" ], @@ -629,12 +629,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def assign_animation_with_script(anim, script, name):" - ], "cpp": [ "void assign_animation(animation anim, animation_script script, const string &name)" ], + "python": [ + "def assign_animation_with_script(anim, script, name):" + ], "csharp": [ "public void Animation.Assign(AnimationScript script, string name);", "public static void SplashKit.AssignAnimation(Animation anim, AnimationScript script, string name);" @@ -724,12 +724,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def assign_animation_with_script_and_sound(anim, script, name, with_sound):" - ], "cpp": [ "void assign_animation(animation anim, animation_script script, const string &name, bool with_sound)" ], + "python": [ + "def assign_animation_with_script_and_sound(anim, script, name, with_sound):" + ], "csharp": [ "public void Animation.Assign(AnimationScript script, string name, bool withSound);", "public static void SplashKit.AssignAnimation(Animation anim, AnimationScript script, string name, bool withSound);" @@ -806,12 +806,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def assign_animation_index_with_script(anim, script, idx):" - ], "cpp": [ "void assign_animation(animation anim, animation_script script, int idx)" ], + "python": [ + "def assign_animation_index_with_script(anim, script, idx):" + ], "csharp": [ "public void Animation.Assign(AnimationScript script, int idx);", "public static void SplashKit.AssignAnimation(Animation anim, AnimationScript script, int idx);" @@ -901,12 +901,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def assign_animation_index_with_script_and_sound(anim, script, idx, with_sound):" - ], "cpp": [ "void assign_animation(animation anim, animation_script script, int idx, bool with_sound)" ], + "python": [ + "def assign_animation_index_with_script_and_sound(anim, script, idx, with_sound):" + ], "csharp": [ "public void Animation.Assign(AnimationScript script, int idx, bool withSound);", "public static void SplashKit.AssignAnimation(Animation anim, AnimationScript script, int idx, bool withSound);" @@ -983,12 +983,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def assign_animation_with_script_named(anim, script_name, name):" - ], "cpp": [ "void assign_animation(animation anim, const string &script_name, const string &name)" ], + "python": [ + "def assign_animation_with_script_named(anim, script_name, name):" + ], "csharp": [ "public void Animation.Assign(string scriptName, string name);", "public static void SplashKit.AssignAnimation(Animation anim, string scriptName, string name);" @@ -1078,12 +1078,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def assign_animation_with_script_named_and_sound(anim, script_name, name, with_sound):" - ], "cpp": [ "void assign_animation(animation anim, const string &script_name, const string &name, bool with_sound)" ], + "python": [ + "def assign_animation_with_script_named_and_sound(anim, script_name, name, with_sound):" + ], "csharp": [ "public void Animation.Assign(string scriptName, string name, bool withSound);", "public static void SplashKit.AssignAnimation(Animation anim, string scriptName, string name, bool withSound);" @@ -1147,12 +1147,12 @@ "self": "anim" }, "signatures": { - "python": [ - "def assign_animation_index(anim, idx):" - ], "cpp": [ "void assign_animation(animation anim, int idx)" ], + "python": [ + "def assign_animation_index(anim, idx):" + ], "csharp": [ "public void Animation.Assign(int idx);", "public static void SplashKit.AssignAnimation(Animation anim, int idx);" @@ -1229,12 +1229,12 @@ "self": "anim" }, "signatures": { - "python": [ - "def assign_animation_index_with_sound(anim, idx, with_sound):" - ], "cpp": [ "void assign_animation(animation anim, int idx, bool with_sound)" ], + "python": [ + "def assign_animation_index_with_sound(anim, idx, with_sound):" + ], "csharp": [ "public void Animation.Assign(int idx, bool withSound);", "public static void SplashKit.AssignAnimation(Animation anim, int idx, bool withSound);" @@ -1297,12 +1297,12 @@ "self": "anim" }, "signatures": { - "python": [ - "def assign_animation(anim, name):" - ], "cpp": [ "void assign_animation(animation anim, string name)" ], + "python": [ + "def assign_animation(anim, name):" + ], "csharp": [ "public void Animation.Assign(string name);", "public static void SplashKit.AssignAnimation(Animation anim, string name);" @@ -1379,12 +1379,12 @@ "self": "anim" }, "signatures": { - "python": [ - "def assign_animation_with_sound(anim, name, with_sound):" - ], "cpp": [ "void assign_animation(animation anim, string name, bool with_sound)" ], + "python": [ + "def assign_animation_with_sound(anim, name, with_sound):" + ], "csharp": [ "public void Animation.Assign(string name, bool withSound);", "public static void SplashKit.AssignAnimation(Animation anim, string name, bool withSound);" @@ -1458,12 +1458,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def create_animation_from_index_with_sound(script, idx, with_sound):" - ], "cpp": [ "animation create_animation(animation_script script, int idx, bool with_sound)" ], + "python": [ + "def create_animation_from_index_with_sound(script, idx, with_sound):" + ], "csharp": [ "public static Animation SplashKit.CreateAnimation(AnimationScript script, int idx, bool withSound);" ], @@ -1525,12 +1525,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def create_animation(script, name):" - ], "cpp": [ "animation create_animation(animation_script script, const string &name)" ], + "python": [ + "def create_animation(script, name):" + ], "csharp": [ "public Animation AnimationScript.CreateAnimation(string name);", "public static Animation SplashKit.CreateAnimation(AnimationScript script, string name);" @@ -1607,12 +1607,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def create_animation_with_sound(script, name, with_sound):" - ], "cpp": [ "animation create_animation(animation_script script, const string &name, bool with_sound)" ], + "python": [ + "def create_animation_with_sound(script, name, with_sound):" + ], "csharp": [ "public Animation AnimationScript.CreateAnimation(string name, bool withSound);", "public static Animation SplashKit.CreateAnimation(AnimationScript script, string name, bool withSound);" @@ -1673,12 +1673,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def create_animation_from_script_named(script_name, name):" - ], "cpp": [ "animation create_animation(const string &script_name, const string &name)" ], + "python": [ + "def create_animation_from_script_named(script_name, name):" + ], "csharp": [ "public static Animation SplashKit.CreateAnimation(string scriptName, string name);" ], @@ -1751,12 +1751,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def create_animation_from_script_named_with_sound(script_name, name, with_sound):" - ], "cpp": [ "animation create_animation(const string &script_name, const string &name, bool with_sound)" ], + "python": [ + "def create_animation_from_script_named_with_sound(script_name, name, with_sound):" + ], "csharp": [ "public static Animation SplashKit.CreateAnimation(string scriptName, string name, bool withSound);" ], @@ -1790,12 +1790,12 @@ "group": "animations" }, "signatures": { - "python": [ - "def free_all_animation_scripts():" - ], "cpp": [ "void free_all_animation_scripts()" ], + "python": [ + "def free_all_animation_scripts():" + ], "csharp": [ "public static void Animation.FreeAll();", "public static void SplashKit.FreeAllAnimationScripts();" @@ -1808,9 +1808,9 @@ { "signature": "void free_animation(animation ani);", "name": "free_animation", - "method_name": "free", + "method_name": null, "unique_global_name": "free_animation", - "unique_method_name": "animation.free", + "unique_method_name": null, "suffix_name": null, "description": "Disposes of the resources used in the animation.", "brief": null, @@ -1840,20 +1840,18 @@ "attributes": { "class": "animation", "destructor": true, - "method": "free", "self": "ani", "group": "animations", "static": "animation" }, "signatures": { - "python": [ - "def free_animation(ani):" - ], "cpp": [ "void free_animation(animation ani)" ], + "python": [ + "def free_animation(ani):" + ], "csharp": [ - "public void Animation.Free();", "public static void SplashKit.FreeAnimation(Animation ani);" ], "pascal": [ @@ -1864,9 +1862,9 @@ { "signature": "void free_animation_script(animation_script script_to_free);", "name": "free_animation_script", - "method_name": "free", + "method_name": null, "unique_global_name": "free_animation_script", - "unique_method_name": "animation_script.free", + "unique_method_name": null, "suffix_name": null, "description": "Frees loaded animation frames data. Use this when you will no\nlonger be using the animation for any purpose, including within\nsprite.", "brief": null, @@ -1896,20 +1894,18 @@ "attributes": { "class": "animation_script", "destructor": true, - "method": "free", "self": "script_to_free", "group": "animations", "static": "animation" }, "signatures": { - "python": [ - "def free_animation_script(script_to_free):" - ], "cpp": [ "void free_animation_script(animation_script script_to_free)" ], + "python": [ + "def free_animation_script(script_to_free):" + ], "csharp": [ - "public void AnimationScript.Free();", "public static void SplashKit.FreeAnimationScript(AnimationScript scriptToFree);" ], "pascal": [ @@ -1955,12 +1951,12 @@ "group": "animations" }, "signatures": { - "python": [ - "def free_animation_script_with_name(name):" - ], "cpp": [ "void free_animation_script(const string &name)" ], + "python": [ + "def free_animation_script_with_name(name):" + ], "csharp": [ "public static void SplashKit.FreeAnimationScript(string name);" ], @@ -2021,12 +2017,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def has_animation_named(script, name):" - ], "cpp": [ "bool has_animation_named(animation_script script, const string &name)" ], + "python": [ + "def has_animation_named(script, name):" + ], "csharp": [ "public static bool SplashKit.HasAnimationNamed(AnimationScript script, string name);" ], @@ -2072,12 +2068,12 @@ "group": "animations" }, "signatures": { - "python": [ - "def has_animation_script(name):" - ], "cpp": [ "bool has_animation_script(const string &name)" ], + "python": [ + "def has_animation_script(name):" + ], "csharp": [ "public static bool SplashKit.HasAnimationScript(string name);" ], @@ -2138,12 +2134,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def load_animation_script(name, filename):" - ], "cpp": [ "animation_script load_animation_script(const string &name, const string &filename)" ], + "python": [ + "def load_animation_script(name, filename):" + ], "csharp": [ "public static AnimationScript SplashKit.LoadAnimationScript(string name, string filename);", "public AnimationScript(string name, string filename);" @@ -2193,12 +2189,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def restart_animation(anim):" - ], "cpp": [ "void restart_animation(animation anim)" ], + "python": [ + "def restart_animation(anim):" + ], "csharp": [ "public void Animation.Restart();", "public static void SplashKit.RestartAnimation(Animation anim);" @@ -2262,12 +2258,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def restart_animation_with_sound(anim, with_sound):" - ], "cpp": [ "void restart_animation(animation anim, bool with_sound)" ], + "python": [ + "def restart_animation_with_sound(anim, with_sound):" + ], "csharp": [ "public void Animation.Restart(bool withSound);", "public static void SplashKit.RestartAnimation(Animation anim, bool withSound);" @@ -2341,12 +2337,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def update_animation_percent_with_sound(anim, pct, with_sound):" - ], "cpp": [ "void update_animation(animation anim, float pct, bool with_sound)" ], + "python": [ + "def update_animation_percent_with_sound(anim, pct, with_sound):" + ], "csharp": [ "public static void SplashKit.UpdateAnimation(Animation anim, float pct, bool withSound);" ], @@ -2395,12 +2391,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def update_animation(anim):" - ], "cpp": [ "void update_animation(animation anim)" ], + "python": [ + "def update_animation(anim):" + ], "csharp": [ "public void Animation.Update();", "public static void SplashKit.UpdateAnimation(Animation anim);" @@ -2464,12 +2460,12 @@ "static": "animation" }, "signatures": { - "python": [ - "def update_animation_percent(anim, pct):" - ], "cpp": [ "void update_animation(animation anim, float pct)" ], + "python": [ + "def update_animation_percent(anim, pct):" + ], "csharp": [ "public void Animation.Update(float pct);", "public static void SplashKit.UpdateAnimation(Animation anim, float pct);" @@ -2522,12 +2518,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def audio_ready():" - ], "cpp": [ "bool audio_ready()" ], + "python": [ + "def audio_ready():" + ], "csharp": [ "public static bool Audio.IsReady { get }", "public static bool SplashKit.AudioReady();" @@ -2561,12 +2557,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def close_audio():" - ], "cpp": [ "void close_audio()" ], + "python": [ + "def close_audio():" + ], "csharp": [ "public static void SplashKit.CloseAudio();" ], @@ -2599,12 +2595,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def open_audio():" - ], "cpp": [ "void open_audio()" ], + "python": [ + "def open_audio():" + ], "csharp": [ "public static void SplashKit.OpenAudio();" ], @@ -2664,12 +2660,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def fade_music_in_named(name, ms):" - ], "cpp": [ "void fade_music_in(const string &name, int ms)" ], + "python": [ + "def fade_music_in_named(name, ms):" + ], "csharp": [ "public static void SplashKit.FadeMusicIn(string name, int ms);" ], @@ -2742,12 +2738,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def fade_music_in_named_with_times(name, times, ms):" - ], "cpp": [ "void fade_music_in(const string &name, int times, int ms)" ], + "python": [ + "def fade_music_in_named_with_times(name, times, ms):" + ], "csharp": [ "public static void SplashKit.FadeMusicIn(string name, int times, int ms);" ], @@ -2809,12 +2805,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def fade_music_in(data, ms):" - ], "cpp": [ "void fade_music_in(music data, int ms)" ], + "python": [ + "def fade_music_in(data, ms):" + ], "csharp": [ "public void Music.FadeIn(int ms);", "public static void SplashKit.FadeMusicIn(Music data, int ms);" @@ -2891,12 +2887,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def fade_music_in_with_times(data, times, ms):" - ], "cpp": [ "void fade_music_in(music data, int times, int ms)" ], + "python": [ + "def fade_music_in_with_times(data, times, ms):" + ], "csharp": [ "public void Music.FadeIn(int times, int ms);", "public static void SplashKit.FadeMusicIn(Music data, int times, int ms);" @@ -2944,12 +2940,12 @@ "group": "audio" }, "signatures": { - "python": [ - "def fade_music_out(ms):" - ], "cpp": [ "void fade_music_out(int ms)" ], + "python": [ + "def fade_music_out(ms):" + ], "csharp": [ "public static void Audio.FadeOut(int ms);", "public static void SplashKit.FadeMusicOut(int ms);" @@ -2984,12 +2980,12 @@ "group": "audio" }, "signatures": { - "python": [ - "def free_all_music():" - ], "cpp": [ "void free_all_music()" ], + "python": [ + "def free_all_music():" + ], "csharp": [ "public static void Audio.FreeAllMusic();", "public static void SplashKit.FreeAllMusic();" @@ -3002,9 +2998,9 @@ { "signature": "void free_music(music effect);", "name": "free_music", - "method_name": "free", + "method_name": null, "unique_global_name": "free_music", - "unique_method_name": "music.free", + "unique_method_name": null, "suffix_name": null, "description": "Releases the SplashKit resources associated with music.", "brief": null, @@ -3034,20 +3030,18 @@ "attributes": { "class": "music", "destructor": true, - "method": "free", "self": "effect", "group": "audio", "static": "audio" }, "signatures": { - "python": [ - "def free_music(effect):" - ], "cpp": [ "void free_music(music effect)" ], + "python": [ + "def free_music(effect):" + ], "csharp": [ - "public void Music.Free();", "public static void SplashKit.FreeMusic(Music effect);" ], "pascal": [ @@ -3092,12 +3086,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def has_music(name):" - ], "cpp": [ "bool has_music(const string &name)" ], + "python": [ + "def has_music(name):" + ], "csharp": [ "public static bool SplashKit.HasMusic(string name);" ], @@ -3158,12 +3152,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def load_music(name, filename):" - ], "cpp": [ "music load_music(const string &name, const string &filename)" ], + "python": [ + "def load_music(name, filename):" + ], "csharp": [ "public static Music SplashKit.LoadMusic(string name, string filename);", "public Music(string name, string filename);" @@ -3213,12 +3207,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def music_filename(data):" - ], "cpp": [ "string music_filename(music data)" ], + "python": [ + "def music_filename(data):" + ], "csharp": [ "public string Music.Filename { get }", "public static string SplashKit.MusicFilename(Music data);" @@ -3268,12 +3262,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def music_name(data):" - ], "cpp": [ "string music_name(music data)" ], + "python": [ + "def music_name(data):" + ], "csharp": [ "public string Music.Name { get }", "public static string SplashKit.MusicName(Music data);" @@ -3320,57 +3314,17 @@ "static": "audio" }, "signatures": { - "python": [ - "def music_named(name):" - ], "cpp": [ "music music_named(const string &name)" ], - "csharp": [ - "public static Music SplashKit.MusicNamed(string name);" - ], - "pascal": [ - "function MusicNamed(const name: String): Music" - ] - } - }, - { - "signature": "bool music_paused();", - "name": "music_paused", - "method_name": null, - "unique_global_name": "music_paused", - "unique_method_name": null, - "suffix_name": null, - "description": "Checks whether music is currently paused.", - "brief": null, - "return": { - "type": "bool", - "description": "Returns true or false value representing whether music is currently paused.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "getter": "paused", - "static": "audio", - "group": "audio" - }, - "signatures": { "python": [ - "def music_paused():" - ], - "cpp": [ - "bool music_paused()" + "def music_named(name):" ], "csharp": [ - "public static bool Audio.Paused { get }", - "public static bool SplashKit.MusicPaused();" + "public static Music SplashKit.MusicNamed(string name);" ], "pascal": [ - "function MusicPaused(): Boolean" + "function MusicNamed(const name: String): Music" ] } }, @@ -3399,12 +3353,12 @@ "group": "audio" }, "signatures": { - "python": [ - "def music_playing():" - ], "cpp": [ "bool music_playing()" ], + "python": [ + "def music_playing():" + ], "csharp": [ "public static bool Audio.Playing { get }", "public static bool SplashKit.MusicPlaying();" @@ -3451,12 +3405,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def music_valid(m):" - ], "cpp": [ "bool music_valid(music m)" ], + "python": [ + "def music_valid(m):" + ], "csharp": [ "public static bool SplashKit.MusicValid(Music m);" ], @@ -3490,12 +3444,12 @@ "group": "audio" }, "signatures": { - "python": [ - "def music_volume():" - ], "cpp": [ "double music_volume()" ], + "python": [ + "def music_volume():" + ], "csharp": [ "public static double Audio.Volume { get }", "public static double SplashKit.MusicVolume();" @@ -3530,12 +3484,12 @@ "group": "audio" }, "signatures": { - "python": [ - "def pause_music():" - ], "cpp": [ "void pause_music()" ], + "python": [ + "def pause_music():" + ], "csharp": [ "public static void Audio.Pause();", "public static void SplashKit.PauseMusic();" @@ -3583,12 +3537,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def play_music_named(name):" - ], "cpp": [ "void play_music(const string &name)" ], + "python": [ + "def play_music_named(name):" + ], "csharp": [ "public static void SplashKit.PlayMusic(string name);" ], @@ -3648,12 +3602,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def play_music_named_with_times(name, times):" - ], "cpp": [ "void play_music(const string &name, int times)" ], + "python": [ + "def play_music_named_with_times(name, times):" + ], "csharp": [ "public static void SplashKit.PlayMusic(string name, int times);" ], @@ -3702,12 +3656,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def play_music(data):" - ], "cpp": [ "void play_music(music data)" ], + "python": [ + "def play_music(data):" + ], "csharp": [ "public void Music.Play();", "public static void SplashKit.PlayMusic(Music data);" @@ -3771,12 +3725,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def play_music_with_times(data, times):" - ], "cpp": [ "void play_music(music data, int times)" ], + "python": [ + "def play_music_with_times(data, times):" + ], "csharp": [ "public void Music.Play(int times);", "public static void SplashKit.PlayMusic(Music data, int times);" @@ -3853,12 +3807,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def play_music_with_times_and_volume(data, times, volume):" - ], "cpp": [ "void play_music(music data, int times, double volume)" ], + "python": [ + "def play_music_with_times_and_volume(data, times, volume):" + ], "csharp": [ "public void Music.Play(int times, double volume);", "public static void SplashKit.PlayMusic(Music data, int times, double volume);" @@ -3893,12 +3847,12 @@ "group": "audio" }, "signatures": { - "python": [ - "def resume_music():" - ], "cpp": [ "void resume_music()" ], + "python": [ + "def resume_music():" + ], "csharp": [ "public static void Audio.Resume();", "public static void SplashKit.ResumeMusic();" @@ -3946,12 +3900,12 @@ "group": "audio" }, "signatures": { - "python": [ - "def set_music_volume(volume):" - ], "cpp": [ "void set_music_volume(double volume)" ], + "python": [ + "def set_music_volume(volume):" + ], "csharp": [ "public static void Audio.Volume { set }", "public static void SplashKit.SetMusicVolume(double volume);" @@ -3986,12 +3940,12 @@ "group": "audio" }, "signatures": { - "python": [ - "def stop_music():" - ], "cpp": [ "void stop_music()" ], + "python": [ + "def stop_music():" + ], "csharp": [ "public static void Audio.Stop();", "public static void SplashKit.StopMusic();" @@ -4038,12 +3992,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def fade_all_sound_effects_out(ms):" - ], "cpp": [ "void fade_all_sound_effects_out(int ms)" ], + "python": [ + "def fade_all_sound_effects_out(ms):" + ], "csharp": [ "public static void SplashKit.FadeAllSoundEffectsOut(int ms);" ], @@ -4105,12 +4059,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def fade_sound_effect_out(effect, ms):" - ], "cpp": [ "void fade_sound_effect_out(sound_effect effect, int ms)" ], + "python": [ + "def fade_sound_effect_out(effect, ms):" + ], "csharp": [ "public void SoundEffect.FadeOut(int ms);", "public static void SplashKit.FadeSoundEffectOut(SoundEffect effect, int ms);" @@ -4144,12 +4098,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def free_all_sound_effects():" - ], "cpp": [ "void free_all_sound_effects()" ], + "python": [ + "def free_all_sound_effects():" + ], "csharp": [ "public static void SplashKit.FreeAllSoundEffects();" ], @@ -4199,12 +4153,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def free_sound_effect(effect):" - ], "cpp": [ "void free_sound_effect(sound_effect effect)" ], + "python": [ + "def free_sound_effect(effect):" + ], "csharp": [ "public void SoundEffect.Close();", "public static void SplashKit.FreeSoundEffect(SoundEffect effect);" @@ -4251,12 +4205,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def has_sound_effect(name):" - ], "cpp": [ "bool has_sound_effect(const string &name)" ], + "python": [ + "def has_sound_effect(name):" + ], "csharp": [ "public static bool SplashKit.HasSoundEffect(string name);" ], @@ -4317,12 +4271,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def load_sound_effect(name, filename):" - ], "cpp": [ "sound_effect load_sound_effect(const string &name, const string &filename)" ], + "python": [ + "def load_sound_effect(name, filename):" + ], "csharp": [ "public static SoundEffect SplashKit.LoadSoundEffect(string name, string filename);", "public SoundEffect(string name, string filename);" @@ -4370,12 +4324,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def play_sound_effect_named(name):" - ], "cpp": [ "void play_sound_effect(const string &name)" ], + "python": [ + "def play_sound_effect_named(name):" + ], "csharp": [ "public static void SplashKit.PlaySoundEffect(string name);" ], @@ -4435,12 +4389,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def play_sound_effect_named_with_volume(name, volume):" - ], "cpp": [ "void play_sound_effect(const string &name, double volume)" ], + "python": [ + "def play_sound_effect_named_with_volume(name, volume):" + ], "csharp": [ "public static void SplashKit.PlaySoundEffect(string name, double volume);" ], @@ -4500,12 +4454,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def play_sound_effect_named_with_times(name, times):" - ], "cpp": [ "void play_sound_effect(const string &name, int times)" ], + "python": [ + "def play_sound_effect_named_with_times(name, times):" + ], "csharp": [ "public static void SplashKit.PlaySoundEffect(string name, int times);" ], @@ -4578,12 +4532,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def play_sound_effect_named_with_times_and_volume(name, times, volume):" - ], "cpp": [ "void play_sound_effect(const string &name, int times, double volume)" ], + "python": [ + "def play_sound_effect_named_with_times_and_volume(name, times, volume):" + ], "csharp": [ "public static void SplashKit.PlaySoundEffect(string name, int times, double volume);" ], @@ -4632,12 +4586,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def play_sound_effect(effect):" - ], "cpp": [ "void play_sound_effect(sound_effect effect)" ], + "python": [ + "def play_sound_effect(effect):" + ], "csharp": [ "public void SoundEffect.Play();", "public static void SplashKit.PlaySoundEffect(SoundEffect effect);" @@ -4701,12 +4655,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def play_sound_effect_with_volume(effect, volume):" - ], "cpp": [ "void play_sound_effect(sound_effect effect, double volume)" ], + "python": [ + "def play_sound_effect_with_volume(effect, volume):" + ], "csharp": [ "public void SoundEffect.Play(double volume);", "public static void SplashKit.PlaySoundEffect(SoundEffect effect, double volume);" @@ -4770,12 +4724,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def play_sound_effect_with_times(effect, times):" - ], "cpp": [ "void play_sound_effect(sound_effect effect, int times)" ], + "python": [ + "def play_sound_effect_with_times(effect, times):" + ], "csharp": [ "public void SoundEffect.Play(int times);", "public static void SplashKit.PlaySoundEffect(SoundEffect effect, int times);" @@ -4852,12 +4806,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def play_sound_effect_with_times_and_volume(effect, times, volume):" - ], "cpp": [ "void play_sound_effect(sound_effect effect, int times, double volume)" ], + "python": [ + "def play_sound_effect_with_times_and_volume(effect, times, volume):" + ], "csharp": [ "public void SoundEffect.Play(int times, double volume);", "public static void SplashKit.PlaySoundEffect(SoundEffect effect, int times, double volume);" @@ -4907,12 +4861,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def sound_effect_filename(effect):" - ], "cpp": [ "string sound_effect_filename(sound_effect effect)" ], + "python": [ + "def sound_effect_filename(effect):" + ], "csharp": [ "public string SoundEffect.Filename { get }", "public static string SplashKit.SoundEffectFilename(SoundEffect effect);" @@ -4962,12 +4916,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def sound_effect_name(effect):" - ], "cpp": [ "string sound_effect_name(sound_effect effect)" ], + "python": [ + "def sound_effect_name(effect):" + ], "csharp": [ "public string SoundEffect.Name { get }", "public static string SplashKit.SoundEffectName(SoundEffect effect);" @@ -5014,12 +4968,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def sound_effect_named(name):" - ], "cpp": [ "sound_effect sound_effect_named(const string &name)" ], + "python": [ + "def sound_effect_named(name):" + ], "csharp": [ "public static SoundEffect SplashKit.SoundEffectNamed(string name);" ], @@ -5066,12 +5020,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def sound_effect_playing_named(name):" - ], "cpp": [ "bool sound_effect_playing(const string &name)" ], + "python": [ + "def sound_effect_playing_named(name):" + ], "csharp": [ "public static bool SplashKit.SoundEffectPlaying(string name);" ], @@ -5120,12 +5074,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def sound_effect_playing(effect):" - ], "cpp": [ "bool sound_effect_playing(sound_effect effect)" ], + "python": [ + "def sound_effect_playing(effect):" + ], "csharp": [ "public bool SoundEffect.IsPlaying { get }", "public static bool SplashKit.SoundEffectPlaying(SoundEffect effect);" @@ -5172,12 +5126,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def sound_effect_valid(effect):" - ], "cpp": [ "bool sound_effect_valid(sound_effect effect)" ], + "python": [ + "def sound_effect_valid(effect):" + ], "csharp": [ "public static bool SplashKit.SoundEffectValid(SoundEffect effect);" ], @@ -5224,12 +5178,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def stop_sound_effect_named(name):" - ], "cpp": [ "void stop_sound_effect(const string &name)" ], + "python": [ + "def stop_sound_effect_named(name):" + ], "csharp": [ "public static void SplashKit.StopSoundEffect(string name);" ], @@ -5278,12 +5232,12 @@ "static": "audio" }, "signatures": { - "python": [ - "def stop_sound_effect(effect):" - ], "cpp": [ "void stop_sound_effect(sound_effect effect)" ], + "python": [ + "def stop_sound_effect(effect):" + ], "csharp": [ "public void SoundEffect.Stop();", "public static void SplashKit.StopSoundEffect(SoundEffect effect);" @@ -5367,12 +5321,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def camera_position():" - ], "cpp": [ "point_2d camera_position()" ], + "python": [ + "def camera_position():" + ], "csharp": [ "public static Point2D Camera.Position { get }", "public static Point2D SplashKit.CameraPosition();" @@ -5407,12 +5361,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def camera_x():" - ], "cpp": [ "double camera_x()" ], + "python": [ + "def camera_x():" + ], "csharp": [ "public static double Camera.X { get }", "public static double SplashKit.CameraX();" @@ -5447,12 +5401,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def camera_y():" - ], "cpp": [ "double camera_y()" ], + "python": [ + "def camera_y():" + ], "csharp": [ "public static double Camera.Y { get }", "public static double SplashKit.CameraY();" @@ -5514,12 +5468,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def center_camera_on_vector(s, offset):" - ], "cpp": [ "void center_camera_on(sprite s, const vector_2d &offset)" ], + "python": [ + "def center_camera_on_vector(s, offset):" + ], "csharp": [ "public static void Camera.CenterOn(Sprite s, Vector2D offset);", "public static void SplashKit.CenterCameraOn(Sprite s, Vector2D offset);" @@ -5593,12 +5547,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def center_camera_on(s, offset_x, offset_y):" - ], "cpp": [ "void center_camera_on(sprite s, double offset_x, double offset_y)" ], + "python": [ + "def center_camera_on(s, offset_x, offset_y):" + ], "csharp": [ "public static void Camera.CenterOn(Sprite s, double offsetX, double offsetY);", "public static void SplashKit.CenterCameraOn(Sprite s, double offsetX, double offsetY);" @@ -5647,12 +5601,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def move_camera_by_vector(offset):" - ], "cpp": [ "void move_camera_by(const vector_2d &offset)" ], + "python": [ + "def move_camera_by_vector(offset):" + ], "csharp": [ "public static void Camera.MoveBy(Vector2D offset);", "public static void SplashKit.MoveCameraBy(Vector2D offset);" @@ -5713,12 +5667,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def move_camera_by(dx, dy):" - ], "cpp": [ "void move_camera_by(double dx, double dy)" ], + "python": [ + "def move_camera_by(dx, dy):" + ], "csharp": [ "public static void Camera.MoveBy(double dx, double dy);", "public static void SplashKit.MoveCameraBy(double dx, double dy);" @@ -5767,12 +5721,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def move_camera_to_point(pt):" - ], "cpp": [ "void move_camera_to(const point_2d &pt)" ], + "python": [ + "def move_camera_to_point(pt):" + ], "csharp": [ "public static void Camera.MoveTo(Point2D pt);", "public static void SplashKit.MoveCameraTo(Point2D pt);" @@ -5833,12 +5787,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def move_camera_to(x, y):" - ], "cpp": [ "void move_camera_to(double x, double y)" ], + "python": [ + "def move_camera_to(x, y):" + ], "csharp": [ "public static void Camera.MoveTo(double x, double y);", "public static void SplashKit.MoveCameraTo(double x, double y);" @@ -5899,12 +5853,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def point_in_window(wind, pt):" - ], "cpp": [ "bool point_in_window(window wind, const point_2d &pt)" ], + "python": [ + "def point_in_window(wind, pt):" + ], "csharp": [ "public static bool Camera.PointInWindow(Window wind, Point2D pt);", "public static bool SplashKit.PointInWindow(Window wind, Point2D pt);" @@ -5952,12 +5906,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def point_on_screen(pt):" - ], "cpp": [ "bool point_on_screen(const point_2d &pt)" ], + "python": [ + "def point_on_screen(pt):" + ], "csharp": [ "public static bool Camera.PointOnScreen(Point2D pt);", "public static bool SplashKit.PointOnScreen(Point2D pt);" @@ -6018,12 +5972,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def rect_in_window(wind, rect):" - ], "cpp": [ "bool rect_in_window(window wind, const rectangle &rect)" ], + "python": [ + "def rect_in_window(wind, rect):" + ], "csharp": [ "public static bool Camera.RectInWindow(Window wind, Rectangle rect);", "public static bool SplashKit.RectInWindow(Window wind, Rectangle rect);" @@ -6071,12 +6025,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def rect_on_screen(rect):" - ], "cpp": [ "bool rect_on_screen(const rectangle &rect)" ], + "python": [ + "def rect_on_screen(rect):" + ], "csharp": [ "public static bool Camera.RectOnScreen(Rectangle rect);", "public static bool SplashKit.RectOnScreen(Rectangle rect);" @@ -6111,12 +6065,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def screen_center():" - ], "cpp": [ "point_2d screen_center()" ], + "python": [ + "def screen_center():" + ], "csharp": [ "public static Point2D Camera.ScreenCenter { get }", "public static Point2D SplashKit.ScreenCenter();" @@ -6151,12 +6105,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def screen_rectangle():" - ], "cpp": [ "rectangle screen_rectangle()" ], + "python": [ + "def screen_rectangle():" + ], "csharp": [ "public static Rectangle Camera.ScreenRectangle { get }", "public static Rectangle SplashKit.ScreenRectangle();" @@ -6204,12 +6158,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def set_camera_position(pos):" - ], "cpp": [ "void set_camera_position(point_2d pos)" ], + "python": [ + "def set_camera_position(pos):" + ], "csharp": [ "public static void Camera.Position { set }", "public static void SplashKit.SetCameraPosition(Point2D pos);" @@ -6257,12 +6211,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def set_camera_x(x):" - ], "cpp": [ "void set_camera_x(double x)" ], + "python": [ + "def set_camera_x(x):" + ], "csharp": [ "public static void Camera.X { set }", "public static void SplashKit.SetCameraX(double x);" @@ -6310,12 +6264,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def set_camera_y(y):" - ], "cpp": [ "void set_camera_y(double y)" ], + "python": [ + "def set_camera_y(y):" + ], "csharp": [ "public static void Camera.Y { set }", "public static void SplashKit.SetCameraY(double y);" @@ -6364,12 +6318,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def to_screen_point(pt):" - ], "cpp": [ "point_2d to_screen(const point_2d &pt)" ], + "python": [ + "def to_screen_point(pt):" + ], "csharp": [ "public static Point2D Camera.ToScreen(Point2D pt);", "public static Point2D SplashKit.ToScreen(Point2D pt);" @@ -6418,12 +6372,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def to_screen_rectangle(rect):" - ], "cpp": [ "rectangle to_screen(const rectangle &rect)" ], + "python": [ + "def to_screen_rectangle(rect):" + ], "csharp": [ "public static Rectangle Camera.ToScreen(Rectangle rect);", "public static Rectangle SplashKit.ToScreen(Rectangle rect);" @@ -6471,12 +6425,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def to_screen_x(world_x):" - ], "cpp": [ "double to_screen_x(double world_x)" ], + "python": [ + "def to_screen_x(world_x):" + ], "csharp": [ "public static double Camera.ToScreenX(double worldX);", "public static double SplashKit.ToScreenX(double worldX);" @@ -6524,12 +6478,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def to_screen_y(world_y):" - ], "cpp": [ "double to_screen_y(double world_y)" ], + "python": [ + "def to_screen_y(world_y):" + ], "csharp": [ "public static double Camera.ToScreenY(double worldY);", "public static double SplashKit.ToScreenY(double worldY);" @@ -6577,12 +6531,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def to_world(pt):" - ], "cpp": [ "point_2d to_world(const point_2d &pt)" ], + "python": [ + "def to_world(pt):" + ], "csharp": [ "public static Point2D Camera.ToWorld(Point2D pt);", "public static Point2D SplashKit.ToWorld(Point2D pt);" @@ -6630,12 +6584,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def to_world_x(screen_x):" - ], "cpp": [ "double to_world_x(double screen_x)" ], + "python": [ + "def to_world_x(screen_x):" + ], "csharp": [ "public static double Camera.ToWorldX(double screenX);", "public static double SplashKit.ToWorldX(double screenX);" @@ -6683,12 +6637,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def to_world_y(screen_y):" - ], "cpp": [ "double to_world_y(double screen_y)" ], + "python": [ + "def to_world_y(screen_y):" + ], "csharp": [ "public static double Camera.ToWorldY(double screenY);", "public static double SplashKit.ToWorldY(double screenY);" @@ -6723,12 +6677,12 @@ "static": "camera" }, "signatures": { - "python": [ - "def vector_world_to_screen():" - ], "cpp": [ "vector_2d vector_world_to_screen()" ], + "python": [ + "def vector_world_to_screen():" + ], "csharp": [ "public static Vector2D Camera.VectorWorldToScreen { get }", "public static Vector2D SplashKit.VectorWorldToScreen();" @@ -6778,12 +6732,12 @@ "self": "wind" }, "signatures": { - "python": [ - "def window_area(wind):" - ], "cpp": [ "rectangle window_area(window wind)" ], + "python": [ + "def window_area(wind):" + ], "csharp": [ "public Rectangle Window.Area { get }", "public static Rectangle SplashKit.WindowArea(Window wind);" @@ -6847,12 +6801,12 @@ "group": "color" }, "signatures": { - "python": [ - "def alpha_of(c):" - ], "cpp": [ "int alpha_of(color c)" ], + "python": [ + "def alpha_of(c):" + ], "csharp": [ "public static int SplashKit.AlphaOf(Color c);" ], @@ -6897,12 +6851,12 @@ "group": "color" }, "signatures": { - "python": [ - "def blue_of(c):" - ], "cpp": [ "int blue_of(color c)" ], + "python": [ + "def blue_of(c):" + ], "csharp": [ "public static int SplashKit.BlueOf(Color c);" ], @@ -6947,12 +6901,12 @@ "group": "color" }, "signatures": { - "python": [ - "def brightness_of(c):" - ], "cpp": [ "double brightness_of(color c)" ], + "python": [ + "def brightness_of(c):" + ], "csharp": [ "public static double SplashKit.BrightnessOf(Color c);" ], @@ -6986,13 +6940,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_alice_blue():" - ], "cpp": [ "#define COLOR_ALICE_BLUE", "color color_alice_blue()" ], + "python": [ + "def color_alice_blue():" + ], "csharp": [ "public static Color Color.AliceBlue { get }", "public static Color SplashKit.ColorAliceBlue();" @@ -7027,13 +6981,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_antique_white():" - ], "cpp": [ "#define COLOR_ANTIQUE_WHITE", "color color_antique_white()" ], + "python": [ + "def color_antique_white():" + ], "csharp": [ "public static Color Color.AntiqueWhite { get }", "public static Color SplashKit.ColorAntiqueWhite();" @@ -7068,13 +7022,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_aqua():" - ], "cpp": [ "#define COLOR_AQUA", "color color_aqua()" ], + "python": [ + "def color_aqua():" + ], "csharp": [ "public static Color Color.Aqua { get }", "public static Color SplashKit.ColorAqua();" @@ -7109,13 +7063,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_aquamarine():" - ], "cpp": [ "#define COLOR_AQUAMARINE", "color color_aquamarine()" ], + "python": [ + "def color_aquamarine():" + ], "csharp": [ "public static Color Color.Aquamarine { get }", "public static Color SplashKit.ColorAquamarine();" @@ -7150,13 +7104,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_azure():" - ], "cpp": [ "#define COLOR_AZURE", "color color_azure()" ], + "python": [ + "def color_azure():" + ], "csharp": [ "public static Color Color.Azure { get }", "public static Color SplashKit.ColorAzure();" @@ -7191,13 +7145,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_beige():" - ], "cpp": [ "#define COLOR_BEIGE", "color color_beige()" ], + "python": [ + "def color_beige():" + ], "csharp": [ "public static Color Color.Beige { get }", "public static Color SplashKit.ColorBeige();" @@ -7232,13 +7186,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_bisque():" - ], "cpp": [ "#define COLOR_BISQUE", "color color_bisque()" ], + "python": [ + "def color_bisque():" + ], "csharp": [ "public static Color Color.Bisque { get }", "public static Color SplashKit.ColorBisque();" @@ -7273,13 +7227,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_black():" - ], "cpp": [ "#define COLOR_BLACK", "color color_black()" ], + "python": [ + "def color_black():" + ], "csharp": [ "public static Color Color.Black { get }", "public static Color SplashKit.ColorBlack();" @@ -7314,13 +7268,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_blanched_almond():" - ], "cpp": [ "#define COLOR_BLANCHED_ALMOND", "color color_blanched_almond()" ], + "python": [ + "def color_blanched_almond():" + ], "csharp": [ "public static Color Color.BlanchedAlmond { get }", "public static Color SplashKit.ColorBlanchedAlmond();" @@ -7355,13 +7309,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_blue():" - ], "cpp": [ "#define COLOR_BLUE", "color color_blue()" ], + "python": [ + "def color_blue():" + ], "csharp": [ "public static Color Color.Blue { get }", "public static Color SplashKit.ColorBlue();" @@ -7396,13 +7350,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_blue_violet():" - ], "cpp": [ "#define COLOR_BLUE_VIOLET", "color color_blue_violet()" ], + "python": [ + "def color_blue_violet():" + ], "csharp": [ "public static Color Color.BlueViolet { get }", "public static Color SplashKit.ColorBlueViolet();" @@ -7437,13 +7391,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_bright_green():" - ], "cpp": [ "#define COLOR_BRIGHT_GREEN", "color color_bright_green()" ], + "python": [ + "def color_bright_green():" + ], "csharp": [ "public static Color Color.BrightGreen { get }", "public static Color SplashKit.ColorBrightGreen();" @@ -7478,13 +7432,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_brown():" - ], "cpp": [ "#define COLOR_BROWN", "color color_brown()" ], + "python": [ + "def color_brown():" + ], "csharp": [ "public static Color Color.Brown { get }", "public static Color SplashKit.ColorBrown();" @@ -7519,13 +7473,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_burly_wood():" - ], "cpp": [ "#define COLOR_BURLY_WOOD", "color color_burly_wood()" ], + "python": [ + "def color_burly_wood():" + ], "csharp": [ "public static Color Color.BurlyWood { get }", "public static Color SplashKit.ColorBurlyWood();" @@ -7560,13 +7514,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_cadet_blue():" - ], "cpp": [ "#define COLOR_CADET_BLUE", "color color_cadet_blue()" ], + "python": [ + "def color_cadet_blue():" + ], "csharp": [ "public static Color Color.CadetBlue { get }", "public static Color SplashKit.ColorCadetBlue();" @@ -7601,13 +7555,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_chartreuse():" - ], "cpp": [ "#define COLOR_CHARTREUSE", "color color_chartreuse()" ], + "python": [ + "def color_chartreuse():" + ], "csharp": [ "public static Color Color.Chartreuse { get }", "public static Color SplashKit.ColorChartreuse();" @@ -7642,13 +7596,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_chocolate():" - ], "cpp": [ "#define COLOR_CHOCOLATE", "color color_chocolate()" ], + "python": [ + "def color_chocolate():" + ], "csharp": [ "public static Color Color.Chocolate { get }", "public static Color SplashKit.ColorChocolate();" @@ -7683,13 +7637,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_coral():" - ], "cpp": [ "#define COLOR_CORAL", "color color_coral()" ], + "python": [ + "def color_coral():" + ], "csharp": [ "public static Color Color.Coral { get }", "public static Color SplashKit.ColorCoral();" @@ -7724,13 +7678,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_cornflower_blue():" - ], "cpp": [ "#define COLOR_CORNFLOWER_BLUE", "color color_cornflower_blue()" ], + "python": [ + "def color_cornflower_blue():" + ], "csharp": [ "public static Color Color.CornflowerBlue { get }", "public static Color SplashKit.ColorCornflowerBlue();" @@ -7765,13 +7719,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_cornsilk():" - ], "cpp": [ "#define COLOR_CORNSILK", "color color_cornsilk()" ], + "python": [ + "def color_cornsilk():" + ], "csharp": [ "public static Color Color.Cornsilk { get }", "public static Color SplashKit.ColorCornsilk();" @@ -7806,13 +7760,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_crimson():" - ], "cpp": [ "#define COLOR_CRIMSON", "color color_crimson()" ], + "python": [ + "def color_crimson():" + ], "csharp": [ "public static Color Color.Crimson { get }", "public static Color SplashKit.ColorCrimson();" @@ -7847,13 +7801,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_cyan():" - ], "cpp": [ "#define COLOR_CYAN", "color color_cyan()" ], + "python": [ + "def color_cyan():" + ], "csharp": [ "public static Color Color.Cyan { get }", "public static Color SplashKit.ColorCyan();" @@ -7888,13 +7842,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_blue():" - ], "cpp": [ "#define COLOR_DARK_BLUE", "color color_dark_blue()" ], + "python": [ + "def color_dark_blue():" + ], "csharp": [ "public static Color Color.DarkBlue { get }", "public static Color SplashKit.ColorDarkBlue();" @@ -7929,13 +7883,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_cyan():" - ], "cpp": [ "#define COLOR_DARK_CYAN", "color color_dark_cyan()" ], + "python": [ + "def color_dark_cyan():" + ], "csharp": [ "public static Color Color.DarkCyan { get }", "public static Color SplashKit.ColorDarkCyan();" @@ -7970,13 +7924,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_goldenrod():" - ], "cpp": [ "#define COLOR_DARK_GOLDENROD", "color color_dark_goldenrod()" ], + "python": [ + "def color_dark_goldenrod():" + ], "csharp": [ "public static Color Color.DarkGoldenrod { get }", "public static Color SplashKit.ColorDarkGoldenrod();" @@ -8011,13 +7965,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_gray():" - ], "cpp": [ "#define COLOR_DARK_GRAY", "color color_dark_gray()" ], + "python": [ + "def color_dark_gray():" + ], "csharp": [ "public static Color Color.DarkGray { get }", "public static Color SplashKit.ColorDarkGray();" @@ -8052,13 +8006,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_green():" - ], "cpp": [ "#define COLOR_DARK_GREEN", "color color_dark_green()" ], + "python": [ + "def color_dark_green():" + ], "csharp": [ "public static Color Color.DarkGreen { get }", "public static Color SplashKit.ColorDarkGreen();" @@ -8093,13 +8047,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_khaki():" - ], "cpp": [ "#define COLOR_DARK_KHAKI", "color color_dark_khaki()" ], + "python": [ + "def color_dark_khaki():" + ], "csharp": [ "public static Color Color.DarkKhaki { get }", "public static Color SplashKit.ColorDarkKhaki();" @@ -8134,13 +8088,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_magenta():" - ], "cpp": [ "#define COLOR_DARK_MAGENTA", "color color_dark_magenta()" ], + "python": [ + "def color_dark_magenta():" + ], "csharp": [ "public static Color Color.DarkMagenta { get }", "public static Color SplashKit.ColorDarkMagenta();" @@ -8175,13 +8129,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_olive_green():" - ], "cpp": [ "#define COLOR_DARK_OLIVE_GREEN", "color color_dark_olive_green()" ], + "python": [ + "def color_dark_olive_green():" + ], "csharp": [ "public static Color Color.DarkOliveGreen { get }", "public static Color SplashKit.ColorDarkOliveGreen();" @@ -8216,13 +8170,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_orange():" - ], "cpp": [ "#define COLOR_DARK_ORANGE", "color color_dark_orange()" ], + "python": [ + "def color_dark_orange():" + ], "csharp": [ "public static Color Color.DarkOrange { get }", "public static Color SplashKit.ColorDarkOrange();" @@ -8257,13 +8211,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_orchid():" - ], "cpp": [ "#define COLOR_DARK_ORCHID", "color color_dark_orchid()" ], + "python": [ + "def color_dark_orchid():" + ], "csharp": [ "public static Color Color.DarkOrchid { get }", "public static Color SplashKit.ColorDarkOrchid();" @@ -8298,13 +8252,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_red():" - ], "cpp": [ "#define COLOR_DARK_RED", "color color_dark_red()" ], + "python": [ + "def color_dark_red():" + ], "csharp": [ "public static Color Color.DarkRed { get }", "public static Color SplashKit.ColorDarkRed();" @@ -8339,13 +8293,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_salmon():" - ], "cpp": [ "#define COLOR_DARK_SALMON", "color color_dark_salmon()" ], + "python": [ + "def color_dark_salmon():" + ], "csharp": [ "public static Color Color.DarkSalmon { get }", "public static Color SplashKit.ColorDarkSalmon();" @@ -8380,13 +8334,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_sea_green():" - ], "cpp": [ "#define COLOR_DARK_SEA_GREEN", "color color_dark_sea_green()" ], + "python": [ + "def color_dark_sea_green():" + ], "csharp": [ "public static Color Color.DarkSeaGreen { get }", "public static Color SplashKit.ColorDarkSeaGreen();" @@ -8421,13 +8375,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_slate_blue():" - ], "cpp": [ "#define COLOR_DARK_SLATE_BLUE", "color color_dark_slate_blue()" ], + "python": [ + "def color_dark_slate_blue():" + ], "csharp": [ "public static Color Color.DarkSlateBlue { get }", "public static Color SplashKit.ColorDarkSlateBlue();" @@ -8462,13 +8416,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_slate_gray():" - ], "cpp": [ "#define COLOR_DARK_SLATE_GRAY", "color color_dark_slate_gray()" ], + "python": [ + "def color_dark_slate_gray():" + ], "csharp": [ "public static Color Color.DarkSlateGray { get }", "public static Color SplashKit.ColorDarkSlateGray();" @@ -8503,13 +8457,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_turquoise():" - ], "cpp": [ "#define COLOR_DARK_TURQUOISE", "color color_dark_turquoise()" ], + "python": [ + "def color_dark_turquoise():" + ], "csharp": [ "public static Color Color.DarkTurquoise { get }", "public static Color SplashKit.ColorDarkTurquoise();" @@ -8544,13 +8498,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_violet():" - ], "cpp": [ "#define COLOR_DARK_VIOLET", "color color_dark_violet()" ], + "python": [ + "def color_dark_violet():" + ], "csharp": [ "public static Color Color.DarkViolet { get }", "public static Color SplashKit.ColorDarkViolet();" @@ -8585,13 +8539,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_deep_pink():" - ], "cpp": [ "#define COLOR_DEEP_PINK", "color color_deep_pink()" ], + "python": [ + "def color_deep_pink():" + ], "csharp": [ "public static Color Color.DeepPink { get }", "public static Color SplashKit.ColorDeepPink();" @@ -8626,13 +8580,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_deep_sky_blue():" - ], "cpp": [ "#define COLOR_DEEP_SKY_BLUE", "color color_deep_sky_blue()" ], + "python": [ + "def color_deep_sky_blue():" + ], "csharp": [ "public static Color Color.DeepSkyBlue { get }", "public static Color SplashKit.ColorDeepSkyBlue();" @@ -8667,13 +8621,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dim_gray():" - ], "cpp": [ "#define COLOR_DIM_GRAY", "color color_dim_gray()" ], + "python": [ + "def color_dim_gray():" + ], "csharp": [ "public static Color Color.DimGray { get }", "public static Color SplashKit.ColorDimGray();" @@ -8708,13 +8662,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dodger_blue():" - ], "cpp": [ "#define COLOR_DODGER_BLUE", "color color_dodger_blue()" ], + "python": [ + "def color_dodger_blue():" + ], "csharp": [ "public static Color Color.DodgerBlue { get }", "public static Color SplashKit.ColorDodgerBlue();" @@ -8749,13 +8703,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_firebrick():" - ], "cpp": [ "#define COLOR_FIREBRICK", "color color_firebrick()" ], + "python": [ + "def color_firebrick():" + ], "csharp": [ "public static Color Color.Firebrick { get }", "public static Color SplashKit.ColorFirebrick();" @@ -8790,13 +8744,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_floral_white():" - ], "cpp": [ "#define COLOR_FLORAL_WHITE", "color color_floral_white()" ], + "python": [ + "def color_floral_white():" + ], "csharp": [ "public static Color Color.FloralWhite { get }", "public static Color SplashKit.ColorFloralWhite();" @@ -8831,13 +8785,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_forest_green():" - ], "cpp": [ "#define COLOR_FOREST_GREEN", "color color_forest_green()" ], + "python": [ + "def color_forest_green():" + ], "csharp": [ "public static Color Color.ForestGreen { get }", "public static Color SplashKit.ColorForestGreen();" @@ -8872,13 +8826,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_fuchsia():" - ], "cpp": [ "#define COLOR_FUCHSIA", "color color_fuchsia()" ], + "python": [ + "def color_fuchsia():" + ], "csharp": [ "public static Color Color.Fuchsia { get }", "public static Color SplashKit.ColorFuchsia();" @@ -8913,13 +8867,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_gainsboro():" - ], "cpp": [ "#define COLOR_GAINSBORO", "color color_gainsboro()" ], + "python": [ + "def color_gainsboro():" + ], "csharp": [ "public static Color Color.Gainsboro { get }", "public static Color SplashKit.ColorGainsboro();" @@ -8954,13 +8908,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_ghost_white():" - ], "cpp": [ "#define COLOR_GHOST_WHITE", "color color_ghost_white()" ], + "python": [ + "def color_ghost_white():" + ], "csharp": [ "public static Color Color.GhostWhite { get }", "public static Color SplashKit.ColorGhostWhite();" @@ -8995,13 +8949,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_gold():" - ], "cpp": [ "#define COLOR_GOLD", "color color_gold()" ], + "python": [ + "def color_gold():" + ], "csharp": [ "public static Color Color.Gold { get }", "public static Color SplashKit.ColorGold();" @@ -9036,13 +8990,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_goldenrod():" - ], "cpp": [ "#define COLOR_GOLDENROD", "color color_goldenrod()" ], + "python": [ + "def color_goldenrod():" + ], "csharp": [ "public static Color Color.Goldenrod { get }", "public static Color SplashKit.ColorGoldenrod();" @@ -9077,13 +9031,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_gray():" - ], "cpp": [ "#define COLOR_GRAY", "color color_gray()" ], + "python": [ + "def color_gray():" + ], "csharp": [ "public static Color Color.Gray { get }", "public static Color SplashKit.ColorGray();" @@ -9118,13 +9072,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_green():" - ], "cpp": [ "#define COLOR_GREEN", "color color_green()" ], + "python": [ + "def color_green():" + ], "csharp": [ "public static Color Color.Green { get }", "public static Color SplashKit.ColorGreen();" @@ -9159,13 +9113,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_green_yellow():" - ], "cpp": [ "#define COLOR_GREEN_YELLOW", "color color_green_yellow()" ], + "python": [ + "def color_green_yellow():" + ], "csharp": [ "public static Color Color.GreenYellow { get }", "public static Color SplashKit.ColorGreenYellow();" @@ -9200,13 +9154,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_honeydew():" - ], "cpp": [ "#define COLOR_HONEYDEW", "color color_honeydew()" ], + "python": [ + "def color_honeydew():" + ], "csharp": [ "public static Color Color.Honeydew { get }", "public static Color SplashKit.ColorHoneydew();" @@ -9241,13 +9195,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_hot_pink():" - ], "cpp": [ "#define COLOR_HOT_PINK", "color color_hot_pink()" ], + "python": [ + "def color_hot_pink():" + ], "csharp": [ "public static Color Color.HotPink { get }", "public static Color SplashKit.ColorHotPink();" @@ -9282,13 +9236,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_indian_red():" - ], "cpp": [ "#define COLOR_INDIAN_RED", "color color_indian_red()" ], + "python": [ + "def color_indian_red():" + ], "csharp": [ "public static Color Color.IndianRed { get }", "public static Color SplashKit.ColorIndianRed();" @@ -9323,13 +9277,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_indigo():" - ], "cpp": [ "#define COLOR_INDIGO", "color color_indigo()" ], + "python": [ + "def color_indigo():" + ], "csharp": [ "public static Color Color.Indigo { get }", "public static Color SplashKit.ColorIndigo();" @@ -9364,13 +9318,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_ivory():" - ], "cpp": [ "#define COLOR_IVORY", "color color_ivory()" ], + "python": [ + "def color_ivory():" + ], "csharp": [ "public static Color Color.Ivory { get }", "public static Color SplashKit.ColorIvory();" @@ -9405,13 +9359,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_khaki():" - ], "cpp": [ "#define COLOR_KHAKI", "color color_khaki()" ], + "python": [ + "def color_khaki():" + ], "csharp": [ "public static Color Color.Khaki { get }", "public static Color SplashKit.ColorKhaki();" @@ -9446,13 +9400,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_lavender():" - ], "cpp": [ "#define COLOR_LAVENDER", "color color_lavender()" ], + "python": [ + "def color_lavender():" + ], "csharp": [ "public static Color Color.Lavender { get }", "public static Color SplashKit.ColorLavender();" @@ -9487,13 +9441,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_lavender_blush():" - ], "cpp": [ "#define COLOR_LAVENDER_BLUSH", "color color_lavender_blush()" ], + "python": [ + "def color_lavender_blush():" + ], "csharp": [ "public static Color Color.LavenderBlush { get }", "public static Color SplashKit.ColorLavenderBlush();" @@ -9528,13 +9482,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_lawn_green():" - ], "cpp": [ "#define COLOR_LAWN_GREEN", "color color_lawn_green()" ], + "python": [ + "def color_lawn_green():" + ], "csharp": [ "public static Color Color.LawnGreen { get }", "public static Color SplashKit.ColorLawnGreen();" @@ -9569,13 +9523,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_lemon_chiffon():" - ], "cpp": [ "#define COLOR_LEMON_CHIFFON", "color color_lemon_chiffon()" ], + "python": [ + "def color_lemon_chiffon():" + ], "csharp": [ "public static Color Color.LemonChiffon { get }", "public static Color SplashKit.ColorLemonChiffon();" @@ -9610,13 +9564,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_blue():" - ], "cpp": [ "#define COLOR_LIGHT_BLUE", "color color_light_blue()" ], + "python": [ + "def color_light_blue():" + ], "csharp": [ "public static Color Color.LightBlue { get }", "public static Color SplashKit.ColorLightBlue();" @@ -9651,13 +9605,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_coral():" - ], "cpp": [ "#define COLOR_LIGHT_CORAL", "color color_light_coral()" ], + "python": [ + "def color_light_coral():" + ], "csharp": [ "public static Color Color.LightCoral { get }", "public static Color SplashKit.ColorLightCoral();" @@ -9692,13 +9646,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_cyan():" - ], "cpp": [ "#define COLOR_LIGHT_CYAN", "color color_light_cyan()" ], + "python": [ + "def color_light_cyan():" + ], "csharp": [ "public static Color Color.LightCyan { get }", "public static Color SplashKit.ColorLightCyan();" @@ -9733,13 +9687,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_goldenrod_yellow():" - ], "cpp": [ "#define COLOR_LIGHT_GOLDENROD_YELLOW", "color color_light_goldenrod_yellow()" ], + "python": [ + "def color_light_goldenrod_yellow():" + ], "csharp": [ "public static Color Color.LightGoldenrodYellow { get }", "public static Color SplashKit.ColorLightGoldenrodYellow();" @@ -9774,13 +9728,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_gray():" - ], "cpp": [ "#define COLOR_LIGHT_GRAY", "color color_light_gray()" ], + "python": [ + "def color_light_gray():" + ], "csharp": [ "public static Color Color.LightGray { get }", "public static Color SplashKit.ColorLightGray();" @@ -9815,13 +9769,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_green():" - ], "cpp": [ "#define COLOR_LIGHT_GREEN", "color color_light_green()" ], + "python": [ + "def color_light_green():" + ], "csharp": [ "public static Color Color.LightGreen { get }", "public static Color SplashKit.ColorLightGreen();" @@ -9856,13 +9810,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_pink():" - ], "cpp": [ "#define COLOR_LIGHT_PINK", "color color_light_pink()" ], + "python": [ + "def color_light_pink():" + ], "csharp": [ "public static Color Color.LightPink { get }", "public static Color SplashKit.ColorLightPink();" @@ -9897,13 +9851,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_salmon():" - ], "cpp": [ "#define COLOR_LIGHT_SALMON", "color color_light_salmon()" ], + "python": [ + "def color_light_salmon():" + ], "csharp": [ "public static Color Color.LightSalmon { get }", "public static Color SplashKit.ColorLightSalmon();" @@ -9938,13 +9892,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_sea_green():" - ], "cpp": [ "#define COLOR_LIGHT_SEA_GREEN", "color color_light_sea_green()" ], + "python": [ + "def color_light_sea_green():" + ], "csharp": [ "public static Color Color.LightSeaGreen { get }", "public static Color SplashKit.ColorLightSeaGreen();" @@ -9979,13 +9933,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_sky_blue():" - ], "cpp": [ "#define COLOR_LIGHT_SKY_BLUE", "color color_light_sky_blue()" ], + "python": [ + "def color_light_sky_blue():" + ], "csharp": [ "public static Color Color.LightSkyBlue { get }", "public static Color SplashKit.ColorLightSkyBlue();" @@ -10020,13 +9974,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_slate_gray():" - ], "cpp": [ "#define COLOR_LIGHT_SLATE_GRAY", "color color_light_slate_gray()" ], + "python": [ + "def color_light_slate_gray():" + ], "csharp": [ "public static Color Color.LightSlateGray { get }", "public static Color SplashKit.ColorLightSlateGray();" @@ -10061,13 +10015,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_steel_blue():" - ], "cpp": [ "#define COLOR_LIGHT_STEEL_BLUE", "color color_light_steel_blue()" ], + "python": [ + "def color_light_steel_blue():" + ], "csharp": [ "public static Color Color.LightSteelBlue { get }", "public static Color SplashKit.ColorLightSteelBlue();" @@ -10102,13 +10056,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_yellow():" - ], "cpp": [ "#define COLOR_LIGHT_YELLOW", "color color_light_yellow()" ], + "python": [ + "def color_light_yellow():" + ], "csharp": [ "public static Color Color.LightYellow { get }", "public static Color SplashKit.ColorLightYellow();" @@ -10143,13 +10097,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_lime():" - ], "cpp": [ "#define COLOR_LIME", "color color_lime()" ], + "python": [ + "def color_lime():" + ], "csharp": [ "public static Color Color.Lime { get }", "public static Color SplashKit.ColorLime();" @@ -10184,13 +10138,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_lime_green():" - ], "cpp": [ "#define COLOR_LIME_GREEN", "color color_lime_green()" ], + "python": [ + "def color_lime_green():" + ], "csharp": [ "public static Color Color.LimeGreen { get }", "public static Color SplashKit.ColorLimeGreen();" @@ -10225,13 +10179,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_linen():" - ], "cpp": [ "#define COLOR_LINEN", "color color_linen()" ], + "python": [ + "def color_linen():" + ], "csharp": [ "public static Color Color.Linen { get }", "public static Color SplashKit.ColorLinen();" @@ -10266,13 +10220,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_magenta():" - ], "cpp": [ "#define COLOR_MAGENTA", "color color_magenta()" ], + "python": [ + "def color_magenta():" + ], "csharp": [ "public static Color Color.Magenta { get }", "public static Color SplashKit.ColorMagenta();" @@ -10307,13 +10261,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_maroon():" - ], "cpp": [ "#define COLOR_MAROON", "color color_maroon()" ], + "python": [ + "def color_maroon():" + ], "csharp": [ "public static Color Color.Maroon { get }", "public static Color SplashKit.ColorMaroon();" @@ -10348,13 +10302,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_aquamarine():" - ], "cpp": [ "#define COLOR_MEDIUM_AQUAMARINE", "color color_medium_aquamarine()" ], + "python": [ + "def color_medium_aquamarine():" + ], "csharp": [ "public static Color Color.MediumAquamarine { get }", "public static Color SplashKit.ColorMediumAquamarine();" @@ -10389,13 +10343,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_blue():" - ], "cpp": [ "#define COLOR_MEDIUM_BLUE", "color color_medium_blue()" ], + "python": [ + "def color_medium_blue():" + ], "csharp": [ "public static Color Color.MediumBlue { get }", "public static Color SplashKit.ColorMediumBlue();" @@ -10430,13 +10384,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_orchid():" - ], "cpp": [ "#define COLOR_MEDIUM_ORCHID", "color color_medium_orchid()" ], + "python": [ + "def color_medium_orchid():" + ], "csharp": [ "public static Color Color.MediumOrchid { get }", "public static Color SplashKit.ColorMediumOrchid();" @@ -10471,13 +10425,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_purple():" - ], "cpp": [ "#define COLOR_MEDIUM_PURPLE", "color color_medium_purple()" ], + "python": [ + "def color_medium_purple():" + ], "csharp": [ "public static Color Color.MediumPurple { get }", "public static Color SplashKit.ColorMediumPurple();" @@ -10512,13 +10466,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_sea_green():" - ], "cpp": [ "#define COLOR_MEDIUM_SEA_GREEN", "color color_medium_sea_green()" ], + "python": [ + "def color_medium_sea_green():" + ], "csharp": [ "public static Color Color.MediumSeaGreen { get }", "public static Color SplashKit.ColorMediumSeaGreen();" @@ -10553,13 +10507,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_slate_blue():" - ], "cpp": [ "#define COLOR_MEDIUM_SLATE_BLUE", "color color_medium_slate_blue()" ], + "python": [ + "def color_medium_slate_blue():" + ], "csharp": [ "public static Color Color.MediumSlateBlue { get }", "public static Color SplashKit.ColorMediumSlateBlue();" @@ -10594,13 +10548,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_spring_green():" - ], "cpp": [ "#define COLOR_MEDIUM_SPRING_GREEN", "color color_medium_spring_green()" ], + "python": [ + "def color_medium_spring_green():" + ], "csharp": [ "public static Color Color.MediumSpringGreen { get }", "public static Color SplashKit.ColorMediumSpringGreen();" @@ -10635,13 +10589,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_turquoise():" - ], "cpp": [ "#define COLOR_MEDIUM_TURQUOISE", "color color_medium_turquoise()" ], + "python": [ + "def color_medium_turquoise():" + ], "csharp": [ "public static Color Color.MediumTurquoise { get }", "public static Color SplashKit.ColorMediumTurquoise();" @@ -10676,13 +10630,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_violet_red():" - ], "cpp": [ "#define COLOR_MEDIUM_VIOLET_RED", "color color_medium_violet_red()" ], + "python": [ + "def color_medium_violet_red():" + ], "csharp": [ "public static Color Color.MediumVioletRed { get }", "public static Color SplashKit.ColorMediumVioletRed();" @@ -10717,13 +10671,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_midnight_blue():" - ], "cpp": [ "#define COLOR_MIDNIGHT_BLUE", "color color_midnight_blue()" ], + "python": [ + "def color_midnight_blue():" + ], "csharp": [ "public static Color Color.MidnightBlue { get }", "public static Color SplashKit.ColorMidnightBlue();" @@ -10758,13 +10712,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_mint_cream():" - ], "cpp": [ "#define COLOR_MINT_CREAM", "color color_mint_cream()" ], + "python": [ + "def color_mint_cream():" + ], "csharp": [ "public static Color Color.MintCream { get }", "public static Color SplashKit.ColorMintCream();" @@ -10799,13 +10753,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_misty_rose():" - ], "cpp": [ "#define COLOR_MISTY_ROSE", "color color_misty_rose()" ], + "python": [ + "def color_misty_rose():" + ], "csharp": [ "public static Color Color.MistyRose { get }", "public static Color SplashKit.ColorMistyRose();" @@ -10840,13 +10794,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_moccasin():" - ], "cpp": [ "#define COLOR_MOCCASIN", "color color_moccasin()" ], + "python": [ + "def color_moccasin():" + ], "csharp": [ "public static Color Color.Moccasin { get }", "public static Color SplashKit.ColorMoccasin();" @@ -10881,13 +10835,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_navajo_white():" - ], "cpp": [ "#define COLOR_NAVAJO_WHITE", "color color_navajo_white()" ], + "python": [ + "def color_navajo_white():" + ], "csharp": [ "public static Color Color.NavajoWhite { get }", "public static Color SplashKit.ColorNavajoWhite();" @@ -10922,13 +10876,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_navy():" - ], "cpp": [ "#define COLOR_NAVY", "color color_navy()" ], + "python": [ + "def color_navy():" + ], "csharp": [ "public static Color Color.Navy { get }", "public static Color SplashKit.ColorNavy();" @@ -10963,13 +10917,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_old_lace():" - ], "cpp": [ "#define COLOR_OLD_LACE", "color color_old_lace()" ], + "python": [ + "def color_old_lace():" + ], "csharp": [ "public static Color Color.OldLace { get }", "public static Color SplashKit.ColorOldLace();" @@ -11004,13 +10958,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_olive():" - ], "cpp": [ "#define COLOR_OLIVE", "color color_olive()" ], + "python": [ + "def color_olive():" + ], "csharp": [ "public static Color Color.Olive { get }", "public static Color SplashKit.ColorOlive();" @@ -11045,13 +10999,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_olive_drab():" - ], "cpp": [ "#define COLOR_OLIVE_DRAB", "color color_olive_drab()" ], + "python": [ + "def color_olive_drab():" + ], "csharp": [ "public static Color Color.OliveDrab { get }", "public static Color SplashKit.ColorOliveDrab();" @@ -11086,13 +11040,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_orange():" - ], "cpp": [ "#define COLOR_ORANGE", "color color_orange()" ], + "python": [ + "def color_orange():" + ], "csharp": [ "public static Color Color.Orange { get }", "public static Color SplashKit.ColorOrange();" @@ -11127,13 +11081,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_orange_red():" - ], "cpp": [ "#define COLOR_ORANGE_RED", "color color_orange_red()" ], + "python": [ + "def color_orange_red():" + ], "csharp": [ "public static Color Color.OrangeRed { get }", "public static Color SplashKit.ColorOrangeRed();" @@ -11168,13 +11122,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_orchid():" - ], "cpp": [ "#define COLOR_ORCHID", "color color_orchid()" ], + "python": [ + "def color_orchid():" + ], "csharp": [ "public static Color Color.Orchid { get }", "public static Color SplashKit.ColorOrchid();" @@ -11209,13 +11163,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_pale_goldenrod():" - ], "cpp": [ "#define COLOR_PALE_GOLDENROD", "color color_pale_goldenrod()" ], + "python": [ + "def color_pale_goldenrod():" + ], "csharp": [ "public static Color Color.PaleGoldenrod { get }", "public static Color SplashKit.ColorPaleGoldenrod();" @@ -11250,13 +11204,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_pale_green():" - ], "cpp": [ "#define COLOR_PALE_GREEN", "color color_pale_green()" ], + "python": [ + "def color_pale_green():" + ], "csharp": [ "public static Color Color.PaleGreen { get }", "public static Color SplashKit.ColorPaleGreen();" @@ -11291,13 +11245,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_pale_turquoise():" - ], "cpp": [ "#define COLOR_PALE_TURQUOISE", "color color_pale_turquoise()" ], + "python": [ + "def color_pale_turquoise():" + ], "csharp": [ "public static Color Color.PaleTurquoise { get }", "public static Color SplashKit.ColorPaleTurquoise();" @@ -11332,13 +11286,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_pale_violet_red():" - ], "cpp": [ "#define COLOR_PALE_VIOLET_RED", "color color_pale_violet_red()" ], + "python": [ + "def color_pale_violet_red():" + ], "csharp": [ "public static Color Color.PaleVioletRed { get }", "public static Color SplashKit.ColorPaleVioletRed();" @@ -11373,13 +11327,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_papaya_whip():" - ], "cpp": [ "#define COLOR_PAPAYA_WHIP", "color color_papaya_whip()" ], + "python": [ + "def color_papaya_whip():" + ], "csharp": [ "public static Color Color.PapayaWhip { get }", "public static Color SplashKit.ColorPapayaWhip();" @@ -11414,13 +11368,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_peach_puff():" - ], "cpp": [ "#define COLOR_PEACH_PUFF", "color color_peach_puff()" ], + "python": [ + "def color_peach_puff():" + ], "csharp": [ "public static Color Color.PeachPuff { get }", "public static Color SplashKit.ColorPeachPuff();" @@ -11455,13 +11409,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_peru():" - ], "cpp": [ "#define COLOR_PERU", "color color_peru()" ], + "python": [ + "def color_peru():" + ], "csharp": [ "public static Color Color.Peru { get }", "public static Color SplashKit.ColorPeru();" @@ -11496,13 +11450,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_pink():" - ], "cpp": [ "#define COLOR_PINK", "color color_pink()" ], + "python": [ + "def color_pink():" + ], "csharp": [ "public static Color Color.Pink { get }", "public static Color SplashKit.ColorPink();" @@ -11537,13 +11491,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_plum():" - ], "cpp": [ "#define COLOR_PLUM", "color color_plum()" ], + "python": [ + "def color_plum():" + ], "csharp": [ "public static Color Color.Plum { get }", "public static Color SplashKit.ColorPlum();" @@ -11578,13 +11532,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_powder_blue():" - ], "cpp": [ "#define COLOR_POWDER_BLUE", "color color_powder_blue()" ], + "python": [ + "def color_powder_blue():" + ], "csharp": [ "public static Color Color.PowderBlue { get }", "public static Color SplashKit.ColorPowderBlue();" @@ -11619,13 +11573,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_purple():" - ], "cpp": [ "#define COLOR_PURPLE", "color color_purple()" ], + "python": [ + "def color_purple():" + ], "csharp": [ "public static Color Color.Purple { get }", "public static Color SplashKit.ColorPurple();" @@ -11660,13 +11614,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_red():" - ], "cpp": [ "#define COLOR_RED", "color color_red()" ], + "python": [ + "def color_red():" + ], "csharp": [ "public static Color Color.Red { get }", "public static Color SplashKit.ColorRed();" @@ -11701,13 +11655,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_rosy_brown():" - ], "cpp": [ "#define COLOR_ROSY_BROWN", "color color_rosy_brown()" ], + "python": [ + "def color_rosy_brown():" + ], "csharp": [ "public static Color Color.RosyBrown { get }", "public static Color SplashKit.ColorRosyBrown();" @@ -11742,13 +11696,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_royal_blue():" - ], "cpp": [ "#define COLOR_ROYAL_BLUE", "color color_royal_blue()" ], + "python": [ + "def color_royal_blue():" + ], "csharp": [ "public static Color Color.RoyalBlue { get }", "public static Color SplashKit.ColorRoyalBlue();" @@ -11783,13 +11737,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_saddle_brown():" - ], "cpp": [ "#define COLOR_SADDLE_BROWN", "color color_saddle_brown()" ], + "python": [ + "def color_saddle_brown():" + ], "csharp": [ "public static Color Color.SaddleBrown { get }", "public static Color SplashKit.ColorSaddleBrown();" @@ -11824,13 +11778,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_salmon():" - ], "cpp": [ "#define COLOR_SALMON", "color color_salmon()" ], + "python": [ + "def color_salmon():" + ], "csharp": [ "public static Color Color.Salmon { get }", "public static Color SplashKit.ColorSalmon();" @@ -11865,13 +11819,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_sandy_brown():" - ], "cpp": [ "#define COLOR_SANDY_BROWN", "color color_sandy_brown()" ], + "python": [ + "def color_sandy_brown():" + ], "csharp": [ "public static Color Color.SandyBrown { get }", "public static Color SplashKit.ColorSandyBrown();" @@ -11906,13 +11860,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_sea_green():" - ], "cpp": [ "#define COLOR_SEA_GREEN", "color color_sea_green()" ], + "python": [ + "def color_sea_green():" + ], "csharp": [ "public static Color Color.SeaGreen { get }", "public static Color SplashKit.ColorSeaGreen();" @@ -11947,13 +11901,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_sea_shell():" - ], "cpp": [ "#define COLOR_SEA_SHELL", "color color_sea_shell()" ], + "python": [ + "def color_sea_shell():" + ], "csharp": [ "public static Color Color.SeaShell { get }", "public static Color SplashKit.ColorSeaShell();" @@ -11988,13 +11942,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_sienna():" - ], "cpp": [ "#define COLOR_SIENNA", "color color_sienna()" ], + "python": [ + "def color_sienna():" + ], "csharp": [ "public static Color Color.Sienna { get }", "public static Color SplashKit.ColorSienna();" @@ -12029,13 +11983,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_silver():" - ], "cpp": [ "#define COLOR_SILVER", "color color_silver()" ], + "python": [ + "def color_silver():" + ], "csharp": [ "public static Color Color.Silver { get }", "public static Color SplashKit.ColorSilver();" @@ -12070,13 +12024,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_sky_blue():" - ], "cpp": [ "#define COLOR_SKY_BLUE", "color color_sky_blue()" ], + "python": [ + "def color_sky_blue():" + ], "csharp": [ "public static Color Color.SkyBlue { get }", "public static Color SplashKit.ColorSkyBlue();" @@ -12111,13 +12065,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_slate_blue():" - ], "cpp": [ "#define COLOR_SLATE_BLUE", "color color_slate_blue()" ], + "python": [ + "def color_slate_blue():" + ], "csharp": [ "public static Color Color.SlateBlue { get }", "public static Color SplashKit.ColorSlateBlue();" @@ -12152,13 +12106,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_slate_gray():" - ], "cpp": [ "#define COLOR_SLATE_GRAY", "color color_slate_gray()" ], + "python": [ + "def color_slate_gray():" + ], "csharp": [ "public static Color Color.SlateGray { get }", "public static Color SplashKit.ColorSlateGray();" @@ -12193,13 +12147,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_snow():" - ], "cpp": [ "#define COLOR_SNOW", "color color_snow()" ], + "python": [ + "def color_snow():" + ], "csharp": [ "public static Color Color.Snow { get }", "public static Color SplashKit.ColorSnow();" @@ -12234,13 +12188,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_spring_green():" - ], "cpp": [ "#define COLOR_SPRING_GREEN", "color color_spring_green()" ], + "python": [ + "def color_spring_green():" + ], "csharp": [ "public static Color Color.SpringGreen { get }", "public static Color SplashKit.ColorSpringGreen();" @@ -12275,13 +12229,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_steel_blue():" - ], "cpp": [ "#define COLOR_STEEL_BLUE", "color color_steel_blue()" ], + "python": [ + "def color_steel_blue():" + ], "csharp": [ "public static Color Color.SteelBlue { get }", "public static Color SplashKit.ColorSteelBlue();" @@ -12316,13 +12270,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_swinburne_red():" - ], "cpp": [ "#define COLOR_SWINBURNE_RED", "color color_swinburne_red()" ], + "python": [ + "def color_swinburne_red():" + ], "csharp": [ "public static Color Color.SwinburneRed { get }", "public static Color SplashKit.ColorSwinburneRed();" @@ -12357,13 +12311,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_tan():" - ], "cpp": [ "#define COLOR_TAN", "color color_tan()" ], + "python": [ + "def color_tan():" + ], "csharp": [ "public static Color Color.Tan { get }", "public static Color SplashKit.ColorTan();" @@ -12398,13 +12352,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_teal():" - ], "cpp": [ "#define COLOR_TEAL", "color color_teal()" ], + "python": [ + "def color_teal():" + ], "csharp": [ "public static Color Color.Teal { get }", "public static Color SplashKit.ColorTeal();" @@ -12439,13 +12393,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_thistle():" - ], "cpp": [ "#define COLOR_THISTLE", "color color_thistle()" ], + "python": [ + "def color_thistle():" + ], "csharp": [ "public static Color Color.Thistle { get }", "public static Color SplashKit.ColorThistle();" @@ -12491,12 +12445,12 @@ "group": "color" }, "signatures": { - "python": [ - "def color_to_string(c):" - ], "cpp": [ "string color_to_string(color c)" ], + "python": [ + "def color_to_string(c):" + ], "csharp": [ "public static string SplashKit.ColorToString(Color c);" ], @@ -12530,13 +12484,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_tomato():" - ], "cpp": [ "#define COLOR_TOMATO", "color color_tomato()" ], + "python": [ + "def color_tomato():" + ], "csharp": [ "public static Color Color.Tomato { get }", "public static Color SplashKit.ColorTomato();" @@ -12571,13 +12525,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_transparent():" - ], "cpp": [ "#define COLOR_TRANSPARENT", "color color_transparent()" ], + "python": [ + "def color_transparent():" + ], "csharp": [ "public static Color Color.Transparent { get }", "public static Color SplashKit.ColorTransparent();" @@ -12612,13 +12566,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_turquoise():" - ], "cpp": [ "#define COLOR_TURQUOISE", "color color_turquoise()" ], + "python": [ + "def color_turquoise():" + ], "csharp": [ "public static Color Color.Turquoise { get }", "public static Color SplashKit.ColorTurquoise();" @@ -12653,13 +12607,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_violet():" - ], "cpp": [ "#define COLOR_VIOLET", "color color_violet()" ], + "python": [ + "def color_violet():" + ], "csharp": [ "public static Color Color.Violet { get }", "public static Color SplashKit.ColorViolet();" @@ -12694,13 +12648,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_wheat():" - ], "cpp": [ "#define COLOR_WHEAT", "color color_wheat()" ], + "python": [ + "def color_wheat():" + ], "csharp": [ "public static Color Color.Wheat { get }", "public static Color SplashKit.ColorWheat();" @@ -12735,13 +12689,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_white():" - ], "cpp": [ "#define COLOR_WHITE", "color color_white()" ], + "python": [ + "def color_white():" + ], "csharp": [ "public static Color Color.White { get }", "public static Color SplashKit.ColorWhite();" @@ -12776,13 +12730,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_white_smoke():" - ], "cpp": [ "#define COLOR_WHITE_SMOKE", "color color_white_smoke()" ], + "python": [ + "def color_white_smoke():" + ], "csharp": [ "public static Color Color.WhiteSmoke { get }", "public static Color SplashKit.ColorWhiteSmoke();" @@ -12817,13 +12771,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_yellow():" - ], "cpp": [ "#define COLOR_YELLOW", "color color_yellow()" ], + "python": [ + "def color_yellow():" + ], "csharp": [ "public static Color Color.Yellow { get }", "public static Color SplashKit.ColorYellow();" @@ -12858,13 +12812,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_yellow_green():" - ], "cpp": [ "#define COLOR_YELLOW_GREEN", "color color_yellow_green()" ], + "python": [ + "def color_yellow_green():" + ], "csharp": [ "public static Color Color.YellowGreen { get }", "public static Color SplashKit.ColorYellowGreen();" @@ -12910,12 +12864,12 @@ "group": "color" }, "signatures": { - "python": [ - "def green_of(c):" - ], "cpp": [ "int green_of(color c)" ], + "python": [ + "def green_of(c):" + ], "csharp": [ "public static int SplashKit.GreenOf(Color c);" ], @@ -12988,12 +12942,12 @@ "group": "color" }, "signatures": { - "python": [ - "def hsb_color(hue, saturation, brightness):" - ], "cpp": [ "color hsb_color(double hue, double saturation, double brightness)" ], + "python": [ + "def hsb_color(hue, saturation, brightness):" + ], "csharp": [ "public static Color Color.HSBColor(double hue, double saturation, double brightness);", "public static Color SplashKit.HSBColor(double hue, double saturation, double brightness);" @@ -13039,12 +12993,12 @@ "group": "color" }, "signatures": { - "python": [ - "def hue_of(c):" - ], "cpp": [ "double hue_of(color c)" ], + "python": [ + "def hue_of(c):" + ], "csharp": [ "public static double SplashKit.HueOf(Color c);" ], @@ -13078,12 +13032,12 @@ "group": "color" }, "signatures": { - "python": [ - "def random_color():" - ], "cpp": [ "color random_color()" ], + "python": [ + "def random_color():" + ], "csharp": [ "public static Color Color.Random();", "public static Color SplashKit.RandomColor();" @@ -13131,12 +13085,12 @@ "group": "color" }, "signatures": { - "python": [ - "def random_rgb_color(alpha):" - ], "cpp": [ "color random_rgb_color(int alpha)" ], + "python": [ + "def random_rgb_color(alpha):" + ], "csharp": [ "public static Color Color.RandomRGB(int alpha);", "public static Color SplashKit.RandomRGBColor(int alpha);" @@ -13182,12 +13136,12 @@ "group": "color" }, "signatures": { - "python": [ - "def red_of(c):" - ], "cpp": [ "int red_of(color c)" ], + "python": [ + "def red_of(c):" + ], "csharp": [ "public static int SplashKit.RedOf(Color c);" ], @@ -13261,12 +13215,12 @@ "group": "color" }, "signatures": { - "python": [ - "def rgb_color_from_double(red, green, blue):" - ], "cpp": [ "color rgb_color(double red, double green, double blue)" ], + "python": [ + "def rgb_color_from_double(red, green, blue):" + ], "csharp": [ "public static Color Color.RGBColor(double red, double green, double blue);", "public static Color SplashKit.RGBColor(double red, double green, double blue);" @@ -13340,12 +13294,12 @@ "group": "color" }, "signatures": { - "python": [ - "def rgb_color(red, green, blue):" - ], "cpp": [ "color rgb_color(int red, int green, int blue)" ], + "python": [ + "def rgb_color(red, green, blue):" + ], "csharp": [ "public static Color Color.RGBColor(int red, int green, int blue);", "public static Color SplashKit.RGBColor(int red, int green, int blue);" @@ -13433,12 +13387,12 @@ "group": "color" }, "signatures": { - "python": [ - "def rgba_color_from_double(red, green, blue, alpha):" - ], "cpp": [ "color rgba_color(double red, double green, double blue, double alpha)" ], + "python": [ + "def rgba_color_from_double(red, green, blue, alpha):" + ], "csharp": [ "public static Color Color.RGBAColor(double red, double green, double blue, double alpha);", "public static Color SplashKit.RGBAColor(double red, double green, double blue, double alpha);" @@ -13525,12 +13479,12 @@ "group": "color" }, "signatures": { - "python": [ - "def rgba_color(red, green, blue, alpha):" - ], "cpp": [ "color rgba_color(int red, int green, int blue, int alpha)" ], + "python": [ + "def rgba_color(red, green, blue, alpha):" + ], "csharp": [ "public static Color Color.RGBAColor(int red, int green, int blue, int alpha);", "public static Color SplashKit.RGBAColor(int red, int green, int blue, int alpha);" @@ -13576,12 +13530,12 @@ "group": "color" }, "signatures": { - "python": [ - "def saturation_of(c):" - ], "cpp": [ "double saturation_of(color c)" ], + "python": [ + "def saturation_of(c):" + ], "csharp": [ "public static double SplashKit.SaturationOf(Color c);" ], @@ -13626,12 +13580,12 @@ "group": "color" }, "signatures": { - "python": [ - "def string_to_color(str):" - ], "cpp": [ "color string_to_color(string str)" ], + "python": [ + "def string_to_color(str):" + ], "csharp": [ "public static Color SplashKit.StringToColor(string str);" ], @@ -14523,22 +14477,22 @@ } ] }, - "generative_ai": { - "brief": "", + "geometry": { + "brief": "SplashKit's geometry functions assist with geometry-related computations.", "description": "", "functions": [ { - "signature": "void conversation_add_message(conversation c,const string& message);", - "name": "conversation_add_message", - "method_name": "add_message", - "unique_global_name": "conversation_add_message", - "unique_method_name": "conversation.add_message", + "signature": "point_2d center_point(const circle &c);", + "name": "center_point", + "method_name": null, + "unique_global_name": "center_point", + "unique_method_name": null, "suffix_name": null, - "description": "Adds a message to a `conversation`, that the language model will begin replying to.\nYou can receive the reply one piece at a time by calling `conversation_get_reply_piece(conversation c)` in a loop", + "description": "Returns the center point of the circle.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "point_2d", + "description": "The center point of the circle", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -14546,21 +14500,8 @@ }, "parameters": { "c": { - "type": "conversation", - "description": "The `conversation` object to check", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "message": { - "type": "string", - "description": "The user message to add to the conversation - the language model will reply to this", + "type": "circle", + "description": "The circle to get the center point", "is_pointer": false, "is_const": true, "is_reference": true, @@ -14573,49 +14514,58 @@ } }, "attributes": { - "class": "conversation", - "method": "add_message", - "self": "c", - "group": "generative_ai", - "static": "generative_ai" + "group": "geometry", + "static": "geometry" }, "signatures": { - "python": [ - "def conversation_add_message(c, message):" - ], "cpp": [ - "void conversation_add_message(conversation c, const string &message)" + "point_2d center_point(const circle &c)" + ], + "python": [ + "def center_point(c):" ], "csharp": [ - "public void Conversation.AddMessage(string message);", - "public static void SplashKit.ConversationAddMessage(Conversation c, string message);" + "public static Point2D SplashKit.CenterPoint(Circle c);" ], "pascal": [ - "procedure ConversationAddMessage(c: Conversation; const message: String)" + "function CenterPoint(const c: Circle): Point2D" ] } }, { - "signature": "string conversation_get_reply(conversation conv);", - "name": "conversation_get_reply", - "method_name": "get_reply", - "unique_global_name": "conversation_get_reply", - "unique_method_name": "conversation.get_reply", + "signature": "circle circle_at(const point_2d &pt,double radius);", + "name": "circle_at", + "method_name": null, + "unique_global_name": "circle_at", + "unique_method_name": null, "suffix_name": null, - "description": "Returns a reply from a `conversation`, without any related thoughts.", + "description": "Returns a circle at the indicated point and radius.", "brief": null, "return": { - "type": "string", - "description": "The response from the model", + "type": "circle", + "description": "A circle at the indicatd point and radius", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "conv": { - "type": "conversation", - "description": "The `conversation` to recieve the reply from", + "pt": { + "type": "point_2d", + "description": "The location of the center of the circle", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "radius": { + "type": "double", + "description": "The radius of the circle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -14628,49 +14578,45 @@ } }, "attributes": { - "class": "conversation", - "method": "get_reply", - "self": "conv", - "group": "generative_ai", - "static": "generative_ai" + "group": "geometry", + "static": "geometry" }, "signatures": { - "python": [ - "def conversation_get_reply(conv):" - ], "cpp": [ - "string conversation_get_reply(conversation conv)" + "circle circle_at(const point_2d &pt, double radius)" + ], + "python": [ + "def circle_at(pt, radius):" ], "csharp": [ - "public string Conversation.GetReply();", - "public static string SplashKit.ConversationGetReply(Conversation conv);" + "public static Circle SplashKit.CircleAt(Point2D pt, double radius);" ], "pascal": [ - "function ConversationGetReply(conv: Conversation): String" + "function CircleAt(const pt: Point2D; radius: Double): Circle" ] } }, { - "signature": "string conversation_get_reply(conversation conv,bool with_thoughts);", - "name": "conversation_get_reply", - "method_name": "get_reply", - "unique_global_name": "conversation_get_reply_with_thoughts", - "unique_method_name": "conversation.get_reply_with_thoughts", + "signature": "circle circle_at(double x,double y,double radius);", + "name": "circle_at", + "method_name": null, + "unique_global_name": "circle_at_from_points", + "unique_method_name": null, "suffix_name": null, - "description": "Returns a reply from a `conversation`, with the ability to indicate if thoughts should be included.", + "description": "Returns a circle at the indicated point and radius.", "brief": null, "return": { - "type": "string", - "description": "The response from the model", + "type": "circle", + "description": "A circle at the indicatd point and radius", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "conv": { - "type": "conversation", - "description": "The `conversation` to recieve the reply from", + "x": { + "type": "double", + "description": "The x location of the circle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -14681,9 +14627,9 @@ "is_vector": false, "type_parameter": null }, - "with_thoughts": { - "type": "bool", - "description": "A boolean to indicate if thoughts should be included in the reply", + "y": { + "type": "double", + "description": "The y location of the circle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -14693,53 +14639,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "conversation", - "method": "get_reply", - "self": "conv", - "suffix": "with_thoughts", - "group": "generative_ai", - "static": "generative_ai" - }, - "signatures": { - "python": [ - "def conversation_get_reply_with_thoughts(conv, with_thoughts):" - ], - "cpp": [ - "string conversation_get_reply(conversation conv, bool with_thoughts)" - ], - "csharp": [ - "public string Conversation.GetReply(bool withThoughts);", - "public static string SplashKit.ConversationGetReply(Conversation conv, bool withThoughts);" - ], - "pascal": [ - "function ConversationGetReply(conv: Conversation; withThoughts: Boolean): String" - ] - } - }, - { - "signature": "string conversation_get_reply_piece(conversation c);", - "name": "conversation_get_reply_piece", - "method_name": "get_reply_piece", - "unique_global_name": "conversation_get_reply_piece", - "unique_method_name": "conversation.get_reply_piece", - "suffix_name": null, - "description": "Returns a single piece of a reply (generally one word at a time) from the `conversation`\nYou can use a loop while checking `conversation_is_replying` to retrieve the reply as it generates", - "brief": null, - "return": { - "type": "string", - "description": "Returns a small piece of the reply (generally 1 word or less)", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "c": { - "type": "conversation", - "description": "The `conversation` object to recieve the reply from", + }, + "radius": { + "type": "double", + "description": "The radius of the circle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -14752,40 +14655,37 @@ } }, "attributes": { - "class": "conversation", - "method": "get_reply_piece", - "self": "c", - "group": "generative_ai", - "static": "generative_ai" + "suffix": "from_points", + "group": "geometry", + "static": "geometry" }, "signatures": { - "python": [ - "def conversation_get_reply_piece(c):" - ], "cpp": [ - "string conversation_get_reply_piece(conversation c)" + "circle circle_at(double x, double y, double radius)" + ], + "python": [ + "def circle_at_from_points(x, y, radius):" ], "csharp": [ - "public string Conversation.GetReplyPiece();", - "public static string SplashKit.ConversationGetReplyPiece(Conversation c);" + "public static Circle SplashKit.CircleAt(double x, double y, double radius);" ], "pascal": [ - "function ConversationGetReplyPiece(c: Conversation): String" + "function CircleAt(x: Double; y: Double; radius: Double): Circle" ] } }, { - "signature": "bool conversation_is_replying(conversation c);", - "name": "conversation_is_replying", - "method_name": "is_replying", - "unique_global_name": "conversation_is_replying", - "unique_method_name": "conversation.is_replying", + "signature": "bool circle_quad_intersect(const circle &c,const quad &q);", + "name": "circle_quad_intersect", + "method_name": null, + "unique_global_name": "circle_quad_intersect", + "unique_method_name": null, "suffix_name": null, - "description": "Checks if a language model is currently generating a reply within a `conversation`.\nIf so, you can continue to receive the message with `conversation_get_reply_piece(conversation c)`", + "description": "Detects if a circle intersects with a quad.", "brief": null, "return": { "type": "bool", - "description": "Returns whether the language model is still generating a reply", + "description": "True if the circle and quad intersect, false otherwise", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -14793,11 +14693,24 @@ }, "parameters": { "c": { - "type": "conversation", - "description": "The `conversation` object to check", + "type": "circle", + "description": "The circle to test", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "q": { + "type": "quad", + "description": "The quad to test", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -14807,40 +14720,36 @@ } }, "attributes": { - "class": "conversation", - "method": "is_replying", - "self": "c", - "group": "generative_ai", - "static": "generative_ai" + "group": "geometry", + "static": "geometry" }, "signatures": { - "python": [ - "def conversation_is_replying(c):" - ], "cpp": [ - "bool conversation_is_replying(conversation c)" + "bool circle_quad_intersect(const circle &c, const quad &q)" + ], + "python": [ + "def circle_quad_intersect(c, q):" ], "csharp": [ - "public bool Conversation.IsReplying();", - "public static bool SplashKit.ConversationIsReplying(Conversation c);" + "public static bool SplashKit.CircleQuadIntersect(Circle c, Quad q);" ], "pascal": [ - "function ConversationIsReplying(c: Conversation): Boolean" + "function CircleQuadIntersect(const c: Circle; const q: Quad): Boolean" ] } }, { - "signature": "bool conversation_is_thinking(conversation c);", - "name": "conversation_is_thinking", - "method_name": "is_thinking", - "unique_global_name": "conversation_is_thinking", - "unique_method_name": "conversation.is_thinking", + "signature": "float circle_radius(const circle c);", + "name": "circle_radius", + "method_name": null, + "unique_global_name": "circle_radius", + "unique_method_name": null, "suffix_name": null, - "description": "Checks if a language model is currently \"thinking\" while generating a reply within a `conversation`.\nYou can use this to filter out the \"thoughts\" and display them differently (or hide them entirely)", + "description": "Returns the circle radius.", "brief": null, "return": { - "type": "bool", - "description": "Returns whether the language model is currently thinking while generating a reply", + "type": "float", + "description": "The radius of the circle", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -14848,10 +14757,10 @@ }, "parameters": { "c": { - "type": "conversation", - "description": "The `conversation` object to check", + "type": "circle", + "description": "The circle", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -14862,93 +14771,177 @@ } }, "attributes": { - "class": "conversation", - "method": "is_thinking", - "self": "c", - "group": "generative_ai", - "static": "generative_ai" + "group": "geometry", + "static": "geometry" }, "signatures": { - "python": [ - "def conversation_is_thinking(c):" - ], "cpp": [ - "bool conversation_is_thinking(conversation c)" + "float circle_radius(const circle c)" + ], + "python": [ + "def circle_radius(c):" ], "csharp": [ - "public bool Conversation.IsThinking();", - "public static bool SplashKit.ConversationIsThinking(Conversation c);" + "public static float SplashKit.CircleRadius(Circle c);" ], "pascal": [ - "function ConversationIsThinking(c: Conversation): Boolean" + "function CircleRadius(c: Circle): Single" ] } }, { - "signature": "conversation create_conversation();", - "name": "create_conversation", + "signature": "bool circle_ray_intersection(const point_2d &origin,const vector_2d &heading,const circle &circ);", + "name": "circle_ray_intersection", "method_name": null, - "unique_global_name": "create_conversation", + "unique_global_name": "circle_ray_intersection", "unique_method_name": null, "suffix_name": null, - "description": "Creates a new `conversation` object, that uses the default language model.\n\nThe `conversation` object can have messages added to it, and responses streamed back from it via the other Conversation functions and procedures", + "description": "Detects if a ray intersects a circle.", "brief": null, "return": { - "type": "conversation", - "description": "Returns a new `conversation` object.", + "type": "bool", + "description": "True if the ray intersects the circle, false otherwise", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "origin": { + "type": "point_2d", + "description": "The starting point of the ray", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "heading": { + "type": "vector_2d", + "description": "The direction of the ray as a vector", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "circ": { + "type": "circle", + "description": "The circle to check for intersection", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { - "class": "conversation", - "constructor": true, - "group": "generative_ai", - "static": "generative_ai" + "group": "geometry", + "static": "geometry" }, "signatures": { - "python": [ - "def create_conversation():" - ], "cpp": [ - "conversation create_conversation()" + "bool circle_ray_intersection(const point_2d &origin, const vector_2d &heading, const circle &circ)" + ], + "python": [ + "def circle_ray_intersection(origin, heading, circ):" ], "csharp": [ - "public static Conversation SplashKit.CreateConversation();", - "public Conversation();" + "public static bool SplashKit.CircleRayIntersection(Point2D origin, Vector2D heading, Circle circ);" ], "pascal": [ - "function CreateConversation(): Conversation" + "function CircleRayIntersection(const origin: Point2D; const heading: Vector2D; const circ: Circle): Boolean" ] } }, { - "signature": "conversation create_conversation(language_model model);", - "name": "create_conversation", + "signature": "bool circle_ray_intersection(const point_2d &origin,const vector_2d &heading,const circle &circ,point_2d &hit_point,double &hit_distance);", + "name": "circle_ray_intersection", "method_name": null, - "unique_global_name": "create_conversation_with_model", + "unique_global_name": "circle_ray_intersection_with_hit_point_and_distance", "unique_method_name": null, "suffix_name": null, - "description": "Creates a new `conversation` object, that uses a chosen language model.\n\nThe `conversation` object can have messages added to it, and responses streamed back from it via the other Conversation functions and procedures", + "description": "Detects if a ray intersects a circle. If an intersection is found, the\n`hit_point` and `hit_distance` are set to the point of intersection and the\ndistance from the ray's origin to the intersection point. If the ray's `origin`\nis contained within the circle, `hit_point` is set to the `origin` and `hit_distance`\nis set to 0. If no intersection is found, `hit_point` and `hit_distance` are not modified.", "brief": null, "return": { - "type": "conversation", - "description": "Returns a new `conversation` object.", + "type": "bool", + "description": "True if the ray intersects the circle, false otherwise", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "model": { - "type": "language_model", - "description": "The language model to use", + "origin": { + "type": "point_2d", + "description": "The starting point of the ray", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "heading": { + "type": "vector_2d", + "description": "The direction of the ray as a vector", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "circ": { + "type": "circle", + "description": "The circle to check for intersection", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "hit_point": { + "type": "point_2d", + "description": "The point to set to where the ray intersects the circle", "is_pointer": false, "is_const": false, - "is_reference": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "hit_distance": { + "type": "double", + "description": "The double to set to the distance from the ray's origin to\nthe intersection point", + "is_pointer": false, + "is_const": false, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -14958,80 +14951,101 @@ } }, "attributes": { - "class": "conversation", - "constructor": true, - "suffix": "with_model", - "group": "generative_ai", - "static": "generative_ai" + "suffix": "with_hit_point_and_distance", + "group": "geometry", + "static": "geometry" }, "signatures": { - "python": [ - "def create_conversation_with_model(model):" - ], "cpp": [ - "conversation create_conversation(language_model model)" + "bool circle_ray_intersection(const point_2d &origin, const vector_2d &heading, const circle &circ, point_2d &hit_point, double &hit_distance)" + ], + "python": [ + "def circle_ray_intersection_with_hit_point_and_distance(origin, heading, circ, hit_point, hit_distance):" ], "csharp": [ - "public static Conversation SplashKit.CreateConversation(LanguageModel model);", - "public Conversation(LanguageModel model);" + "public static bool SplashKit.CircleRayIntersection(Point2D origin, Vector2D heading, Circle circ, ref Point2D hitPoint, ref double hitDistance);" ], "pascal": [ - "function CreateConversation(model: LanguageModel): Conversation" + "function CircleRayIntersection(const origin: Point2D; const heading: Vector2D; const circ: Circle; var hitPoint: Point2D; var hitDistance: Double): Boolean" ] } }, { - "signature": "void free_all_conversations();", - "name": "free_all_conversations", - "method_name": "free_all", - "unique_global_name": "free_all_conversations", - "unique_method_name": ".free_all", + "signature": "bool circle_triangle_intersect(const circle &c,const triangle &tri);", + "name": "circle_triangle_intersect", + "method_name": null, + "unique_global_name": "circle_triangle_intersect", + "unique_method_name": null, "suffix_name": null, - "description": "Releases all of the `conversation` objects which have been loaded.", + "description": "Detects if a circle intersects with a triangle.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "True if the circle and triangle intersect", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "c": { + "type": "circle", + "description": "The circle to test", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "tri": { + "type": "triangle", + "description": "The triangle to test", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { - "method": "free_all", - "static": "generative_ai", - "group": "generative_ai" + "group": "geometry", + "static": "geometry" }, "signatures": { - "python": [ - "def free_all_conversations():" - ], "cpp": [ - "void free_all_conversations()" + "bool circle_triangle_intersect(const circle &c, const triangle &tri)" + ], + "python": [ + "def circle_triangle_intersect(c, tri):" ], "csharp": [ - "public static void GenerativeAi.FreeAll();", - "public static void SplashKit.FreeAllConversations();" + "public static bool SplashKit.CircleTriangleIntersect(Circle c, Triangle tri);" ], "pascal": [ - "procedure FreeAllConversations()" + "function CircleTriangleIntersect(const c: Circle; const tri: Triangle): Boolean" ] } }, { - "signature": "void free_conversation(conversation c);", - "name": "free_conversation", - "method_name": "free", - "unique_global_name": "free_conversation", - "unique_method_name": "conversation.free", + "signature": "bool circle_triangle_intersect(const circle &c,const triangle &tri,point_2d &p);", + "name": "circle_triangle_intersect", + "method_name": null, + "unique_global_name": "circle_triangle_intersect_get_closest_point", + "unique_method_name": null, "suffix_name": null, - "description": "Frees the resources associated with the `conversation` object.", + "description": "Detects if a circle intersects with a triangle. The closest point on the\ntriangle to the circle is assigned to p, even if the circle and triangle do not\nintersect. If the centre of the circle is inside the triangle,\nthe point assigned to p is the centre of the circle.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "True if the circle and triangle intersect", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -15039,80 +15053,89 @@ }, "parameters": { "c": { - "type": "conversation", - "description": "The `conversation` object whose resources should be released.", + "type": "circle", + "description": "The circle to test", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "conversation", - "destructor": true, - "method": "free", - "self": "c", - "group": "generative_ai", - "static": "generative_ai" + }, + "tri": { + "type": "triangle", + "description": "The triangle to test", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "p": { + "type": "point_2d", + "description": "The point to set to the closest point on the triangle to the circle", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } + }, + "attributes": { + "suffix": "get_closest_point", + "group": "geometry", + "static": "geometry" }, "signatures": { - "python": [ - "def free_conversation(c):" - ], "cpp": [ - "void free_conversation(conversation c)" + "bool circle_triangle_intersect(const circle &c, const triangle &tri, point_2d &p)" + ], + "python": [ + "def circle_triangle_intersect_get_closest_point(c, tri, p):" ], "csharp": [ - "public void Conversation.Free();", - "public static void SplashKit.FreeConversation(Conversation c);" + "public static bool SplashKit.CircleTriangleIntersect(Circle c, Triangle tri, ref Point2D p);" ], "pascal": [ - "procedure FreeConversation(c: Conversation)" + "function CircleTriangleIntersect(const c: Circle; const tri: Triangle; var p: Point2D): Boolean" ] } }, { - "signature": "string generate_reply(language_model model,string prompt);", - "name": "generate_reply", + "signature": "float circle_x(const circle &c);", + "name": "circle_x", "method_name": null, - "unique_global_name": "generate_reply_with_model", + "unique_global_name": "circle_x", "unique_method_name": null, "suffix_name": null, - "description": "Generates a reply to a textual prompt by a language model\n\nThe language model will respond to the textual prompt in a chat style format. It will follow instructions and answer questions.\nInstruct or Thinking models are recommended. Base models likely won't output sensible results.", + "description": "Returns the circle x value.", "brief": null, "return": { - "type": "string", - "description": "The generated reply.", + "type": "float", + "description": "The x location of the center of the circle", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "model": { - "type": "language_model", - "description": "The language model to use", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "prompt": { - "type": "string", - "description": "The prompt for the language model to reply to.", + "c": { + "type": "circle", + "description": "The circle", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -15122,49 +15145,48 @@ } }, "attributes": { - "suffix": "with_model", - "group": "generative_ai", - "static": "generative_ai" + "group": "geometry", + "static": "geometry" }, "signatures": { - "python": [ - "def generate_reply_with_model(model, prompt):" - ], "cpp": [ - "string generate_reply(language_model model, string prompt)" + "float circle_x(const circle &c)" + ], + "python": [ + "def circle_x(c):" ], "csharp": [ - "public static string SplashKit.GenerateReply(LanguageModel model, string prompt);" + "public static float SplashKit.CircleX(Circle c);" ], "pascal": [ - "function GenerateReply(model: LanguageModel; prompt: String): String" + "function CircleX(const c: Circle): Single" ] } }, { - "signature": "string generate_reply(string prompt);", - "name": "generate_reply", + "signature": "float circle_y(const circle &c);", + "name": "circle_y", "method_name": null, - "unique_global_name": "generate_reply", + "unique_global_name": "circle_y", "unique_method_name": null, "suffix_name": null, - "description": "Generates a reply to a textual prompt by a language model\n\nThe language model will respond to the textual prompt in a chat style format. It will follow instructions and answer questions.\nInstruct or Thinking models are recommended. Base models likely won't output sensible results.", + "description": "Returns the circle y value.", "brief": null, "return": { - "type": "string", - "description": "The generated reply.", + "type": "float", + "description": "The y location of the center of the circle", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "prompt": { - "type": "string", - "description": "The prompt for the language model to reply to.", + "c": { + "type": "circle", + "description": "The circle", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -15174,45 +15196,45 @@ } }, "attributes": { - "group": "generative_ai", - "static": "generative_ai" + "group": "geometry", + "static": "geometry" }, "signatures": { - "python": [ - "def generate_reply(prompt):" - ], "cpp": [ - "string generate_reply(string prompt)" + "float circle_y(const circle &c)" + ], + "python": [ + "def circle_y(c):" ], "csharp": [ - "public static string SplashKit.GenerateReply(string prompt);" + "public static float SplashKit.CircleY(Circle c);" ], "pascal": [ - "function GenerateReply(prompt: String): String" + "function CircleY(const c: Circle): Single" ] } }, { - "signature": "string generate_text(language_model model,string text);", - "name": "generate_text", + "signature": "bool circles_intersect(circle c1,circle c2);", + "name": "circles_intersect", "method_name": null, - "unique_global_name": "generate_text_with_model", + "unique_global_name": "circles_intersect", "unique_method_name": null, "suffix_name": null, - "description": "Generates text that continues from a prompt, with a maximum of 125 tokens.\n\nThe language model will continue predicting text based on patterns in the prompt - it will not directly follow instructions or answer questions.\nBase models are recommended; Instruct and Thinking models may work.", + "description": "Detects if two circles intersect. This can be used to detect collisions between\nbounding circles.", "brief": null, "return": { - "type": "string", - "description": "The generated reply.", + "type": "bool", + "description": "True if the two circles do intersect", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "model": { - "type": "language_model", - "description": "The language model to use", + "c1": { + "type": "circle", + "description": "The circle to test if intersects with c2", "is_pointer": false, "is_const": false, "is_reference": false, @@ -15223,9 +15245,9 @@ "is_vector": false, "type_parameter": null }, - "text": { - "type": "string", - "description": "The input text for the language model to continue.", + "c2": { + "type": "circle", + "description": "The circle to test if intersects with c1", "is_pointer": false, "is_const": false, "is_reference": false, @@ -15238,46 +15260,45 @@ } }, "attributes": { - "suffix": "with_model", - "group": "generative_ai", - "static": "generative_ai" + "group": "geometry", + "static": "geometry" }, "signatures": { - "python": [ - "def generate_text_with_model(model, text):" - ], "cpp": [ - "string generate_text(language_model model, string text)" + "bool circles_intersect(circle c1, circle c2)" + ], + "python": [ + "def circles_intersect(c1, c2):" ], "csharp": [ - "public static string SplashKit.GenerateText(LanguageModel model, string text);" + "public static bool SplashKit.CirclesIntersect(Circle c1, Circle c2);" ], "pascal": [ - "function GenerateText(model: LanguageModel; text: String): String" + "function CirclesIntersect(c1: Circle; c2: Circle): Boolean" ] } }, { - "signature": "string generate_text(language_model model,string text,int max_tokens);", - "name": "generate_text", + "signature": "bool circles_intersect(double c1_x,double c1_y,double c1_radius,double c2_x,double c2_y,double c2_radius);", + "name": "circles_intersect", "method_name": null, - "unique_global_name": "generate_text_with_model_and_tokens", + "unique_global_name": "circles_intersect_using_values", "unique_method_name": null, "suffix_name": null, - "description": "Generates text that continues from a prompt, with a maximum of 125 tokens.\n\nThe language model will continue predicting text based on patterns in the prompt - it will not directly follow instructions or answer questions.\nBase models are recommended; Instruct and Thinking models may work.", + "description": "Detects if two circles intersect. This can be used to detect collisions between\nbounding circles. The circle data is passed in as individual values.", "brief": null, "return": { - "type": "string", - "description": "The generated reply.", + "type": "bool", + "description": "true when the two circles intersect", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "model": { - "type": "language_model", - "description": "The language model to use", + "c1_x": { + "type": "double", + "description": "the x location of the first circle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -15288,9 +15309,9 @@ "is_vector": false, "type_parameter": null }, - "text": { - "type": "string", - "description": "The input text for the language model to continue.", + "c1_y": { + "type": "double", + "description": "the y location of the first circle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -15301,9 +15322,9 @@ "is_vector": false, "type_parameter": null }, - "max_tokens": { - "type": "int", - "description": "The maximum tokens used in response - determining the length of the output and the time taken. Keep this small for reasonable execution times.", + "c1_radius": { + "type": "double", + "description": "the radius of the first circle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -15313,49 +15334,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "suffix": "with_model_and_tokens", - "group": "generative_ai", - "static": "generative_ai" - }, - "signatures": { - "python": [ - "def generate_text_with_model_and_tokens(model, text, max_tokens):" - ], - "cpp": [ - "string generate_text(language_model model, string text, int max_tokens)" - ], - "csharp": [ - "public static string SplashKit.GenerateText(LanguageModel model, string text, int maxTokens);" - ], - "pascal": [ - "function GenerateText(model: LanguageModel; text: String; maxTokens: Integer): String" - ] - } - }, - { - "signature": "string generate_text(string text);", - "name": "generate_text", - "method_name": null, - "unique_global_name": "generate_text", - "unique_method_name": null, - "suffix_name": null, - "description": "Generates text that continues from a prompt - with default of 125 tokens.\n\nThe language model will continue predicting text based on patterns in the prompt - it will not directly follow instructions or answer questions.\nBase models are recommended; Instruct and Thinking models may work.", - "brief": null, - "return": { - "type": "string", - "description": "The generated reply.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "text": { - "type": "string", - "description": "The input text for the language model to continue.", + }, + "c2_x": { + "type": "double", + "description": "the x location of the second circle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -15365,48 +15347,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "group": "generative_ai", - "static": "generative_ai" - }, - "signatures": { - "python": [ - "def generate_text(text):" - ], - "cpp": [ - "string generate_text(string text)" - ], - "csharp": [ - "public static string SplashKit.GenerateText(string text);" - ], - "pascal": [ - "function GenerateText(text: String): String" - ] - } - }, - { - "signature": "string generate_text(string text,int max_tokens);", - "name": "generate_text", - "method_name": null, - "unique_global_name": "generate_text_with_tokens", - "unique_method_name": null, - "suffix_name": null, - "description": "Generates text that continues from a prompt.\n\nThe language model will continue predicting text based on patterns in the prompt - it will not directly follow instructions or answer questions.\nBase models are recommended; Instruct and Thinking models may work.", - "brief": null, - "return": { - "type": "string", - "description": "The generated reply.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "text": { - "type": "string", - "description": "The input text for the language model to continue.", + }, + "c2_y": { + "type": "double", + "description": "the y location of the second circle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -15417,9 +15361,9 @@ "is_vector": false, "type_parameter": null }, - "max_tokens": { - "type": "int", - "description": "The maximum tokens used in response - determining the length of the output and the time taken. Keep this small for reasonable execution times.", + "c2_radius": { + "type": "double", + "description": "the radius of the second circle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -15432,156 +15376,59 @@ } }, "attributes": { - "suffix": "with_tokens", - "group": "generative_ai", - "static": "generative_ai" + "suffix": "using_values", + "group": "geometry", + "static": "geometry" }, "signatures": { - "python": [ - "def generate_text_with_tokens(text, max_tokens):" - ], "cpp": [ - "string generate_text(string text, int max_tokens)" + "bool circles_intersect(double c1_x, double c1_y, double c1_radius, double c2_x, double c2_y, double c2_radius)" + ], + "python": [ + "def circles_intersect_using_values(c1_x, c1_y, c1_radius, c2_x, c2_y, c2_radius):" ], "csharp": [ - "public static string SplashKit.GenerateText(string text, int maxTokens);" + "public static bool SplashKit.CirclesIntersect(double c1X, double c1Y, double c1Radius, double c2X, double c2Y, double c2Radius);" ], "pascal": [ - "function GenerateText(text: String; maxTokens: Integer): String" + "function CirclesIntersect(c1X: Double; c1Y: Double; c1Radius: Double; c2X: Double; c2Y: Double; c2Radius: Double): Boolean" ] } - } - ], - "typedefs": [ - { - "signature": "typedef struct sk_conversation *conversation;", - "name": "conversation", - "description": "The `conversation` type is used to refer to conversations between the user\nand a language model. You can use it to send messages to the language model,\nand stream responses back.\n\n\nAll `conversation` objects are:\n\n\n- created with `create_conversation()`, `create_conversation(language_model model)`\n\n\n- and must be released using `free_conversation()` (to release a specific `conversation` object)\nor `free_all_conversation()` (to release all created `conversation` objects).", - "brief": null, - "attributes": { - "class": "conversation", - "group": "generative_ai", - "static": "generative_ai" - }, - "is_function_pointer": false, - "aliased_type": null, - "aliased_identifier": null, - "is_pointer": false, - "new_identifier": null - } - ], - "structs": [ - - ], - "enums": [ - { - "signature": "enum language_model {QWEN3_0_6B_BASE = 4,QWEN3_0_6B_INSTRUCT = 5,QWEN3_0_6B_THINKING = 6,QWEN3_1_7B_BASE = 8,QWEN3_1_7B_INSTRUCT = 9,QWEN3_1_7B_THINKING = 10,QWEN3_4B_BASE = 12,QWEN3_4B_INSTRUCT = 13,QWEN3_4B_THINKING = 14,GEMMA3_270M_BASE = 16,GEMMA3_270M_INSTRUCT = 17,GEMMA3_1B_BASE = 20,GEMMA3_1B_INSTRUCT = 21,GEMMA3_4B_BASE = 24,GEMMA3_4B_INSTRUCT = 25,};", - "name": "language_model", - "description": "Language Models:\nChoose between different language models to trade off speed and intelligence\nEach model is scaled to fit within 1~2GB and will be automatically downloaded when needed - feel free to try them out!", - "brief": null, - "constants": { - "QWEN3_0_6B_BASE": { - "description": "Qwen3 0.6B Base model - small, extremely fast and good for text completion. Very limited world knowledge.", - "number": 4 - }, - "QWEN3_0_6B_INSTRUCT": { - "description": "Qwen3 0.6B Instruct model (default) - small, extremely fast and can follow simple instructions. Very limited world knowledge.", - "number": 5 - }, - "QWEN3_0_6B_THINKING": { - "description": "Qwen3 0.6B Thinking model - small, extremely fast and can follow more specific instructions, but has a short delay before starting to reply. Very limited world knowledge.", - "number": 6 - }, - "QWEN3_1_7B_BASE": { - "description": "Qwen3 1.7B Base model - decently fast and good for text completion. Limited world knowledge.", - "number": 8 - }, - "QWEN3_1_7B_INSTRUCT": { - "description": "Qwen3 1.7B Instruct model - decently fast and can follow instructions. Limited world knowledge.", - "number": 9 - }, - "QWEN3_1_7B_THINKING": { - "description": "Qwen3 1.7B Thinking model - decently fast and can follow more difficult instructions, but has a delay before starting to reply. Limited world knowledge.", - "number": 10 - }, - "QWEN3_4B_BASE": { - "description": "Qwen3 4B Base model - slower but excellent for text completion/pattern based completion", - "number": 12 - }, - "QWEN3_4B_INSTRUCT": { - "description": "Qwen3 4B Instruct model - slower but can follow complex instructions", - "number": 13 - }, - "QWEN3_4B_THINKING": { - "description": "Qwen3 4B Thinking model - slower but can follow complex and specific instructions, but has a potentially long delay before starting to reply", - "number": 14 - }, - "GEMMA3_270M_BASE": { - "description": "Gemma3 270M Base model - tiny, extremely fast, and good for text completion. Very limited world knowledge.", - "number": 16 - }, - "GEMMA3_270M_INSTRUCT": { - "description": "Gemma3 270M Instruct model - tiny, extremely fast, and good for very simple instructions. Very limited world knowledge.", - "number": 17 - }, - "GEMMA3_1B_BASE": { - "description": "Gemma3 1B Base model - fast and good for text completion. Has decent world knowledge and multilingual abilities.", - "number": 20 - }, - "GEMMA3_1B_INSTRUCT": { - "description": "Gemma3 1B Instruct model - fast and can follow instructions. Has decent world knowledge and multilingual abilities.", - "number": 21 - }, - "GEMMA3_4B_BASE": { - "description": "Gemma3 4B Base model - slower but good for text completion/pattern based completion. Has decent world knowledge and multilingual abilities.", - "number": 24 - }, - "GEMMA3_4B_INSTRUCT": { - "description": "Gemma3 4B Instruct model - slower but can follow complex instructions. Has decent world knowledge and multilingual abilities.", - "number": 25 - } - }, - "attributes": { - "group": "generative_ai", - "static": "generative_ai" - }, - "signatures": { - "python": "public enum {LanguageModel.qwen3_0_6b_base = 4, LanguageModel.qwen3_0_6b_instruct = 5, LanguageModel.qwen3_0_6b_thinking = 6, LanguageModel.qwen3_1_7b_base = 8, LanguageModel.qwen3_1_7b_instruct = 9, LanguageModel.qwen3_1_7b_thinking = 10, LanguageModel.qwen3_4b_base = 12, LanguageModel.qwen3_4b_instruct = 13, LanguageModel.qwen3_4b_thinking = 14, LanguageModel.gemma3_270m_base = 16, LanguageModel.gemma3_270m_instruct = 17, LanguageModel.gemma3_1b_base = 20, LanguageModel.gemma3_1b_instruct = 21, LanguageModel.gemma3_4b_base = 24, LanguageModel.gemma3_4b_instruct = 25}", - "cpp": "class language_model {QWEN3_0_6B_BASE = 4, QWEN3_0_6B_INSTRUCT = 5, QWEN3_0_6B_THINKING = 6, QWEN3_1_7B_BASE = 8, QWEN3_1_7B_INSTRUCT = 9, QWEN3_1_7B_THINKING = 10, QWEN3_4B_BASE = 12, QWEN3_4B_INSTRUCT = 13, QWEN3_4B_THINKING = 14, GEMMA3_270M_BASE = 16, GEMMA3_270M_INSTRUCT = 17, GEMMA3_1B_BASE = 20, GEMMA3_1B_INSTRUCT = 21, GEMMA3_4B_BASE = 24, GEMMA3_4B_INSTRUCT = 25};", - "csharp": "public enum {LanguageModel.Qwen306BBase = 4, LanguageModel.Qwen306BInstruct = 5, LanguageModel.Qwen306BThinking = 6, LanguageModel.Qwen317BBase = 8, LanguageModel.Qwen317BInstruct = 9, LanguageModel.Qwen317BThinking = 10, LanguageModel.Qwen34BBase = 12, LanguageModel.Qwen34BInstruct = 13, LanguageModel.Qwen34BThinking = 14, LanguageModel.Gemma3270mBase = 16, LanguageModel.Gemma3270mInstruct = 17, LanguageModel.Gemma31BBase = 20, LanguageModel.Gemma31BInstruct = 21, LanguageModel.Gemma34BBase = 24, LanguageModel.Gemma34BInstruct = 25}", - "pascal": "public enum {LanguageModel.Qwen306BBase = 4, LanguageModel.Qwen306BInstruct = 5, LanguageModel.Qwen306BThinking = 6, LanguageModel.Qwen317BBase = 8, LanguageModel.Qwen317BInstruct = 9, LanguageModel.Qwen317BThinking = 10, LanguageModel.Qwen34BBase = 12, LanguageModel.Qwen34BInstruct = 13, LanguageModel.Qwen34BThinking = 14, LanguageModel.Gemma3270mBase = 16, LanguageModel.Gemma3270mInstruct = 17, LanguageModel.Gemma31BBase = 20, LanguageModel.Gemma31BInstruct = 21, LanguageModel.Gemma34BBase = 24, LanguageModel.Gemma34BInstruct = 25}" - } - } - ], - "defines": [ - - ] - }, - "geometry": { - "brief": "SplashKit's geometry functions assist with geometry-related computations.", - "description": "", - "functions": [ + }, { - "signature": "point_2d center_point(const circle &c);", - "name": "center_point", + "signature": "point_2d closest_point_on_circle(const point_2d &from_pt,const circle &c);", + "name": "closest_point_on_circle", "method_name": null, - "unique_global_name": "center_point", + "unique_global_name": "closest_point_on_circle", "unique_method_name": null, "suffix_name": null, - "description": "Returns the center point of the circle.", + "description": "Returns the closest point on a circle's circumference to\na given point. If the point is equal to the center of the circle,\nthe center point is returned.", "brief": null, "return": { "type": "point_2d", - "description": "The center point of the circle", + "description": "The point on `c`'s circumference that is closest to\n`from_point`, or the center of the circle if the\npoint equals `c`'s center.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "from_pt": { + "type": "point_2d", + "description": "The point to test from", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "c": { "type": "circle", - "description": "The circle to get the center point", + "description": "The circle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -15598,41 +15445,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def center_point(c):" - ], "cpp": [ - "point_2d center_point(const circle &c)" + "point_2d closest_point_on_circle(const point_2d &from_pt, const circle &c)" + ], + "python": [ + "def closest_point_on_circle(from_pt, c):" ], "csharp": [ - "public static Point2D SplashKit.CenterPoint(Circle c);" + "public static Point2D SplashKit.ClosestPointOnCircle(Point2D fromPt, Circle c);" ], "pascal": [ - "function CenterPoint(const c: Circle): Point2D" + "function ClosestPointOnCircle(const fromPt: Point2D; const c: Circle): Point2D" ] } }, { - "signature": "circle circle_at(const point_2d &pt,double radius);", - "name": "circle_at", + "signature": "point_2d closest_point_on_line_from_circle(const circle &c,const line &l);", + "name": "closest_point_on_line_from_circle", "method_name": null, - "unique_global_name": "circle_at", + "unique_global_name": "closest_point_on_line_from_circle", "unique_method_name": null, "suffix_name": null, - "description": "Returns a circle at the indicated point and radius.", + "description": "Returns the closest point on a line to a circle.", "brief": null, "return": { - "type": "circle", - "description": "A circle at the indicatd point and radius", + "type": "point_2d", + "description": "The point that is closest to `c` on `l`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { - "type": "point_2d", - "description": "The location of the center of the circle", + "c": { + "type": "circle", + "description": "The circle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -15643,12 +15490,12 @@ "is_vector": false, "type_parameter": null }, - "radius": { - "type": "double", - "description": "The radius of the circle", + "l": { + "type": "line", + "description": "The line", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -15662,57 +15509,44 @@ "static": "geometry" }, "signatures": { - "python": [ - "def circle_at(pt, radius):" - ], "cpp": [ - "circle circle_at(const point_2d &pt, double radius)" + "point_2d closest_point_on_line_from_circle(const circle &c, const line &l)" + ], + "python": [ + "def closest_point_on_line_from_circle(c, l):" ], "csharp": [ - "public static Circle SplashKit.CircleAt(Point2D pt, double radius);" + "public static Point2D SplashKit.ClosestPointOnLineFromCircle(Circle c, Line l);" ], "pascal": [ - "function CircleAt(const pt: Point2D; radius: Double): Circle" + "function ClosestPointOnLineFromCircle(const c: Circle; const l: Line): Point2D" ] } }, { - "signature": "circle circle_at(double x,double y,double radius);", - "name": "circle_at", + "signature": "point_2d closest_point_on_rect_from_circle(const circle &c,const rectangle &rect);", + "name": "closest_point_on_rect_from_circle", "method_name": null, - "unique_global_name": "circle_at_from_points", + "unique_global_name": "closest_point_on_rect_from_circle", "unique_method_name": null, "suffix_name": null, - "description": "Returns a circle at the indicated point and radius.", + "description": "Returns the closest point on a rectangle's perimeter to a circle.", "brief": null, "return": { - "type": "circle", - "description": "A circle at the indicatd point and radius", + "type": "point_2d", + "description": "The point that is closest to `c` on `rect`'s perimeter", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "x": { - "type": "double", - "description": "The x location of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location of the circle", + "c": { + "type": "circle", + "description": "The circle", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -15720,12 +15554,12 @@ "is_vector": false, "type_parameter": null }, - "radius": { - "type": "double", - "description": "The radius of the circle", + "rect": { + "type": "rectangle", + "description": "The rectangle", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -15735,37 +15569,36 @@ } }, "attributes": { - "suffix": "from_points", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def circle_at_from_points(x, y, radius):" - ], "cpp": [ - "circle circle_at(double x, double y, double radius)" + "point_2d closest_point_on_rect_from_circle(const circle &c, const rectangle &rect)" + ], + "python": [ + "def closest_point_on_rect_from_circle(c, rect):" ], "csharp": [ - "public static Circle SplashKit.CircleAt(double x, double y, double radius);" + "public static Point2D SplashKit.ClosestPointOnRectFromCircle(Circle c, Rectangle rect);" ], "pascal": [ - "function CircleAt(x: Double; y: Double; radius: Double): Circle" + "function ClosestPointOnRectFromCircle(const c: Circle; const rect: Rectangle): Point2D" ] } }, { - "signature": "bool circle_quad_intersect(const circle &c,const quad &q);", - "name": "circle_quad_intersect", + "signature": "point_2d closest_point_on_triangle_from_circle(const circle &c,const triangle &tri);", + "name": "closest_point_on_triangle_from_circle", "method_name": null, - "unique_global_name": "circle_quad_intersect", + "unique_global_name": "closest_point_on_triangle_from_circle", "unique_method_name": null, "suffix_name": null, - "description": "Detects if a circle intersects with a quad.", + "description": "Calculates the closest point on a triangle to a circle. If the circle and\ntriangle do not intersect, the closest point on the triangle to the circle\nis returned. If the circle and triangle do intersect, the center of the\ncircle is returned.", "brief": null, "return": { - "type": "bool", - "description": "True if the circle and quad intersect, false otherwise", + "type": "point_2d", + "description": "The closest point on the triangle to the circle", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -15785,9 +15618,9 @@ "is_vector": false, "type_parameter": null }, - "q": { - "type": "quad", - "description": "The quad to test", + "tri": { + "type": "triangle", + "description": "The triangle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -15804,44 +15637,57 @@ "static": "geometry" }, "signatures": { - "python": [ - "def circle_quad_intersect(c, q):" - ], "cpp": [ - "bool circle_quad_intersect(const circle &c, const quad &q)" + "point_2d closest_point_on_triangle_from_circle(const circle &c, const triangle &tri)" + ], + "python": [ + "def closest_point_on_triangle_from_circle(c, tri):" ], "csharp": [ - "public static bool SplashKit.CircleQuadIntersect(Circle c, Quad q);" + "public static Point2D SplashKit.ClosestPointOnTriangleFromCircle(Circle c, Triangle tri);" ], "pascal": [ - "function CircleQuadIntersect(const c: Circle; const q: Quad): Boolean" + "function ClosestPointOnTriangleFromCircle(const c: Circle; const tri: Triangle): Point2D" ] } }, { - "signature": "float circle_radius(const circle c);", - "name": "circle_radius", + "signature": "point_2d distant_point_on_circle(const point_2d &pt,const circle &c);", + "name": "distant_point_on_circle", "method_name": null, - "unique_global_name": "circle_radius", + "unique_global_name": "distant_point_on_circle", "unique_method_name": null, "suffix_name": null, - "description": "Returns the circle radius.", + "description": "The furthest point on the circle to the given point.", "brief": null, "return": { - "type": "float", - "description": "The radius of the circle", + "type": "point_2d", + "description": "The point on c that is furthest from `pt`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "pt": { + "type": "point_2d", + "description": "The point to test from", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "c": { "type": "circle", - "description": "The circle", + "description": "The circle you want to get a point on its circumference", "is_pointer": false, "is_const": true, - "is_reference": false, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -15855,41 +15701,54 @@ "static": "geometry" }, "signatures": { - "python": [ - "def circle_radius(c):" - ], "cpp": [ - "float circle_radius(const circle c)" + "point_2d distant_point_on_circle(const point_2d &pt, const circle &c)" + ], + "python": [ + "def distant_point_on_circle(pt, c):" ], "csharp": [ - "public static float SplashKit.CircleRadius(Circle c);" + "public static Point2D SplashKit.DistantPointOnCircle(Point2D pt, Circle c);" ], "pascal": [ - "function CircleRadius(c: Circle): Single" + "function DistantPointOnCircle(const pt: Point2D; const c: Circle): Point2D" ] } }, { - "signature": "bool circle_ray_intersection(const point_2d &origin,const vector_2d &heading,const circle &circ);", - "name": "circle_ray_intersection", + "signature": "bool distant_point_on_circle_heading(const point_2d &pt,const circle &c,const vector_2d &heading,point_2d &opposite_pt);", + "name": "distant_point_on_circle_heading", "method_name": null, - "unique_global_name": "circle_ray_intersection", + "unique_global_name": "distant_point_on_circle_heading", "unique_method_name": null, "suffix_name": null, - "description": "Detects if a ray intersects a circle.", + "description": "Determines the opposite side of a circle given a collision point and a\nheading.", "brief": null, "return": { "type": "bool", - "description": "True if the ray intersects the circle, false otherwise", + "description": "True when the `opposite_pt` is calculated, false when\nthe point would not collide with the circle when\nheading as indicated.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "origin": { + "pt": { "type": "point_2d", - "description": "The starting point of the ray", + "description": "The point from which the test is being made", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "c": { + "type": "circle", + "description": "The circle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -15902,7 +15761,7 @@ }, "heading": { "type": "vector_2d", - "description": "The direction of the ray as a vector", + "description": "The direction the point is heading", "is_pointer": false, "is_const": true, "is_reference": true, @@ -15913,11 +15772,11 @@ "is_vector": false, "type_parameter": null }, - "circ": { - "type": "circle", - "description": "The circle to check for intersection", + "opposite_pt": { + "type": "point_2d", + "description": "After the call, this is set to the point on the\nopposite side of the circle from pt when it is\nheading in the given direction.", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -15932,41 +15791,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def circle_ray_intersection(origin, heading, circ):" - ], "cpp": [ - "bool circle_ray_intersection(const point_2d &origin, const vector_2d &heading, const circle &circ)" + "bool distant_point_on_circle_heading(const point_2d &pt, const circle &c, const vector_2d &heading, point_2d &opposite_pt)" + ], + "python": [ + "def distant_point_on_circle_heading(pt, c, heading, opposite_pt):" ], "csharp": [ - "public static bool SplashKit.CircleRayIntersection(Point2D origin, Vector2D heading, Circle circ);" + "public static bool SplashKit.DistantPointOnCircleHeading(Point2D pt, Circle c, Vector2D heading, ref Point2D oppositePt);" ], "pascal": [ - "function CircleRayIntersection(const origin: Point2D; const heading: Vector2D; const circ: Circle): Boolean" + "function DistantPointOnCircleHeading(const pt: Point2D; const c: Circle; const heading: Vector2D; var oppositePt: Point2D): Boolean" ] } }, { - "signature": "bool circle_ray_intersection(const point_2d &origin,const vector_2d &heading,const circle &circ,point_2d &hit_point,double &hit_distance);", - "name": "circle_ray_intersection", + "signature": "float ray_circle_intersect_distance(const point_2d &ray_origin,const vector_2d &ray_heading,const circle &c);", + "name": "ray_circle_intersect_distance", "method_name": null, - "unique_global_name": "circle_ray_intersection_with_hit_point_and_distance", + "unique_global_name": "ray_circle_intersect_distance", "unique_method_name": null, "suffix_name": null, - "description": "Detects if a ray intersects a circle. If an intersection is found, the\n`hit_point` and `hit_distance` are set to the point of intersection and the\ndistance from the ray's origin to the intersection point. If the ray's `origin`\nis contained within the circle, `hit_point` is set to the `origin` and `hit_distance`\nis set to 0. If no intersection is found, `hit_point` and `hit_distance` are not modified.", + "description": "Calculates the distance from a ray cast from a point to a given circle.", "brief": null, "return": { - "type": "bool", - "description": "True if the ray intersects the circle, false otherwise", + "type": "float", + "description": "-1 if the ray does not hit the circle, otherwise the\ndistance from the origin to the circle bounds.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "origin": { + "ray_origin": { "type": "point_2d", - "description": "The starting point of the ray", + "description": "The origin of the ray", "is_pointer": false, "is_const": true, "is_reference": true, @@ -15977,9 +15836,9 @@ "is_vector": false, "type_parameter": null }, - "heading": { + "ray_heading": { "type": "vector_2d", - "description": "The direction of the ray as a vector", + "description": "The direction of the ray", "is_pointer": false, "is_const": true, "is_reference": true, @@ -15990,87 +15849,73 @@ "is_vector": false, "type_parameter": null }, - "circ": { + "c": { "type": "circle", - "description": "The circle to check for intersection", + "description": "The circle being tested", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "hit_point": { - "type": "point_2d", - "description": "The point to set to where the ray intersects the circle", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "hit_distance": { - "type": "double", - "description": "The double to set to the distance from the ray's origin to\nthe intersection point", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "suffix": "with_hit_point_and_distance", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def circle_ray_intersection_with_hit_point_and_distance(origin, heading, circ, hit_point, hit_distance):" - ], "cpp": [ - "bool circle_ray_intersection(const point_2d &origin, const vector_2d &heading, const circle &circ, point_2d &hit_point, double &hit_distance)" + "float ray_circle_intersect_distance(const point_2d &ray_origin, const vector_2d &ray_heading, const circle &c)" + ], + "python": [ + "def ray_circle_intersect_distance(ray_origin, ray_heading, c):" ], "csharp": [ - "public static bool SplashKit.CircleRayIntersection(Point2D origin, Vector2D heading, Circle circ, ref Point2D hitPoint, ref double hitDistance);" + "public static float SplashKit.RayCircleIntersectDistance(Point2D rayOrigin, Vector2D rayHeading, Circle c);" ], "pascal": [ - "function CircleRayIntersection(const origin: Point2D; const heading: Vector2D; const circ: Circle; var hitPoint: Point2D; var hitDistance: Double): Boolean" + "function RayCircleIntersectDistance(const rayOrigin: Point2D; const rayHeading: Vector2D; const c: Circle): Single" ] } }, { - "signature": "bool circle_triangle_intersect(const circle &c,const triangle &tri);", - "name": "circle_triangle_intersect", + "signature": "bool tangent_points(const point_2d &from_pt,const circle &c,point_2d &p1,point_2d &p2);", + "name": "tangent_points", "method_name": null, - "unique_global_name": "circle_triangle_intersect", + "unique_global_name": "tangent_points", "unique_method_name": null, "suffix_name": null, - "description": "Detects if a circle intersects with a triangle.", + "description": "Returns the two tangent points on the circle given the indicated point.", "brief": null, "return": { "type": "bool", - "description": "True if the circle and triangle intersect", + "description": "True if `from_pt` is outside of the circle, and tangent\npoints are calculated", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "from_pt": { + "type": "point_2d", + "description": "The source point", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "c": { "type": "circle", - "description": "The circle to test", + "description": "The circle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -16081,11 +15926,24 @@ "is_vector": false, "type_parameter": null }, - "tri": { - "type": "triangle", - "description": "The triangle to test", + "p1": { + "type": "point_2d", + "description": "If this returns true, then `p1` contains one of the points", "is_pointer": false, - "is_const": true, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "p2": { + "type": "point_2d", + "description": "If this returns true, then `p2` contains one of the points", + "is_pointer": false, + "is_const": false, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -16100,32 +15958,32 @@ "static": "geometry" }, "signatures": { - "python": [ - "def circle_triangle_intersect(c, tri):" - ], "cpp": [ - "bool circle_triangle_intersect(const circle &c, const triangle &tri)" + "bool tangent_points(const point_2d &from_pt, const circle &c, point_2d &p1, point_2d &p2)" + ], + "python": [ + "def tangent_points(from_pt, c, p1, p2):" ], "csharp": [ - "public static bool SplashKit.CircleTriangleIntersect(Circle c, Triangle tri);" + "public static bool SplashKit.TangentPoints(Point2D fromPt, Circle c, ref Point2D p1, ref Point2D p2);" ], "pascal": [ - "function CircleTriangleIntersect(const c: Circle; const tri: Triangle): Boolean" + "function TangentPoints(const fromPt: Point2D; const c: Circle; var p1: Point2D; var p2: Point2D): Boolean" ] } }, { - "signature": "bool circle_triangle_intersect(const circle &c,const triangle &tri,point_2d &p);", - "name": "circle_triangle_intersect", + "signature": "void widest_points(const circle &c,const vector_2d &along,point_2d &pt1,point_2d &pt2);", + "name": "widest_points", "method_name": null, - "unique_global_name": "circle_triangle_intersect_get_closest_point", + "unique_global_name": "widest_points", "unique_method_name": null, "suffix_name": null, - "description": "Detects if a circle intersects with a triangle. The closest point on the\ntriangle to the circle is assigned to p, even if the circle and triangle do not\nintersect. If the centre of the circle is inside the triangle,\nthe point assigned to p is the centre of the circle.", + "description": "Calculates the two points on a circles radius that lie along the given\nvector. This represents the points on the circle when the vector is\nplaced at the circle's center point.", "brief": null, "return": { - "type": "bool", - "description": "True if the circle and triangle intersect", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, @@ -16134,7 +15992,7 @@ "parameters": { "c": { "type": "circle", - "description": "The circle to test", + "description": "The circle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -16145,9 +16003,9 @@ "is_vector": false, "type_parameter": null }, - "tri": { - "type": "triangle", - "description": "The triangle to test", + "along": { + "type": "vector_2d", + "description": "The vector representing the line along which the points lie.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -16158,9 +16016,22 @@ "is_vector": false, "type_parameter": null }, - "p": { + "pt1": { "type": "point_2d", - "description": "The point to set to the closest point on the triangle to the circle", + "description": "After the call, this is set to one of the widest points", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pt2": { + "type": "point_2d", + "description": "After the call, this is set to one of the widest points", "is_pointer": false, "is_const": false, "is_reference": true, @@ -16173,49 +16044,48 @@ } }, "attributes": { - "suffix": "get_closest_point", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def circle_triangle_intersect_get_closest_point(c, tri, p):" - ], "cpp": [ - "bool circle_triangle_intersect(const circle &c, const triangle &tri, point_2d &p)" + "void widest_points(const circle &c, const vector_2d &along, point_2d &pt1, point_2d &pt2)" + ], + "python": [ + "def widest_points(c, along, pt1, pt2):" ], "csharp": [ - "public static bool SplashKit.CircleTriangleIntersect(Circle c, Triangle tri, ref Point2D p);" + "public static void SplashKit.WidestPoints(Circle c, Vector2D along, ref Point2D pt1, ref Point2D pt2);" ], "pascal": [ - "function CircleTriangleIntersect(const c: Circle; const tri: Triangle; var p: Point2D): Boolean" + "procedure WidestPoints(const c: Circle; const along: Vector2D; var pt1: Point2D; var pt2: Point2D)" ] } }, { - "signature": "float circle_x(const circle &c);", - "name": "circle_x", + "signature": "float cosine(float degrees);", + "name": "cosine", "method_name": null, - "unique_global_name": "circle_x", + "unique_global_name": "cosine", "unique_method_name": null, "suffix_name": null, - "description": "Returns the circle x value.", + "description": "Returns the cosine of the supplied angle (in degrees).", "brief": null, "return": { "type": "float", - "description": "The x location of the center of the circle", + "description": "the cosine of the supplied angle (in degrees).", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "c": { - "type": "circle", - "description": "The circle", + "degrees": { + "type": "float", + "description": "The angle in degrees", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -16229,44 +16099,44 @@ "static": "geometry" }, "signatures": { - "python": [ - "def circle_x(c):" - ], "cpp": [ - "float circle_x(const circle &c)" + "float cosine(float degrees)" + ], + "python": [ + "def cosine(degrees):" ], "csharp": [ - "public static float SplashKit.CircleX(Circle c);" + "public static float SplashKit.Cosine(float degrees);" ], "pascal": [ - "function CircleX(const c: Circle): Single" + "function Cosine(degrees: Single): Single" ] } }, { - "signature": "float circle_y(const circle &c);", - "name": "circle_y", + "signature": "float sine(float degrees);", + "name": "sine", "method_name": null, - "unique_global_name": "circle_y", + "unique_global_name": "sine", "unique_method_name": null, "suffix_name": null, - "description": "Returns the circle y value.", + "description": "Returns the sine of the supplied angle (in degrees).", "brief": null, "return": { "type": "float", - "description": "The y location of the center of the circle", + "description": "the sine of the supplied angle (in degrees).", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "c": { - "type": "circle", - "description": "The circle", + "degrees": { + "type": "float", + "description": "The angle in degrees", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -16280,54 +16150,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def circle_y(c):" - ], "cpp": [ - "float circle_y(const circle &c)" + "float sine(float degrees)" + ], + "python": [ + "def sine(degrees):" ], "csharp": [ - "public static float SplashKit.CircleY(Circle c);" + "public static float SplashKit.Sine(float degrees);" ], "pascal": [ - "function CircleY(const c: Circle): Single" + "function Sine(degrees: Single): Single" ] } }, { - "signature": "bool circles_intersect(circle c1,circle c2);", - "name": "circles_intersect", + "signature": "float tangent(float degrees);", + "name": "tangent", "method_name": null, - "unique_global_name": "circles_intersect", + "unique_global_name": "tangent", "unique_method_name": null, "suffix_name": null, - "description": "Detects if two circles intersect. This can be used to detect collisions between\nbounding circles.", + "description": "Returns the tangent of the supplied angle (in degrees).", "brief": null, "return": { - "type": "bool", - "description": "True if the two circles do intersect", + "type": "float", + "description": "the tangent of the supplied angle (in degrees).", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "c1": { - "type": "circle", - "description": "The circle to test if intersects with c2", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "c2": { - "type": "circle", - "description": "The circle to test if intersects with c1", + "degrees": { + "type": "float", + "description": "The angle in degrees", "is_pointer": false, "is_const": false, "is_reference": false, @@ -16344,56 +16201,43 @@ "static": "geometry" }, "signatures": { - "python": [ - "def circles_intersect(c1, c2):" - ], "cpp": [ - "bool circles_intersect(circle c1, circle c2)" + "float tangent(float degrees)" + ], + "python": [ + "def tangent(degrees):" ], "csharp": [ - "public static bool SplashKit.CirclesIntersect(Circle c1, Circle c2);" + "public static float SplashKit.Tangent(float degrees);" ], "pascal": [ - "function CirclesIntersect(c1: Circle; c2: Circle): Boolean" + "function Tangent(degrees: Single): Single" ] } }, { - "signature": "bool circles_intersect(double c1_x,double c1_y,double c1_radius,double c2_x,double c2_y,double c2_radius);", - "name": "circles_intersect", + "signature": "point_2d closest_point_on_line(const point_2d from_pt,const line &l);", + "name": "closest_point_on_line", "method_name": null, - "unique_global_name": "circles_intersect_using_values", + "unique_global_name": "closest_point_on_line", "unique_method_name": null, "suffix_name": null, - "description": "Detects if two circles intersect. This can be used to detect collisions between\nbounding circles. The circle data is passed in as individual values.", + "description": "Gets the closest point on the line to a given point.", "brief": null, "return": { - "type": "bool", - "description": "true when the two circles intersect", + "type": "point_2d", + "description": "The point on the line that is closest to `from_pt`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "c1_x": { - "type": "double", - "description": "the x location of the first circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "c1_y": { - "type": "double", - "description": "the y location of the first circle", + "from_pt": { + "type": "point_2d", + "description": "The point to test (usually somewhere near the line)", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -16402,24 +16246,62 @@ "is_vector": false, "type_parameter": null }, - "c1_radius": { - "type": "double", - "description": "the radius of the first circle", + "l": { + "type": "line", + "description": "The line", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - }, - "c2_x": { - "type": "double", - "description": "the x location of the second circle", + } + }, + "attributes": { + "group": "geometry", + "static": "geometry" + }, + "signatures": { + "cpp": [ + "point_2d closest_point_on_line(const point_2d from_pt, const line &l)" + ], + "python": [ + "def closest_point_on_line(from_pt, l):" + ], + "csharp": [ + "public static Point2D SplashKit.ClosestPointOnLine(Point2D fromPt, Line l);" + ], + "pascal": [ + "function ClosestPointOnLine(fromPt: Point2D; const l: Line): Point2D" + ] + } + }, + { + "signature": "point_2d closest_point_on_lines(const point_2d from_pt,const vector &lines,int &line_idx);", + "name": "closest_point_on_lines", + "method_name": null, + "unique_global_name": "closest_point_on_lines", + "unique_method_name": null, + "suffix_name": null, + "description": "Get the point closest to `from pt` that is on one of the supplied lines.", + "brief": null, + "return": { + "type": "point_2d", + "description": "The point on one of the lines that is the closest point\non these lines to the `from pt`.", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "from_pt": { + "type": "point_2d", + "description": "The point to test", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -16428,25 +16310,25 @@ "is_vector": false, "type_parameter": null }, - "c2_y": { - "type": "double", - "description": "the y location of the second circle", + "lines": { + "type": "vector", + "description": "The lines to check", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ ], - "is_vector": false, - "type_parameter": null + "is_vector": true, + "type_parameter": "line" }, - "c2_radius": { - "type": "double", - "description": "the radius of the second circle", + "line_idx": { + "type": "int", + "description": "After the call this will store the index of the line that\nhad the matching point.", "is_pointer": false, "is_const": false, - "is_reference": false, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -16456,46 +16338,45 @@ } }, "attributes": { - "suffix": "using_values", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def circles_intersect_using_values(c1_x, c1_y, c1_radius, c2_x, c2_y, c2_radius):" - ], "cpp": [ - "bool circles_intersect(double c1_x, double c1_y, double c1_radius, double c2_x, double c2_y, double c2_radius)" + "point_2d closest_point_on_lines(const point_2d from_pt, const vector &lines, int &line_idx)" + ], + "python": [ + "def closest_point_on_lines(from_pt, lines, line_idx):" ], "csharp": [ - "public static bool SplashKit.CirclesIntersect(double c1X, double c1Y, double c1Radius, double c2X, double c2Y, double c2Radius);" + "public static Point2D SplashKit.ClosestPointOnLines(Point2D fromPt, List lines, ref int lineIdx);" ], "pascal": [ - "function CirclesIntersect(c1X: Double; c1Y: Double; c1Radius: Double; c2X: Double; c2Y: Double; c2Radius: Double): Boolean" + "function ClosestPointOnLines(fromPt: Point2D; const lines: ArrayOfLine; var lineIdx: Integer): Point2D" ] } }, { - "signature": "point_2d closest_point_on_circle(const point_2d &from_pt,const circle &c);", - "name": "closest_point_on_circle", + "signature": "line line_from(const point_2d &start,const point_2d &end_pt);", + "name": "line_from", "method_name": null, - "unique_global_name": "closest_point_on_circle", + "unique_global_name": "line_from_point_to_point", "unique_method_name": null, "suffix_name": null, - "description": "Returns the closest point on a circle's circumference to\na given point. If the point is equal to the center of the circle,\nthe center point is returned.", + "description": "Create a line from one point to another.", "brief": null, "return": { - "type": "point_2d", - "description": "The point on `c`'s circumference that is closest to\n`from_point`, or the center of the circle if the\npoint equals `c`'s center.", + "type": "line", + "description": "A line from the start to the end point", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "from_pt": { + "start": { "type": "point_2d", - "description": "The point to test from", + "description": "The start of the line", "is_pointer": false, "is_const": true, "is_reference": true, @@ -16506,9 +16387,9 @@ "is_vector": false, "type_parameter": null }, - "c": { - "type": "circle", - "description": "The circle", + "end_pt": { + "type": "point_2d", + "description": "The end of the line", "is_pointer": false, "is_const": true, "is_reference": true, @@ -16521,45 +16402,46 @@ } }, "attributes": { + "suffix": "point_to_point", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def closest_point_on_circle(from_pt, c):" - ], "cpp": [ - "point_2d closest_point_on_circle(const point_2d &from_pt, const circle &c)" + "line line_from(const point_2d &start, const point_2d &end_pt)" + ], + "python": [ + "def line_from_point_to_point(start, end_pt):" ], "csharp": [ - "public static Point2D SplashKit.ClosestPointOnCircle(Point2D fromPt, Circle c);" + "public static Line SplashKit.LineFrom(Point2D start, Point2D endPt);" ], "pascal": [ - "function ClosestPointOnCircle(const fromPt: Point2D; const c: Circle): Point2D" + "function LineFrom(const start: Point2D; const endPt: Point2D): Line" ] } }, { - "signature": "point_2d closest_point_on_line_from_circle(const circle &c,const line &l);", - "name": "closest_point_on_line_from_circle", + "signature": "line line_from(const point_2d &start,const vector_2d &offset);", + "name": "line_from", "method_name": null, - "unique_global_name": "closest_point_on_line_from_circle", + "unique_global_name": "line_from_start_with_offset", "unique_method_name": null, "suffix_name": null, - "description": "Returns the closest point on a line to a circle.", + "description": "Creates a line that starts at a point, and follows a given vector.", "brief": null, "return": { - "type": "point_2d", - "description": "The point that is closest to `c` on `l`", + "type": "line", + "description": "A line from the start to end point", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "c": { - "type": "circle", - "description": "The circle", + "start": { + "type": "point_2d", + "description": "The start of the line", "is_pointer": false, "is_const": true, "is_reference": true, @@ -16570,9 +16452,9 @@ "is_vector": false, "type_parameter": null }, - "l": { - "type": "line", - "description": "The line", + "offset": { + "type": "vector_2d", + "description": "The offset to the end of the line", "is_pointer": false, "is_const": true, "is_reference": true, @@ -16585,58 +16467,46 @@ } }, "attributes": { + "suffix": "start_with_offset", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def closest_point_on_line_from_circle(c, l):" - ], "cpp": [ - "point_2d closest_point_on_line_from_circle(const circle &c, const line &l)" + "line line_from(const point_2d &start, const vector_2d &offset)" + ], + "python": [ + "def line_from_start_with_offset(start, offset):" ], "csharp": [ - "public static Point2D SplashKit.ClosestPointOnLineFromCircle(Circle c, Line l);" + "public static Line SplashKit.LineFrom(Point2D start, Vector2D offset);" ], "pascal": [ - "function ClosestPointOnLineFromCircle(const c: Circle; const l: Line): Point2D" + "function LineFrom(const start: Point2D; const offset: Vector2D): Line" ] } }, { - "signature": "point_2d closest_point_on_rect_from_circle(const circle &c,const rectangle &rect);", - "name": "closest_point_on_rect_from_circle", + "signature": "line line_from(const vector_2d &v);", + "name": "line_from", "method_name": null, - "unique_global_name": "closest_point_on_rect_from_circle", + "unique_global_name": "line_from_vector", "unique_method_name": null, "suffix_name": null, - "description": "Returns the closest point on a rectangle's perimeter to a circle.", + "description": "Gets a line that goes from the origin and ends at the end of the vector.", "brief": null, "return": { - "type": "point_2d", - "description": "The point that is closest to `c` on `rect`'s perimeter", + "type": "line", + "description": "A line from the origin to the end point", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "c": { - "type": "circle", - "description": "The circle", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "The rectangle", + "v": { + "type": "vector_2d", + "description": "The offset from the origin for the end of the line", "is_pointer": false, "is_const": true, "is_reference": true, @@ -16649,48 +16519,49 @@ } }, "attributes": { + "suffix": "vector", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def closest_point_on_rect_from_circle(c, rect):" - ], "cpp": [ - "point_2d closest_point_on_rect_from_circle(const circle &c, const rectangle &rect)" + "line line_from(const vector_2d &v)" + ], + "python": [ + "def line_from_vector(v):" ], "csharp": [ - "public static Point2D SplashKit.ClosestPointOnRectFromCircle(Circle c, Rectangle rect);" + "public static Line SplashKit.LineFrom(Vector2D v);" ], "pascal": [ - "function ClosestPointOnRectFromCircle(const c: Circle; const rect: Rectangle): Point2D" + "function LineFrom(const v: Vector2D): Line" ] } }, { - "signature": "point_2d closest_point_on_triangle_from_circle(const circle &c,const triangle &tri);", - "name": "closest_point_on_triangle_from_circle", + "signature": "line line_from(double x1,double y1,double x2,double y2);", + "name": "line_from", "method_name": null, - "unique_global_name": "closest_point_on_triangle_from_circle", + "unique_global_name": "line_from", "unique_method_name": null, "suffix_name": null, - "description": "Calculates the closest point on a triangle to a circle. If the circle and\ntriangle do not intersect, the closest point on the triangle to the circle\nis returned. If the circle and triangle do intersect, the center of the\ncircle is returned.", + "description": "Create a line from one point to another.", "brief": null, "return": { - "type": "point_2d", - "description": "The closest point on the triangle to the circle", + "type": "line", + "description": "A line from the start to the end point", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "c": { - "type": "circle", - "description": "The circle to test", + "x1": { + "type": "double", + "description": "The x value of the start of the line", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -16698,63 +16569,25 @@ "is_vector": false, "type_parameter": null }, - "tri": { - "type": "triangle", - "description": "The triangle to test", + "y1": { + "type": "double", + "description": "The y value of the start of the line", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "group": "geometry", - "static": "geometry" - }, - "signatures": { - "python": [ - "def closest_point_on_triangle_from_circle(c, tri):" - ], - "cpp": [ - "point_2d closest_point_on_triangle_from_circle(const circle &c, const triangle &tri)" - ], - "csharp": [ - "public static Point2D SplashKit.ClosestPointOnTriangleFromCircle(Circle c, Triangle tri);" - ], - "pascal": [ - "function ClosestPointOnTriangleFromCircle(const c: Circle; const tri: Triangle): Point2D" - ] - } - }, - { - "signature": "point_2d distant_point_on_circle(const point_2d &pt,const circle &c);", - "name": "distant_point_on_circle", - "method_name": null, - "unique_global_name": "distant_point_on_circle", - "unique_method_name": null, - "suffix_name": null, - "description": "The furthest point on the circle to the given point.", - "brief": null, - "return": { - "type": "point_2d", - "description": "The point on c that is furthest from `pt`", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "pt": { - "type": "point_2d", - "description": "The point to test from", + }, + "x2": { + "type": "double", + "description": "The x value of the end of the line", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -16762,12 +16595,12 @@ "is_vector": false, "type_parameter": null }, - "c": { - "type": "circle", - "description": "The circle you want to get a point on its circumference", + "y2": { + "type": "double", + "description": "The y value of the end of the line", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -16781,54 +16614,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def distant_point_on_circle(pt, c):" - ], "cpp": [ - "point_2d distant_point_on_circle(const point_2d &pt, const circle &c)" + "line line_from(double x1, double y1, double x2, double y2)" + ], + "python": [ + "def line_from(x1, y1, x2, y2):" ], "csharp": [ - "public static Point2D SplashKit.DistantPointOnCircle(Point2D pt, Circle c);" + "public static Line SplashKit.LineFrom(double x1, double y1, double x2, double y2);" ], "pascal": [ - "function DistantPointOnCircle(const pt: Point2D; const c: Circle): Point2D" + "function LineFrom(x1: Double; y1: Double; x2: Double; y2: Double): Line" ] } }, { - "signature": "bool distant_point_on_circle_heading(const point_2d &pt,const circle &c,const vector_2d &heading,point_2d &opposite_pt);", - "name": "distant_point_on_circle_heading", + "signature": "bool line_intersection_point(const line &line1,const line &line2,point_2d &pt);", + "name": "line_intersection_point", "method_name": null, - "unique_global_name": "distant_point_on_circle_heading", + "unique_global_name": "line_intersection_point", "unique_method_name": null, "suffix_name": null, - "description": "Determines the opposite side of a circle given a collision point and a\nheading.", + "description": "Returns the point at which two lines would intersect. This point may lie\npast the end of one or both lines.", "brief": null, "return": { "type": "bool", - "description": "True when the `opposite_pt` is calculated, false when\nthe point would not collide with the circle when\nheading as indicated.", + "description": "[description]", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { - "type": "point_2d", - "description": "The point from which the test is being made", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "c": { - "type": "circle", - "description": "The circle", + "line1": { + "type": "line", + "description": "The first line", "is_pointer": false, "is_const": true, "is_reference": true, @@ -16839,9 +16659,9 @@ "is_vector": false, "type_parameter": null }, - "heading": { - "type": "vector_2d", - "description": "The direction the point is heading", + "line2": { + "type": "line", + "description": "The other line", "is_pointer": false, "is_const": true, "is_reference": true, @@ -16852,9 +16672,9 @@ "is_vector": false, "type_parameter": null }, - "opposite_pt": { + "pt": { "type": "point_2d", - "description": "After the call, this is set to the point on the\nopposite side of the circle from pt when it is\nheading in the given direction.", + "description": "The resulting point where they intersect", "is_pointer": false, "is_const": false, "is_reference": true, @@ -16871,54 +16691,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def distant_point_on_circle_heading(pt, c, heading, opposite_pt):" - ], "cpp": [ - "bool distant_point_on_circle_heading(const point_2d &pt, const circle &c, const vector_2d &heading, point_2d &opposite_pt)" + "bool line_intersection_point(const line &line1, const line &line2, point_2d &pt)" + ], + "python": [ + "def line_intersection_point(line1, line2, pt):" ], "csharp": [ - "public static bool SplashKit.DistantPointOnCircleHeading(Point2D pt, Circle c, Vector2D heading, ref Point2D oppositePt);" + "public static bool SplashKit.LineIntersectionPoint(Line line1, Line line2, ref Point2D pt);" ], "pascal": [ - "function DistantPointOnCircleHeading(const pt: Point2D; const c: Circle; const heading: Vector2D; var oppositePt: Point2D): Boolean" + "function LineIntersectionPoint(const line1: Line; const line2: Line; var pt: Point2D): Boolean" ] } }, { - "signature": "float ray_circle_intersect_distance(const point_2d &ray_origin,const vector_2d &ray_heading,const circle &c);", - "name": "ray_circle_intersect_distance", + "signature": "bool line_intersects_circle(const line &l,const circle &c);", + "name": "line_intersects_circle", "method_name": null, - "unique_global_name": "ray_circle_intersect_distance", + "unique_global_name": "line_intersects_circle", "unique_method_name": null, "suffix_name": null, - "description": "Calculates the distance from a ray cast from a point to a given circle.", + "description": "Returns true if the line intersects the circle.", "brief": null, "return": { - "type": "float", - "description": "-1 if the ray does not hit the circle, otherwise the\ndistance from the origin to the circle bounds.", + "type": "bool", + "description": "True if the line `l` intersects the circle `c`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "ray_origin": { - "type": "point_2d", - "description": "The origin of the ray", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "ray_heading": { - "type": "vector_2d", - "description": "The direction of the ray", + "l": { + "type": "line", + "description": "The line", "is_pointer": false, "is_const": true, "is_reference": true, @@ -16931,7 +16738,7 @@ }, "c": { "type": "circle", - "description": "The circle being tested", + "description": "The circle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -16948,41 +16755,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def ray_circle_intersect_distance(ray_origin, ray_heading, c):" - ], "cpp": [ - "float ray_circle_intersect_distance(const point_2d &ray_origin, const vector_2d &ray_heading, const circle &c)" + "bool line_intersects_circle(const line &l, const circle &c)" + ], + "python": [ + "def line_intersects_circle(l, c):" ], "csharp": [ - "public static float SplashKit.RayCircleIntersectDistance(Point2D rayOrigin, Vector2D rayHeading, Circle c);" + "public static bool SplashKit.LineIntersectsCircle(Line l, Circle c);" ], "pascal": [ - "function RayCircleIntersectDistance(const rayOrigin: Point2D; const rayHeading: Vector2D; const c: Circle): Single" + "function LineIntersectsCircle(const l: Line; const c: Circle): Boolean" ] } }, { - "signature": "bool tangent_points(const point_2d &from_pt,const circle &c,point_2d &p1,point_2d &p2);", - "name": "tangent_points", + "signature": "bool line_intersects_lines(const line &l,const vector &lines);", + "name": "line_intersects_lines", "method_name": null, - "unique_global_name": "tangent_points", + "unique_global_name": "line_intersects_lines", "unique_method_name": null, "suffix_name": null, - "description": "Returns the two tangent points on the circle given the indicated point.", + "description": "Returns true if the line intersects any of the lines.", "brief": null, "return": { "type": "bool", - "description": "True if `from_pt` is outside of the circle, and tangent\npoints are calculated", + "description": "True if `line` intersects any of the lines in `lines`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "from_pt": { - "type": "point_2d", - "description": "The source point", + "l": { + "type": "line", + "description": "The line to check", "is_pointer": false, "is_const": true, "is_reference": true, @@ -16993,9 +16800,9 @@ "is_vector": false, "type_parameter": null }, - "c": { - "type": "circle", - "description": "The circle", + "lines": { + "type": "vector", + "description": "The lines to check against", "is_pointer": false, "is_const": true, "is_reference": true, @@ -17003,34 +16810,8 @@ "array_dimension_sizes": [ ], - "is_vector": false, - "type_parameter": null - }, - "p1": { - "type": "point_2d", - "description": "If this returns true, then `p1` contains one of the points", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "p2": { - "type": "point_2d", - "description": "If this returns true, then `p2` contains one of the points", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null + "is_vector": true, + "type_parameter": "line" } }, "attributes": { @@ -17038,41 +16819,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def tangent_points(from_pt, c, p1, p2):" - ], "cpp": [ - "bool tangent_points(const point_2d &from_pt, const circle &c, point_2d &p1, point_2d &p2)" + "bool line_intersects_lines(const line &l, const vector &lines)" + ], + "python": [ + "def line_intersects_lines(l, lines):" ], "csharp": [ - "public static bool SplashKit.TangentPoints(Point2D fromPt, Circle c, ref Point2D p1, ref Point2D p2);" + "public static bool SplashKit.LineIntersectsLines(Line l, List lines);" ], "pascal": [ - "function TangentPoints(const fromPt: Point2D; const c: Circle; var p1: Point2D; var p2: Point2D): Boolean" + "function LineIntersectsLines(const l: Line; const lines: ArrayOfLine): Boolean" ] } }, { - "signature": "void widest_points(const circle &c,const vector_2d &along,point_2d &pt1,point_2d &pt2);", - "name": "widest_points", + "signature": "bool line_intersects_rect(const line &l,const rectangle &rect);", + "name": "line_intersects_rect", "method_name": null, - "unique_global_name": "widest_points", + "unique_global_name": "line_intersects_rect", "unique_method_name": null, "suffix_name": null, - "description": "Calculates the two points on a circles radius that lie along the given\nvector. This represents the points on the circle when the vector is\nplaced at the circle's center point.", + "description": "Returns true if the line intersects the rectangle.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "True if `l` intersects `rect`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "c": { - "type": "circle", - "description": "The circle", + "l": { + "type": "line", + "description": "The line", "is_pointer": false, "is_const": true, "is_reference": true, @@ -17083,41 +16864,15 @@ "is_vector": false, "type_parameter": null }, - "along": { - "type": "vector_2d", - "description": "The vector representing the line along which the points lie.", + "rect": { + "type": "rectangle", + "description": "The rectangle", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "pt1": { - "type": "point_2d", - "description": "After the call, this is set to one of the widest points", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "pt2": { - "type": "point_2d", - "description": "After the call, this is set to one of the widest points", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null @@ -17128,44 +16883,44 @@ "static": "geometry" }, "signatures": { - "python": [ - "def widest_points(c, along, pt1, pt2):" - ], "cpp": [ - "void widest_points(const circle &c, const vector_2d &along, point_2d &pt1, point_2d &pt2)" + "bool line_intersects_rect(const line &l, const rectangle &rect)" + ], + "python": [ + "def line_intersects_rect(l, rect):" ], "csharp": [ - "public static void SplashKit.WidestPoints(Circle c, Vector2D along, ref Point2D pt1, ref Point2D pt2);" + "public static bool SplashKit.LineIntersectsRect(Line l, Rectangle rect);" ], "pascal": [ - "procedure WidestPoints(const c: Circle; const along: Vector2D; var pt1: Point2D; var pt2: Point2D)" + "function LineIntersectsRect(const l: Line; const rect: Rectangle): Boolean" ] } }, { - "signature": "float cosine(float degrees);", - "name": "cosine", + "signature": "float line_length(const line &l);", + "name": "line_length", "method_name": null, - "unique_global_name": "cosine", + "unique_global_name": "line_length", "unique_method_name": null, "suffix_name": null, - "description": "Returns the cosine of the supplied angle (in degrees).", + "description": "Returns the length of a line.", "brief": null, "return": { "type": "float", - "description": "the cosine of the supplied angle (in degrees).", + "description": "The length of the line", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "degrees": { - "type": "float", - "description": "The angle in degrees", + "l": { + "type": "line", + "description": "The line", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -17179,44 +16934,44 @@ "static": "geometry" }, "signatures": { - "python": [ - "def cosine(degrees):" - ], "cpp": [ - "float cosine(float degrees)" + "float line_length(const line &l)" + ], + "python": [ + "def line_length(l):" ], "csharp": [ - "public static float SplashKit.Cosine(float degrees);" + "public static float SplashKit.LineLength(Line l);" ], "pascal": [ - "function Cosine(degrees: Single): Single" + "function LineLength(const l: Line): Single" ] } }, { - "signature": "float sine(float degrees);", - "name": "sine", + "signature": "float line_length_squared(const line &l);", + "name": "line_length_squared", "method_name": null, - "unique_global_name": "sine", + "unique_global_name": "line_length_squared", "unique_method_name": null, "suffix_name": null, - "description": "Returns the sine of the supplied angle (in degrees).", + "description": "Returns the squared length of the line. You can also get the\n`line_length`.", "brief": null, "return": { "type": "float", - "description": "the sine of the supplied angle (in degrees).", + "description": "The squared length of the line", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "degrees": { - "type": "float", - "description": "The angle in degrees", + "l": { + "type": "line", + "description": "The line", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -17230,44 +16985,44 @@ "static": "geometry" }, "signatures": { - "python": [ - "def sine(degrees):" - ], "cpp": [ - "float sine(float degrees)" + "float line_length_squared(const line &l)" + ], + "python": [ + "def line_length_squared(l):" ], "csharp": [ - "public static float SplashKit.Sine(float degrees);" + "public static float SplashKit.LineLengthSquared(Line l);" ], "pascal": [ - "function Sine(degrees: Single): Single" + "function LineLengthSquared(const l: Line): Single" ] } }, { - "signature": "float tangent(float degrees);", - "name": "tangent", + "signature": "point_2d line_mid_point(const line &l);", + "name": "line_mid_point", "method_name": null, - "unique_global_name": "tangent", + "unique_global_name": "line_mid_point", "unique_method_name": null, "suffix_name": null, - "description": "Returns the tangent of the supplied angle (in degrees).", + "description": "Returns the center point of the line.", "brief": null, "return": { - "type": "float", - "description": "the tangent of the supplied angle (in degrees).", + "type": "point_2d", + "description": "The point that is at the center of the line", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "degrees": { - "type": "float", - "description": "The angle in degrees", + "l": { + "type": "line", + "description": "The line", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -17281,51 +17036,38 @@ "static": "geometry" }, "signatures": { - "python": [ - "def tangent(degrees):" - ], "cpp": [ - "float tangent(float degrees)" + "point_2d line_mid_point(const line &l)" + ], + "python": [ + "def line_mid_point(l):" ], "csharp": [ - "public static float SplashKit.Tangent(float degrees);" + "public static Point2D SplashKit.LineMidPoint(Line l);" ], "pascal": [ - "function Tangent(degrees: Single): Single" + "function LineMidPoint(const l: Line): Point2D" ] } }, { - "signature": "point_2d closest_point_on_line(const point_2d from_pt,const line &l);", - "name": "closest_point_on_line", + "signature": "vector_2d line_normal(const line &l);", + "name": "line_normal", "method_name": null, - "unique_global_name": "closest_point_on_line", + "unique_global_name": "line_normal", "unique_method_name": null, "suffix_name": null, - "description": "Gets the closest point on the line to a given point.", + "description": "The line normal (a perpendicular vector).", "brief": null, "return": { - "type": "point_2d", - "description": "The point on the line that is closest to `from_pt`", + "type": "vector_2d", + "description": "The line's normal vector", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "from_pt": { - "type": "point_2d", - "description": "The point to test (usually somewhere near the line)", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, "l": { "type": "line", "description": "The line", @@ -17345,73 +17087,47 @@ "static": "geometry" }, "signatures": { - "python": [ - "def closest_point_on_line(from_pt, l):" - ], "cpp": [ - "point_2d closest_point_on_line(const point_2d from_pt, const line &l)" + "vector_2d line_normal(const line &l)" + ], + "python": [ + "def line_normal(l):" ], "csharp": [ - "public static Point2D SplashKit.ClosestPointOnLine(Point2D fromPt, Line l);" + "public static Vector2D SplashKit.LineNormal(Line l);" ], "pascal": [ - "function ClosestPointOnLine(fromPt: Point2D; const l: Line): Point2D" + "function LineNormal(const l: Line): Vector2D" ] } }, { - "signature": "point_2d closest_point_on_lines(const point_2d from_pt,const vector &lines,int &line_idx);", - "name": "closest_point_on_lines", - "method_name": null, - "unique_global_name": "closest_point_on_lines", + "signature": "string line_to_string(const line &ln);", + "name": "line_to_string", + "method_name": null, + "unique_global_name": "line_to_string", "unique_method_name": null, "suffix_name": null, - "description": "Get the point closest to `from pt` that is on one of the supplied lines.", + "description": "Returns a text description of the line.", "brief": null, "return": { - "type": "point_2d", - "description": "The point on one of the lines that is the closest point\non these lines to the `from pt`.", + "type": "string", + "description": "A text description of the line", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "from_pt": { - "type": "point_2d", - "description": "The point to test", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "lines": { - "type": "vector", - "description": "The lines to check", + "ln": { + "type": "line", + "description": "The line", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": true, - "type_parameter": "line" - }, - "line_idx": { - "type": "int", - "description": "After the call this will store the index of the line that\nhad the matching point.", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null @@ -17422,54 +17138,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def closest_point_on_lines(from_pt, lines, line_idx):" - ], "cpp": [ - "point_2d closest_point_on_lines(const point_2d from_pt, const vector &lines, int &line_idx)" + "string line_to_string(const line &ln)" + ], + "python": [ + "def line_to_string(ln):" ], "csharp": [ - "public static Point2D SplashKit.ClosestPointOnLines(Point2D fromPt, List lines, ref int lineIdx);" + "public static string SplashKit.LineToString(Line ln);" ], "pascal": [ - "function ClosestPointOnLines(fromPt: Point2D; const lines: ArrayOfLine; var lineIdx: Integer): Point2D" + "function LineToString(const ln: Line): String" ] } }, { - "signature": "line line_from(const point_2d &start,const point_2d &end_pt);", - "name": "line_from", + "signature": "vector lines_from(const rectangle &rect);", + "name": "lines_from", "method_name": null, - "unique_global_name": "line_from_point_to_point", + "unique_global_name": "lines_from_rectangle", "unique_method_name": null, "suffix_name": null, - "description": "Create a line from one point to another.", + "description": "Returns an array of lines from a supplied rectangle.", "brief": null, "return": { - "type": "line", - "description": "A line from the start to the end point", + "type": "vector", + "description": "An array containing 4 lines", "is_pointer": false, "is_reference": false, - "is_vector": false, - "type_parameter": null + "is_vector": true, + "type_parameter": "line" }, "parameters": { - "start": { - "type": "point_2d", - "description": "The start of the line", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "end_pt": { - "type": "point_2d", - "description": "The end of the line", + "rect": { + "type": "rectangle", + "description": "The rectangle to get the lines from", "is_pointer": false, "is_const": true, "is_reference": true, @@ -17482,59 +17185,46 @@ } }, "attributes": { - "suffix": "point_to_point", + "suffix": "rectangle", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def line_from_point_to_point(start, end_pt):" - ], "cpp": [ - "line line_from(const point_2d &start, const point_2d &end_pt)" + "vector lines_from(const rectangle &rect)" + ], + "python": [ + "def lines_from_rectangle(rect):" ], "csharp": [ - "public static Line SplashKit.LineFrom(Point2D start, Point2D endPt);" + "public static List SplashKit.LinesFrom(Rectangle rect);" ], "pascal": [ - "function LineFrom(const start: Point2D; const endPt: Point2D): Line" + "function LinesFrom(const rect: Rectangle): ArrayOfLine" ] } }, { - "signature": "line line_from(const point_2d &start,const vector_2d &offset);", - "name": "line_from", + "signature": "vector lines_from(const triangle &t);", + "name": "lines_from", "method_name": null, - "unique_global_name": "line_from_start_with_offset", + "unique_global_name": "lines_from_triangle", "unique_method_name": null, "suffix_name": null, - "description": "Creates a line that starts at a point, and follows a given vector.", + "description": "Returns an array of lines from the details in the triangle.", "brief": null, "return": { - "type": "line", - "description": "A line from the start to end point", + "type": "vector", + "description": "The lines from the triangle", "is_pointer": false, "is_reference": false, - "is_vector": false, - "type_parameter": null + "is_vector": true, + "type_parameter": "line" }, "parameters": { - "start": { - "type": "point_2d", - "description": "The start of the line", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "offset": { - "type": "vector_2d", - "description": "The offset to the end of the line", + "t": { + "type": "triangle", + "description": "The triangle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -17547,46 +17237,59 @@ } }, "attributes": { - "suffix": "start_with_offset", + "suffix": "triangle", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def line_from_start_with_offset(start, offset):" - ], "cpp": [ - "line line_from(const point_2d &start, const vector_2d &offset)" + "vector lines_from(const triangle &t)" + ], + "python": [ + "def lines_from_triangle(t):" ], "csharp": [ - "public static Line SplashKit.LineFrom(Point2D start, Vector2D offset);" + "public static List SplashKit.LinesFrom(Triangle t);" ], "pascal": [ - "function LineFrom(const start: Point2D; const offset: Vector2D): Line" + "function LinesFrom(const t: Triangle): ArrayOfLine" ] } }, { - "signature": "line line_from(const vector_2d &v);", - "name": "line_from", + "signature": "bool lines_intersect(const line &l1,const line &l2);", + "name": "lines_intersect", "method_name": null, - "unique_global_name": "line_from_vector", + "unique_global_name": "lines_intersect", "unique_method_name": null, "suffix_name": null, - "description": "Gets a line that goes from the origin and ends at the end of the vector.", + "description": "Returns true if the two lines intersect.", "brief": null, "return": { - "type": "line", - "description": "A line from the origin to the end point", + "type": "bool", + "description": "True if the two lines intersect (share a common point).", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v": { - "type": "vector_2d", - "description": "The offset from the origin for the end of the line", + "l1": { + "type": "line", + "description": "The first line", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "l2": { + "type": "line", + "description": "The other line", "is_pointer": false, "is_const": true, "is_reference": true, @@ -17599,72 +17302,45 @@ } }, "attributes": { - "suffix": "vector", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def line_from_vector(v):" - ], "cpp": [ - "line line_from(const vector_2d &v)" + "bool lines_intersect(const line &l1, const line &l2)" + ], + "python": [ + "def lines_intersect(l1, l2):" ], "csharp": [ - "public static Line SplashKit.LineFrom(Vector2D v);" + "public static bool SplashKit.LinesIntersect(Line l1, Line l2);" ], "pascal": [ - "function LineFrom(const v: Vector2D): Line" + "function LinesIntersect(const l1: Line; const l2: Line): Boolean" ] } }, { - "signature": "line line_from(double x1,double y1,double x2,double y2);", - "name": "line_from", + "signature": "point_2d point_at(double x,double y);", + "name": "point_at", "method_name": null, - "unique_global_name": "line_from", + "unique_global_name": "point_at", "unique_method_name": null, "suffix_name": null, - "description": "Create a line from one point to another.", + "description": "Returns a point at the given location.", "brief": null, "return": { - "type": "line", - "description": "A line from the start to the end point", + "type": "point_2d", + "description": "A point at the given location", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "x1": { - "type": "double", - "description": "The x value of the start of the line", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y1": { - "type": "double", - "description": "The y value of the start of the line", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x2": { + "x": { "type": "double", - "description": "The x value of the end of the line", + "description": "The x value of the coordinate", "is_pointer": false, "is_const": false, "is_reference": false, @@ -17675,9 +17351,9 @@ "is_vector": false, "type_parameter": null }, - "y2": { + "y": { "type": "double", - "description": "The y value of the end of the line", + "description": "The y value of the coordinate", "is_pointer": false, "is_const": false, "is_reference": false, @@ -17694,41 +17370,79 @@ "static": "geometry" }, "signatures": { + "cpp": [ + "point_2d point_at(double x, double y)" + ], "python": [ - "def line_from(x1, y1, x2, y2):" + "def point_at(x, y):" ], + "csharp": [ + "public static Point2D SplashKit.PointAt(double x, double y);" + ], + "pascal": [ + "function PointAt(x: Double; y: Double): Point2D" + ] + } + }, + { + "signature": "point_2d point_at_origin();", + "name": "point_at_origin", + "method_name": null, + "unique_global_name": "point_at_origin", + "unique_method_name": null, + "suffix_name": null, + "description": "Returns a point representing the origin.", + "brief": null, + "return": { + "type": "point_2d", + "description": "A point with x and y set to 0", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + }, + "attributes": { + "group": "geometry", + "static": "geometry" + }, + "signatures": { "cpp": [ - "line line_from(double x1, double y1, double x2, double y2)" + "point_2d point_at_origin()" + ], + "python": [ + "def point_at_origin():" ], "csharp": [ - "public static Line SplashKit.LineFrom(double x1, double y1, double x2, double y2);" + "public static Point2D SplashKit.PointAtOrigin();" ], "pascal": [ - "function LineFrom(x1: Double; y1: Double; x2: Double; y2: Double): Line" + "function PointAtOrigin(): Point2D" ] } }, { - "signature": "bool line_intersection_point(const line &line1,const line &line2,point_2d &pt);", - "name": "line_intersection_point", + "signature": "bool point_in_circle(const point_2d &pt,const circle &c);", + "name": "point_in_circle", "method_name": null, - "unique_global_name": "line_intersection_point", + "unique_global_name": "point_in_circle", "unique_method_name": null, "suffix_name": null, - "description": "Returns the point at which two lines would intersect. This point may lie\npast the end of one or both lines.", + "description": "Returns true if the point `pt` is in the circle `c`.", "brief": null, "return": { "type": "bool", - "description": "[description]", + "description": "True if the point is within the area of the circle", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "line1": { - "type": "line", - "description": "The first line", + "pt": { + "type": "point_2d", + "description": "The point to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -17739,28 +17453,15 @@ "is_vector": false, "type_parameter": null }, - "line2": { - "type": "line", - "description": "The other line", + "c": { + "type": "circle", + "description": "The circle to check", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "pt": { - "type": "point_2d", - "description": "The resulting point where they intersect", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null @@ -17771,44 +17472,44 @@ "static": "geometry" }, "signatures": { - "python": [ - "def line_intersection_point(line1, line2, pt):" - ], "cpp": [ - "bool line_intersection_point(const line &line1, const line &line2, point_2d &pt)" + "bool point_in_circle(const point_2d &pt, const circle &c)" + ], + "python": [ + "def point_in_circle(pt, c):" ], "csharp": [ - "public static bool SplashKit.LineIntersectionPoint(Line line1, Line line2, ref Point2D pt);" + "public static bool SplashKit.PointInCircle(Point2D pt, Circle c);" ], "pascal": [ - "function LineIntersectionPoint(const line1: Line; const line2: Line; var pt: Point2D): Boolean" + "function PointInCircle(const pt: Point2D; const c: Circle): Boolean" ] } }, { - "signature": "bool line_intersects_circle(const line &l,const circle &c);", - "name": "line_intersects_circle", + "signature": "bool point_in_circle(double ptx,double pty,double cx,double cy,double radius);", + "name": "point_in_circle", "method_name": null, - "unique_global_name": "line_intersects_circle", + "unique_global_name": "point_in_circle_with_values", "unique_method_name": null, "suffix_name": null, - "description": "Returns true if the line intersects the circle.", + "description": "Return true if the point is in the circle.", "brief": null, "return": { "type": "bool", - "description": "True if the line `l` intersects the circle `c`", + "description": "True when the point is in the circle, otherwise it returns false.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "l": { - "type": "line", - "description": "The line", + "ptx": { + "type": "double", + "description": "the x value of the point", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -17816,12 +17517,51 @@ "is_vector": false, "type_parameter": null }, - "c": { - "type": "circle", - "description": "The circle", + "pty": { + "type": "double", + "description": "the y value of the point", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "cx": { + "type": "double", + "description": "the x value of the centre of the circle", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "cy": { + "type": "double", + "description": "the y value of the centre of the circle", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "radius": { + "type": "double", + "description": "the radius of the circle", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -17831,45 +17571,46 @@ } }, "attributes": { + "suffix": "with_values", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def line_intersects_circle(l, c):" - ], "cpp": [ - "bool line_intersects_circle(const line &l, const circle &c)" + "bool point_in_circle(double ptx, double pty, double cx, double cy, double radius)" + ], + "python": [ + "def point_in_circle_with_values(ptx, pty, cx, cy, radius):" ], "csharp": [ - "public static bool SplashKit.LineIntersectsCircle(Line l, Circle c);" + "public static bool SplashKit.PointInCircle(double ptx, double pty, double cx, double cy, double radius);" ], "pascal": [ - "function LineIntersectsCircle(const l: Line; const c: Circle): Boolean" + "function PointInCircle(ptx: Double; pty: Double; cx: Double; cy: Double; radius: Double): Boolean" ] } }, { - "signature": "bool line_intersects_lines(const line &l,const vector &lines);", - "name": "line_intersects_lines", + "signature": "bool point_in_quad(const point_2d &pt,const quad &q);", + "name": "point_in_quad", "method_name": null, - "unique_global_name": "line_intersects_lines", + "unique_global_name": "point_in_quad", "unique_method_name": null, "suffix_name": null, - "description": "Returns true if the line intersects any of the lines.", + "description": "Tests if a point is in a quad.", "brief": null, "return": { "type": "bool", - "description": "True if `line` intersects any of the lines in `lines`", + "description": "True if pt lies within the area of q.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "l": { - "type": "line", - "description": "The line to check", + "pt": { + "type": "point_2d", + "description": "The point to test.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -17880,9 +17621,9 @@ "is_vector": false, "type_parameter": null }, - "lines": { - "type": "vector", - "description": "The lines to check against", + "q": { + "type": "quad", + "description": "The quad to check if the point is within.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -17890,8 +17631,8 @@ "array_dimension_sizes": [ ], - "is_vector": true, - "type_parameter": "line" + "is_vector": false, + "type_parameter": null } }, "attributes": { @@ -17899,41 +17640,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def line_intersects_lines(l, lines):" - ], "cpp": [ - "bool line_intersects_lines(const line &l, const vector &lines)" + "bool point_in_quad(const point_2d &pt, const quad &q)" + ], + "python": [ + "def point_in_quad(pt, q):" ], "csharp": [ - "public static bool SplashKit.LineIntersectsLines(Line l, List lines);" + "public static bool SplashKit.PointInQuad(Point2D pt, Quad q);" ], "pascal": [ - "function LineIntersectsLines(const l: Line; const lines: ArrayOfLine): Boolean" + "function PointInQuad(const pt: Point2D; const q: Quad): Boolean" ] } }, { - "signature": "bool line_intersects_rect(const line &l,const rectangle &rect);", - "name": "line_intersects_rect", + "signature": "bool point_in_rectangle(const point_2d &pt,const rectangle &rect);", + "name": "point_in_rectangle", "method_name": null, - "unique_global_name": "line_intersects_rect", + "unique_global_name": "point_in_rectangle", "unique_method_name": null, "suffix_name": null, - "description": "Returns true if the line intersects the rectangle.", + "description": "Returns true if point `pt` is in the Rectangle `rect`.", "brief": null, "return": { "type": "bool", - "description": "True if `l` intersects `rect`", + "description": "True if the point is within the rectangle", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "l": { - "type": "line", - "description": "The line", + "pt": { + "type": "point_2d", + "description": "The point to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -17946,7 +17687,7 @@ }, "rect": { "type": "rectangle", - "description": "The rectangle", + "description": "The rectangle to check", "is_pointer": false, "is_const": true, "is_reference": true, @@ -17963,92 +17704,171 @@ "static": "geometry" }, "signatures": { - "python": [ - "def line_intersects_rect(l, rect):" - ], "cpp": [ - "bool line_intersects_rect(const line &l, const rectangle &rect)" + "bool point_in_rectangle(const point_2d &pt, const rectangle &rect)" + ], + "python": [ + "def point_in_rectangle(pt, rect):" ], "csharp": [ - "public static bool SplashKit.LineIntersectsRect(Line l, Rectangle rect);" + "public static bool SplashKit.PointInRectangle(Point2D pt, Rectangle rect);" ], "pascal": [ - "function LineIntersectsRect(const l: Line; const rect: Rectangle): Boolean" + "function PointInRectangle(const pt: Point2D; const rect: Rectangle): Boolean" ] } }, { - "signature": "float line_length(const line &l);", - "name": "line_length", + "signature": "bool point_in_rectangle(double ptx,double pty,double rect_x,double rect_y,double rect_width,double rect_height);", + "name": "point_in_rectangle", "method_name": null, - "unique_global_name": "line_length", + "unique_global_name": "point_in_rectangle_with_values", "unique_method_name": null, "suffix_name": null, - "description": "Returns the length of a line.", + "description": "Returns true if the point is within the bounds of a Rectangle.", "brief": null, "return": { - "type": "float", - "description": "The length of the line", + "type": "bool", + "description": "true when the point is in the rectangle, otherwise it returns false.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "l": { - "type": "line", - "description": "The line", + "ptx": { + "type": "double", + "description": "the x value of the point", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "group": "geometry", + }, + "pty": { + "type": "double", + "description": "the y value of the point", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect_x": { + "type": "double", + "description": "x value of the rectangle", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect_y": { + "type": "double", + "description": "y value of the rectangle", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect_width": { + "type": "double", + "description": "width of the rectangle", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect_height": { + "type": "double", + "description": "height of the rectangle", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } + }, + "attributes": { + "suffix": "with_values", + "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def line_length(l):" - ], "cpp": [ - "float line_length(const line &l)" + "bool point_in_rectangle(double ptx, double pty, double rect_x, double rect_y, double rect_width, double rect_height)" + ], + "python": [ + "def point_in_rectangle_with_values(ptx, pty, rect_x, rect_y, rect_width, rect_height):" ], "csharp": [ - "public static float SplashKit.LineLength(Line l);" + "public static bool SplashKit.PointInRectangle(double ptx, double pty, double rectX, double rectY, double rectWidth, double rectHeight);" ], "pascal": [ - "function LineLength(const l: Line): Single" + "function PointInRectangle(ptx: Double; pty: Double; rectX: Double; rectY: Double; rectWidth: Double; rectHeight: Double): Boolean" ] } }, { - "signature": "float line_length_squared(const line &l);", - "name": "line_length_squared", + "signature": "bool point_in_triangle(const point_2d &pt,const triangle &tri);", + "name": "point_in_triangle", "method_name": null, - "unique_global_name": "line_length_squared", + "unique_global_name": "point_in_triangle", "unique_method_name": null, "suffix_name": null, - "description": "Returns the squared length of the line. You can also get the\n`line_length`.", + "description": "Returns true if the point `pt` is in the Triangle `tri`.", "brief": null, "return": { - "type": "float", - "description": "The squared length of the line", + "type": "bool", + "description": "True if the point is within the triangle", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "l": { - "type": "line", - "description": "The line", + "pt": { + "type": "point_2d", + "description": "The point to test", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "tri": { + "type": "triangle", + "description": "The triangle to check", "is_pointer": false, "is_const": true, "is_reference": true, @@ -18065,38 +17885,51 @@ "static": "geometry" }, "signatures": { - "python": [ - "def line_length_squared(l):" - ], "cpp": [ - "float line_length_squared(const line &l)" + "bool point_in_triangle(const point_2d &pt, const triangle &tri)" + ], + "python": [ + "def point_in_triangle(pt, tri):" ], "csharp": [ - "public static float SplashKit.LineLengthSquared(Line l);" + "public static bool SplashKit.PointInTriangle(Point2D pt, Triangle tri);" ], "pascal": [ - "function LineLengthSquared(const l: Line): Single" + "function PointInTriangle(const pt: Point2D; const tri: Triangle): Boolean" ] } }, { - "signature": "point_2d line_mid_point(const line &l);", - "name": "line_mid_point", + "signature": "float point_line_distance(const point_2d &pt,const line &l);", + "name": "point_line_distance", "method_name": null, - "unique_global_name": "line_mid_point", + "unique_global_name": "point_line_distance", "unique_method_name": null, "suffix_name": null, - "description": "Returns the center point of the line.", + "description": "Returns the distance from a point to a line.", "brief": null, "return": { - "type": "point_2d", - "description": "The point that is at the center of the line", + "type": "float", + "description": "The distance from `pt` to `l`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "pt": { + "type": "point_2d", + "description": "The point", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "l": { "type": "line", "description": "The line", @@ -18116,41 +17949,54 @@ "static": "geometry" }, "signatures": { - "python": [ - "def line_mid_point(l):" - ], "cpp": [ - "point_2d line_mid_point(const line &l)" + "float point_line_distance(const point_2d &pt, const line &l)" + ], + "python": [ + "def point_line_distance(pt, l):" ], "csharp": [ - "public static Point2D SplashKit.LineMidPoint(Line l);" + "public static float SplashKit.PointLineDistance(Point2D pt, Line l);" ], "pascal": [ - "function LineMidPoint(const l: Line): Point2D" + "function PointLineDistance(const pt: Point2D; const l: Line): Single" ] } }, { - "signature": "vector_2d line_normal(const line &l);", - "name": "line_normal", + "signature": "point_2d point_offset_by(const point_2d &start_point,const vector_2d &offset);", + "name": "point_offset_by", "method_name": null, - "unique_global_name": "line_normal", + "unique_global_name": "point_offset_by", "unique_method_name": null, "suffix_name": null, - "description": "The line normal (a perpendicular vector).", + "description": "Calculate the `point_2d` that is offset from the `start_point` by the\n`offset`", "brief": null, "return": { - "type": "vector_2d", - "description": "The line's normal vector", + "type": "point_2d", + "description": "A new point as a result of moving by the offset from\nthe starting point", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "l": { - "type": "line", - "description": "The line", + "start_point": { + "type": "point_2d", + "description": "The starting point", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "offset": { + "type": "vector_2d", + "description": "The distance and direction to move", "is_pointer": false, "is_const": true, "is_reference": true, @@ -18167,41 +18013,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def line_normal(l):" - ], "cpp": [ - "vector_2d line_normal(const line &l)" + "point_2d point_offset_by(const point_2d &start_point, const vector_2d &offset)" + ], + "python": [ + "def point_offset_by(start_point, offset):" ], "csharp": [ - "public static Vector2D SplashKit.LineNormal(Line l);" + "public static Point2D SplashKit.PointOffsetBy(Point2D startPoint, Vector2D offset);" ], "pascal": [ - "function LineNormal(const l: Line): Vector2D" + "function PointOffsetBy(const startPoint: Point2D; const offset: Vector2D): Point2D" ] } }, { - "signature": "string line_to_string(const line &ln);", - "name": "line_to_string", + "signature": "point_2d point_offset_from_origin(const vector_2d &offset);", + "name": "point_offset_from_origin", "method_name": null, - "unique_global_name": "line_to_string", + "unique_global_name": "point_offset_from_origin", "unique_method_name": null, "suffix_name": null, - "description": "Returns a text description of the line.", + "description": "Returns the point offset from the origin by the provided vector.", "brief": null, "return": { - "type": "string", - "description": "A text description of the line", + "type": "point_2d", + "description": "A new point as a result of moving by the offset from\nthe starting point", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "ln": { - "type": "line", - "description": "The line", + "offset": { + "type": "vector_2d", + "description": "The distance and direction to move", "is_pointer": false, "is_const": true, "is_reference": true, @@ -18218,41 +18064,54 @@ "static": "geometry" }, "signatures": { - "python": [ - "def line_to_string(ln):" - ], "cpp": [ - "string line_to_string(const line &ln)" + "point_2d point_offset_from_origin(const vector_2d &offset)" + ], + "python": [ + "def point_offset_from_origin(offset):" ], "csharp": [ - "public static string SplashKit.LineToString(Line ln);" + "public static Point2D SplashKit.PointOffsetFromOrigin(Vector2D offset);" ], "pascal": [ - "function LineToString(const ln: Line): String" + "function PointOffsetFromOrigin(const offset: Vector2D): Point2D" ] } }, { - "signature": "vector lines_from(const rectangle &rect);", - "name": "lines_from", + "signature": "bool point_on_line(const point_2d &pt,const line &l);", + "name": "point_on_line", "method_name": null, - "unique_global_name": "lines_from_rectangle", + "unique_global_name": "point_on_line", "unique_method_name": null, "suffix_name": null, - "description": "Returns an array of lines from a supplied rectangle.", + "description": "Returns true if point `pt` is on the line `l`.", "brief": null, "return": { - "type": "vector", - "description": "An array containing 4 lines", + "type": "bool", + "description": "True if the point is on the line", "is_pointer": false, "is_reference": false, - "is_vector": true, - "type_parameter": "line" + "is_vector": false, + "type_parameter": null }, "parameters": { - "rect": { - "type": "rectangle", - "description": "The rectangle to get the lines from", + "pt": { + "type": "point_2d", + "description": "The point to test", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "l": { + "type": "line", + "description": "The line to check", "is_pointer": false, "is_const": true, "is_reference": true, @@ -18265,98 +18124,123 @@ } }, "attributes": { - "suffix": "rectangle", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def lines_from_rectangle(rect):" - ], "cpp": [ - "vector lines_from(const rectangle &rect)" + "bool point_on_line(const point_2d &pt, const line &l)" + ], + "python": [ + "def point_on_line(pt, l):" ], "csharp": [ - "public static List SplashKit.LinesFrom(Rectangle rect);" + "public static bool SplashKit.PointOnLine(Point2D pt, Line l);" ], "pascal": [ - "function LinesFrom(const rect: Rectangle): ArrayOfLine" + "function PointOnLine(const pt: Point2D; const l: Line): Boolean" ] } }, { - "signature": "vector lines_from(const triangle &t);", - "name": "lines_from", + "signature": "bool point_on_line(const point_2d &pt,const line &l,float proximity);", + "name": "point_on_line", "method_name": null, - "unique_global_name": "lines_from_triangle", + "unique_global_name": "point_on_line_with_proximity", "unique_method_name": null, "suffix_name": null, - "description": "Returns an array of lines from the details in the triangle.", + "description": "Returns true when the point `pt` is on the line `l`. The\nproximity value is used to set the sensitivity -- higher values\neffectively make the line thicker.", "brief": null, "return": { - "type": "vector", - "description": "The lines from the triangle", + "type": "bool", + "description": "True if the point is on the line", "is_pointer": false, "is_reference": false, - "is_vector": true, - "type_parameter": "line" + "is_vector": false, + "type_parameter": null }, "parameters": { - "t": { - "type": "triangle", - "description": "The triangle", + "pt": { + "type": "point_2d", + "description": "The point to test", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "l": { + "type": "line", + "description": "The line to check", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "proximity": { + "type": "float", + "description": "The sensitivity to allow close approximities", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { - "suffix": "triangle", + "suffix": "with_proximity", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def lines_from_triangle(t):" - ], "cpp": [ - "vector lines_from(const triangle &t)" + "bool point_on_line(const point_2d &pt, const line &l, float proximity)" + ], + "python": [ + "def point_on_line_with_proximity(pt, l, proximity):" ], "csharp": [ - "public static List SplashKit.LinesFrom(Triangle t);" + "public static bool SplashKit.PointOnLine(Point2D pt, Line l, float proximity);" ], "pascal": [ - "function LinesFrom(const t: Triangle): ArrayOfLine" + "function PointOnLine(const pt: Point2D; const l: Line; proximity: Single): Boolean" ] } }, { - "signature": "bool lines_intersect(const line &l1,const line &l2);", - "name": "lines_intersect", + "signature": "float point_point_angle(const point_2d &pt1,const point_2d &pt2);", + "name": "point_point_angle", "method_name": null, - "unique_global_name": "lines_intersect", + "unique_global_name": "point_point_angle", "unique_method_name": null, "suffix_name": null, - "description": "Returns true if the two lines intersect.", + "description": "Returns the angle between two points in degrees.", "brief": null, "return": { - "type": "bool", - "description": "True if the two lines intersect (share a common point).", + "type": "float", + "description": "The angle (in degrees) of the line between the points", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "l1": { - "type": "line", - "description": "The first line", + "pt1": { + "type": "point_2d", + "description": "The first point", "is_pointer": false, "is_const": true, "is_reference": true, @@ -18367,9 +18251,9 @@ "is_vector": false, "type_parameter": null }, - "l2": { - "type": "line", - "description": "The other line", + "pt2": { + "type": "point_2d", + "description": "The other point", "is_pointer": false, "is_const": true, "is_reference": true, @@ -18386,44 +18270,44 @@ "static": "geometry" }, "signatures": { - "python": [ - "def lines_intersect(l1, l2):" - ], "cpp": [ - "bool lines_intersect(const line &l1, const line &l2)" + "float point_point_angle(const point_2d &pt1, const point_2d &pt2)" + ], + "python": [ + "def point_point_angle(pt1, pt2):" ], "csharp": [ - "public static bool SplashKit.LinesIntersect(Line l1, Line l2);" + "public static float SplashKit.PointPointAngle(Point2D pt1, Point2D pt2);" ], "pascal": [ - "function LinesIntersect(const l1: Line; const l2: Line): Boolean" + "function PointPointAngle(const pt1: Point2D; const pt2: Point2D): Single" ] } }, { - "signature": "point_2d point_at(double x,double y);", - "name": "point_at", + "signature": "double point_point_distance(const point_2d &pt1,const point_2d &pt2);", + "name": "point_point_distance", "method_name": null, - "unique_global_name": "point_at", + "unique_global_name": "point_point_distance", "unique_method_name": null, "suffix_name": null, - "description": "Returns a point at the given location.", + "description": "Returns the distance between two points.", "brief": null, "return": { - "type": "point_2d", - "description": "A point at the given location", + "type": "double", + "description": "The distance between the two points", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "x": { - "type": "double", - "description": "The x value of the coordinate", + "pt1": { + "type": "point_2d", + "description": "The first point", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -18431,12 +18315,12 @@ "is_vector": false, "type_parameter": null }, - "y": { - "type": "double", - "description": "The y value of the coordinate", + "pt2": { + "type": "point_2d", + "description": "The other point", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -18450,95 +18334,95 @@ "static": "geometry" }, "signatures": { - "python": [ - "def point_at(x, y):" - ], "cpp": [ - "point_2d point_at(double x, double y)" + "double point_point_distance(const point_2d &pt1, const point_2d &pt2)" + ], + "python": [ + "def point_point_distance(pt1, pt2):" ], "csharp": [ - "public static Point2D SplashKit.PointAt(double x, double y);" + "public static double SplashKit.PointPointDistance(Point2D pt1, Point2D pt2);" ], "pascal": [ - "function PointAt(x: Double; y: Double): Point2D" + "function PointPointDistance(const pt1: Point2D; const pt2: Point2D): Double" ] } }, { - "signature": "point_2d point_at_origin();", - "name": "point_at_origin", + "signature": "string point_to_string(const point_2d &pt);", + "name": "point_to_string", "method_name": null, - "unique_global_name": "point_at_origin", + "unique_global_name": "point_to_string", "unique_method_name": null, "suffix_name": null, - "description": "Returns a point representing the origin.", + "description": "Get a text description of the `point_2d`.", "brief": null, "return": { - "type": "point_2d", - "description": "A point with x and y set to 0", + "type": "string", + "description": "A string representation of the point", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "pt": { + "type": "point_2d", + "description": "The point details", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def point_at_origin():" - ], "cpp": [ - "point_2d point_at_origin()" + "string point_to_string(const point_2d &pt)" + ], + "python": [ + "def point_to_string(pt):" ], "csharp": [ - "public static Point2D SplashKit.PointAtOrigin();" + "public static string SplashKit.PointToString(Point2D pt);" ], "pascal": [ - "function PointAtOrigin(): Point2D" + "function PointToString(const pt: Point2D): String" ] } }, { - "signature": "bool point_in_circle(const point_2d &pt,const circle &c);", - "name": "point_in_circle", + "signature": "point_2d random_bitmap_point(bitmap bmp);", + "name": "random_bitmap_point", "method_name": null, - "unique_global_name": "point_in_circle", + "unique_global_name": "random_bitmap_point", "unique_method_name": null, "suffix_name": null, - "description": "Returns true if the point `pt` is in the circle `c`.", + "description": "Returns a random point within the bounds of the bitmap.", "brief": null, "return": { - "type": "bool", - "description": "True if the point is within the area of the circle", + "type": "point_2d", + "description": "A point within the bounds of the bitmap", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { - "type": "point_2d", - "description": "The point to test", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "c": { - "type": "circle", - "description": "The circle to check", + "bmp": { + "type": "bitmap", + "description": "The bitmap", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -18552,161 +18436,82 @@ "static": "geometry" }, "signatures": { - "python": [ - "def point_in_circle(pt, c):" - ], "cpp": [ - "bool point_in_circle(const point_2d &pt, const circle &c)" + "point_2d random_bitmap_point(bitmap bmp)" + ], + "python": [ + "def random_bitmap_point(bmp):" ], "csharp": [ - "public static bool SplashKit.PointInCircle(Point2D pt, Circle c);" + "public static Point2D SplashKit.RandomBitmapPoint(Bitmap bmp);" ], "pascal": [ - "function PointInCircle(const pt: Point2D; const c: Circle): Boolean" + "function RandomBitmapPoint(bmp: Bitmap): Point2D" ] } }, { - "signature": "bool point_in_circle(double ptx,double pty,double cx,double cy,double radius);", - "name": "point_in_circle", - "method_name": null, - "unique_global_name": "point_in_circle_with_values", + "signature": "point_2d random_screen_point();", + "name": "random_screen_point", + "method_name": null, + "unique_global_name": "random_screen_point", "unique_method_name": null, "suffix_name": null, - "description": "Return true if the point is in the circle.", + "description": "Returns a random point on the current window.", "brief": null, "return": { - "type": "bool", - "description": "True when the point is in the circle, otherwise it returns false.", + "type": "point_2d", + "description": "A point within the bounds of the current window", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "ptx": { - "type": "double", - "description": "the x value of the point", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "pty": { - "type": "double", - "description": "the y value of the point", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "cx": { - "type": "double", - "description": "the x value of the centre of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "cy": { - "type": "double", - "description": "the y value of the centre of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "radius": { - "type": "double", - "description": "the radius of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { - "suffix": "with_values", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def point_in_circle_with_values(ptx, pty, cx, cy, radius):" - ], "cpp": [ - "bool point_in_circle(double ptx, double pty, double cx, double cy, double radius)" + "point_2d random_screen_point()" + ], + "python": [ + "def random_screen_point():" ], "csharp": [ - "public static bool SplashKit.PointInCircle(double ptx, double pty, double cx, double cy, double radius);" + "public static Point2D SplashKit.RandomScreenPoint();" ], "pascal": [ - "function PointInCircle(ptx: Double; pty: Double; cx: Double; cy: Double; radius: Double): Boolean" + "function RandomScreenPoint(): Point2D" ] } }, { - "signature": "bool point_in_quad(const point_2d &pt,const quad &q);", - "name": "point_in_quad", + "signature": "point_2d random_window_point(window wind);", + "name": "random_window_point", "method_name": null, - "unique_global_name": "point_in_quad", + "unique_global_name": "random_window_point", "unique_method_name": null, "suffix_name": null, - "description": "Tests if a point is in a quad.", + "description": "Returns a random point on the provided window.", "brief": null, "return": { - "type": "bool", - "description": "True if pt lies within the area of q.", + "type": "point_2d", + "description": "A point within the bounds of the window", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { - "type": "point_2d", - "description": "The point to test.", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "q": { - "type": "quad", - "description": "The quad to check if the point is within.", + "wind": { + "type": "window", + "description": "The window", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -18720,41 +18525,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def point_in_quad(pt, q):" - ], "cpp": [ - "bool point_in_quad(const point_2d &pt, const quad &q)" + "point_2d random_window_point(window wind)" + ], + "python": [ + "def random_window_point(wind):" ], "csharp": [ - "public static bool SplashKit.PointInQuad(Point2D pt, Quad q);" + "public static Point2D SplashKit.RandomWindowPoint(Window wind);" ], "pascal": [ - "function PointInQuad(const pt: Point2D; const q: Quad): Boolean" + "function RandomWindowPoint(wind: Window): Point2D" ] } }, { - "signature": "bool point_in_rectangle(const point_2d &pt,const rectangle &rect);", - "name": "point_in_rectangle", + "signature": "bool same_point(const point_2d &pt1,const point_2d &pt2);", + "name": "same_point", "method_name": null, - "unique_global_name": "point_in_rectangle", + "unique_global_name": "same_point", "unique_method_name": null, "suffix_name": null, - "description": "Returns true if point `pt` is in the Rectangle `rect`.", + "description": "Returns True of `pt1` is at the same point as `pt2`. This checks at an\ninteger level, indicating the two points refer to the same pixel.", "brief": null, "return": { "type": "bool", - "description": "True if the point is within the rectangle", + "description": "True if the two points are at the same location", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { + "pt1": { "type": "point_2d", - "description": "The point to test", + "description": "The first point", "is_pointer": false, "is_const": true, "is_reference": true, @@ -18765,9 +18570,9 @@ "is_vector": false, "type_parameter": null }, - "rect": { - "type": "rectangle", - "description": "The rectangle to check", + "pt2": { + "type": "point_2d", + "description": "The other point", "is_pointer": false, "is_const": true, "is_reference": true, @@ -18784,83 +18589,44 @@ "static": "geometry" }, "signatures": { - "python": [ - "def point_in_rectangle(pt, rect):" - ], "cpp": [ - "bool point_in_rectangle(const point_2d &pt, const rectangle &rect)" + "bool same_point(const point_2d &pt1, const point_2d &pt2)" + ], + "python": [ + "def same_point(pt1, pt2):" ], "csharp": [ - "public static bool SplashKit.PointInRectangle(Point2D pt, Rectangle rect);" + "public static bool SplashKit.SamePoint(Point2D pt1, Point2D pt2);" ], "pascal": [ - "function PointInRectangle(const pt: Point2D; const rect: Rectangle): Boolean" + "function SamePoint(const pt1: Point2D; const pt2: Point2D): Boolean" ] } }, { - "signature": "bool point_in_rectangle(double ptx,double pty,double rect_x,double rect_y,double rect_width,double rect_height);", - "name": "point_in_rectangle", + "signature": "quad quad_from(const point_2d& line_origin,const point_2d& line_end,double width);", + "name": "quad_from", "method_name": null, - "unique_global_name": "point_in_rectangle_with_values", + "unique_global_name": "quad_from_from_line", "unique_method_name": null, "suffix_name": null, - "description": "Returns true if the point is within the bounds of a Rectangle.", + "description": "Returns a quad from the passed in line and width.\nThe quad will be a rectangle with the line as the diagonal,\nand the width as the width of the rectangle.", "brief": null, "return": { - "type": "bool", - "description": "true when the point is in the rectangle, otherwise it returns false.", + "type": "quad", + "description": "A quad that represents the line with the given width", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "ptx": { - "type": "double", - "description": "the x value of the point", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "pty": { - "type": "double", - "description": "the y value of the point", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect_x": { - "type": "double", - "description": "x value of the rectangle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect_y": { - "type": "double", - "description": "y value of the rectangle", + "line_origin": { + "type": "point_2d", + "description": "The origin of the line", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -18868,12 +18634,12 @@ "is_vector": false, "type_parameter": null }, - "rect_width": { - "type": "double", - "description": "width of the rectangle", + "line_end": { + "type": "point_2d", + "description": "The end of the line", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -18881,9 +18647,9 @@ "is_vector": false, "type_parameter": null }, - "rect_height": { + "width": { "type": "double", - "description": "height of the rectangle", + "description": "The width of the quad", "is_pointer": false, "is_const": false, "is_reference": false, @@ -18896,110 +18662,46 @@ } }, "attributes": { - "suffix": "with_values", + "suffix": "from_line", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def point_in_rectangle_with_values(ptx, pty, rect_x, rect_y, rect_width, rect_height):" - ], "cpp": [ - "bool point_in_rectangle(double ptx, double pty, double rect_x, double rect_y, double rect_width, double rect_height)" - ], - "csharp": [ - "public static bool SplashKit.PointInRectangle(double ptx, double pty, double rectX, double rectY, double rectWidth, double rectHeight);" + "quad quad_from(const point_2d &line_origin, const point_2d &line_end, double width)" ], - "pascal": [ - "function PointInRectangle(ptx: Double; pty: Double; rectX: Double; rectY: Double; rectWidth: Double; rectHeight: Double): Boolean" - ] - } - }, - { - "signature": "bool point_in_triangle(const point_2d &pt,const triangle &tri);", - "name": "point_in_triangle", - "method_name": null, - "unique_global_name": "point_in_triangle", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns true if the point `pt` is in the Triangle `tri`.", - "brief": null, - "return": { - "type": "bool", - "description": "True if the point is within the triangle", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "pt": { - "type": "point_2d", - "description": "The point to test", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "tri": { - "type": "triangle", - "description": "The triangle to check", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "geometry", - "static": "geometry" - }, - "signatures": { "python": [ - "def point_in_triangle(pt, tri):" - ], - "cpp": [ - "bool point_in_triangle(const point_2d &pt, const triangle &tri)" + "def quad_from_from_line(line_origin, line_end, width):" ], "csharp": [ - "public static bool SplashKit.PointInTriangle(Point2D pt, Triangle tri);" + "public static Quad SplashKit.QuadFrom(Point2D lineOrigin, Point2D lineEnd, double width);" ], "pascal": [ - "function PointInTriangle(const pt: Point2D; const tri: Triangle): Boolean" + "function QuadFrom(const lineOrigin: Point2D; const lineEnd: Point2D; width: Double): Quad" ] } }, { - "signature": "float point_line_distance(const point_2d &pt,const line &l);", - "name": "point_line_distance", + "signature": "quad quad_from(const point_2d &p1,const point_2d &p2,const point_2d &p3,const point_2d &p4);", + "name": "quad_from", "method_name": null, - "unique_global_name": "point_line_distance", + "unique_global_name": "quad_from_points", "unique_method_name": null, "suffix_name": null, - "description": "Returns the distance from a point to a line.", + "description": "Returns a quad from the passed in points.", "brief": null, "return": { - "type": "float", - "description": "The distance from `pt` to `l`", + "type": "quad", + "description": "A quad from the passed in points", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { + "p1": { "type": "point_2d", - "description": "The point", + "description": "The top left of the quad.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19010,9 +18712,9 @@ "is_vector": false, "type_parameter": null }, - "l": { - "type": "line", - "description": "The line", + "p2": { + "type": "point_2d", + "description": "The top right of the quad", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19022,48 +18724,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "group": "geometry", - "static": "geometry" - }, - "signatures": { - "python": [ - "def point_line_distance(pt, l):" - ], - "cpp": [ - "float point_line_distance(const point_2d &pt, const line &l)" - ], - "csharp": [ - "public static float SplashKit.PointLineDistance(Point2D pt, Line l);" - ], - "pascal": [ - "function PointLineDistance(const pt: Point2D; const l: Line): Single" - ] - } - }, - { - "signature": "point_2d point_offset_by(const point_2d &start_point,const vector_2d &offset);", - "name": "point_offset_by", - "method_name": null, - "unique_global_name": "point_offset_by", - "unique_method_name": null, - "suffix_name": null, - "description": "Calculate the `point_2d` that is offset from the `start_point` by the\n`offset`", - "brief": null, - "return": { - "type": "point_2d", - "description": "A new point as a result of moving by the offset from\nthe starting point", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "start_point": { + }, + "p3": { "type": "point_2d", - "description": "The starting point", + "description": "The bottom left of the quad", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19074,9 +18738,9 @@ "is_vector": false, "type_parameter": null }, - "offset": { - "type": "vector_2d", - "description": "The distance and direction to move", + "p4": { + "type": "point_2d", + "description": "The bottom right of the quad", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19089,45 +18753,46 @@ } }, "attributes": { + "suffix": "points", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def point_offset_by(start_point, offset):" - ], "cpp": [ - "point_2d point_offset_by(const point_2d &start_point, const vector_2d &offset)" + "quad quad_from(const point_2d &p1, const point_2d &p2, const point_2d &p3, const point_2d &p4)" + ], + "python": [ + "def quad_from_points(p1, p2, p3, p4):" ], "csharp": [ - "public static Point2D SplashKit.PointOffsetBy(Point2D startPoint, Vector2D offset);" + "public static Quad SplashKit.QuadFrom(Point2D p1, Point2D p2, Point2D p3, Point2D p4);" ], "pascal": [ - "function PointOffsetBy(const startPoint: Point2D; const offset: Vector2D): Point2D" + "function QuadFrom(const p1: Point2D; const p2: Point2D; const p3: Point2D; const p4: Point2D): Quad" ] } }, { - "signature": "point_2d point_offset_from_origin(const vector_2d &offset);", - "name": "point_offset_from_origin", + "signature": "quad quad_from(const rectangle &rect);", + "name": "quad_from", "method_name": null, - "unique_global_name": "point_offset_from_origin", + "unique_global_name": "quad_from_rectangle", "unique_method_name": null, "suffix_name": null, - "description": "Returns the point offset from the origin by the provided vector.", + "description": "Returns a quad from the x-y points of a given recatangle", "brief": null, "return": { - "type": "point_2d", - "description": "A new point as a result of moving by the offset from\nthe starting point", + "type": "quad", + "description": "A quad at the same location as the rectangle", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "offset": { - "type": "vector_2d", - "description": "The distance and direction to move", + "rect": { + "type": "rectangle", + "description": "The rectangle to convert to a quad", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19140,45 +18805,46 @@ } }, "attributes": { + "suffix": "rectangle", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def point_offset_from_origin(offset):" - ], "cpp": [ - "point_2d point_offset_from_origin(const vector_2d &offset)" + "quad quad_from(const rectangle &rect)" + ], + "python": [ + "def quad_from_rectangle(rect):" ], "csharp": [ - "public static Point2D SplashKit.PointOffsetFromOrigin(Vector2D offset);" + "public static Quad SplashKit.QuadFrom(Rectangle rect);" ], "pascal": [ - "function PointOffsetFromOrigin(const offset: Vector2D): Point2D" + "function QuadFrom(const rect: Rectangle): Quad" ] } }, { - "signature": "bool point_on_line(const point_2d &pt,const line &l);", - "name": "point_on_line", + "signature": "quad quad_from(const rectangle &rect,const matrix_2d &transform);", + "name": "quad_from", "method_name": null, - "unique_global_name": "point_on_line", + "unique_global_name": "quad_from_rectangle_with_transformation", "unique_method_name": null, "suffix_name": null, - "description": "Returns true if point `pt` is on the line `l`.", + "description": "Returns a quad from the rectangle, then applies the transformation to\nthe quads points.", "brief": null, "return": { - "type": "bool", - "description": "True if the point is on the line", + "type": "quad", + "description": "A quad that represents the rectangle after the transformation.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { - "type": "point_2d", - "description": "The point to test", + "rect": { + "type": "rectangle", + "description": "The rectangle to transform to a quad.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19189,9 +18855,9 @@ "is_vector": false, "type_parameter": null }, - "l": { - "type": "line", - "description": "The line to check", + "transform": { + "type": "matrix_2d", + "description": "A transform to apply to the resulting quad.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19204,48 +18870,49 @@ } }, "attributes": { + "suffix": "rectangle_with_transformation", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def point_on_line(pt, l):" - ], "cpp": [ - "bool point_on_line(const point_2d &pt, const line &l)" + "quad quad_from(const rectangle &rect, const matrix_2d &transform)" + ], + "python": [ + "def quad_from_rectangle_with_transformation(rect, transform):" ], "csharp": [ - "public static bool SplashKit.PointOnLine(Point2D pt, Line l);" + "public static Quad SplashKit.QuadFrom(Rectangle rect, Matrix2D transform);" ], "pascal": [ - "function PointOnLine(const pt: Point2D; const l: Line): Boolean" + "function QuadFrom(const rect: Rectangle; const transform: Matrix2D): Quad" ] } }, { - "signature": "bool point_on_line(const point_2d &pt,const line &l,float proximity);", - "name": "point_on_line", + "signature": "quad quad_from(double x_top_left,double y_top_left,double x_top_right,double y_top_right,double x_bottom_left,double y_bottom_left,double x_bottom_right,double y_bottom_right );", + "name": "quad_from", "method_name": null, - "unique_global_name": "point_on_line_with_proximity", + "unique_global_name": "quad_from", "unique_method_name": null, "suffix_name": null, - "description": "Returns true when the point `pt` is on the line `l`. The\nproximity value is used to set the sensitivity -- higher values\neffectively make the line thicker.", + "description": "Returns a quad for the passed in x & y points.", "brief": null, "return": { - "type": "bool", - "description": "True if the point is on the line", + "type": "quad", + "description": "A quad with the indicated points", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { - "type": "point_2d", - "description": "The point to test", + "x_top_left": { + "type": "double", + "description": "X coordinate of the top left of the quad", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -19253,12 +18920,12 @@ "is_vector": false, "type_parameter": null }, - "l": { - "type": "line", - "description": "The line to check", + "y_top_left": { + "type": "double", + "description": "Y coordinate of the top left of the quad", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -19266,9 +18933,9 @@ "is_vector": false, "type_parameter": null }, - "proximity": { - "type": "float", - "description": "The sensitivity to allow close approximities", + "x_top_right": { + "type": "double", + "description": "X coordinate of the top right of the quad", "is_pointer": false, "is_const": false, "is_reference": false, @@ -19278,49 +18945,113 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "suffix": "with_proximity", + }, + "y_top_right": { + "type": "double", + "description": "Y coordinate of the top right of the quad", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x_bottom_left": { + "type": "double", + "description": "X coordinate of the bottom left of the quad", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y_bottom_left": { + "type": "double", + "description": "Y coordinate of the bottom left of the quad", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x_bottom_right": { + "type": "double", + "description": "X coordinate of the bottom right of the quad", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y_bottom_right": { + "type": "double", + "description": "Y coordinate of the bottom right of the quad", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } + }, + "attributes": { "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def point_on_line_with_proximity(pt, l, proximity):" - ], "cpp": [ - "bool point_on_line(const point_2d &pt, const line &l, float proximity)" + "quad quad_from(double x_top_left, double y_top_left, double x_top_right, double y_top_right, double x_bottom_left, double y_bottom_left, double x_bottom_right, double y_bottom_right)" + ], + "python": [ + "def quad_from(x_top_left, y_top_left, x_top_right, y_top_right, x_bottom_left, y_bottom_left, x_bottom_right, y_bottom_right):" ], "csharp": [ - "public static bool SplashKit.PointOnLine(Point2D pt, Line l, float proximity);" + "public static Quad SplashKit.QuadFrom(double xTopLeft, double yTopLeft, double xTopRight, double yTopRight, double xBottomLeft, double yBottomLeft, double xBottomRight, double yBottomRight);" ], "pascal": [ - "function PointOnLine(const pt: Point2D; const l: Line; proximity: Single): Boolean" + "function QuadFrom(xTopLeft: Double; yTopLeft: Double; xTopRight: Double; yTopRight: Double; xBottomLeft: Double; yBottomLeft: Double; xBottomRight: Double; yBottomRight: Double): Quad" ] } }, { - "signature": "float point_point_angle(const point_2d &pt1,const point_2d &pt2);", - "name": "point_point_angle", + "signature": "bool quad_ray_intersection(const point_2d &origin,const vector_2d &heading,const quad &q);", + "name": "quad_ray_intersection", "method_name": null, - "unique_global_name": "point_point_angle", + "unique_global_name": "quad_ray_intersection", "unique_method_name": null, "suffix_name": null, - "description": "Returns the angle between two points in degrees.", + "description": "Detects if a ray intersects a quad.", "brief": null, "return": { - "type": "float", - "description": "The angle (in degrees) of the line between the points", + "type": "bool", + "description": "True if the ray intersects the quad, false otherwise", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt1": { + "origin": { "type": "point_2d", - "description": "The first point", + "description": "The starting point of the ray", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19331,9 +19062,22 @@ "is_vector": false, "type_parameter": null }, - "pt2": { - "type": "point_2d", - "description": "The other point", + "heading": { + "type": "vector_2d", + "description": "The direction of the ray as a vector", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "q": { + "type": "quad", + "description": "The quad to check for intersection", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19350,41 +19094,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def point_point_angle(pt1, pt2):" - ], "cpp": [ - "float point_point_angle(const point_2d &pt1, const point_2d &pt2)" + "bool quad_ray_intersection(const point_2d &origin, const vector_2d &heading, const quad &q)" + ], + "python": [ + "def quad_ray_intersection(origin, heading, q):" ], "csharp": [ - "public static float SplashKit.PointPointAngle(Point2D pt1, Point2D pt2);" + "public static bool SplashKit.QuadRayIntersection(Point2D origin, Vector2D heading, Quad q);" ], "pascal": [ - "function PointPointAngle(const pt1: Point2D; const pt2: Point2D): Single" + "function QuadRayIntersection(const origin: Point2D; const heading: Vector2D; const q: Quad): Boolean" ] } }, { - "signature": "double point_point_distance(const point_2d &pt1,const point_2d &pt2);", - "name": "point_point_distance", + "signature": "bool quad_ray_intersection(const point_2d &origin,const vector_2d &heading,const quad &q,point_2d &hit_point,double &hit_distance);", + "name": "quad_ray_intersection", "method_name": null, - "unique_global_name": "point_point_distance", + "unique_global_name": "quad_ray_intersection_with_hit_point_and_distance", "unique_method_name": null, "suffix_name": null, - "description": "Returns the distance between two points.", + "description": "Detects if a ray intersects a quad. If an intersection is found, the\n`hit_point` and `hit_distance` are set to the point of intersection and the\ndistance from the ray's origin to the intersection point. If the ray's `origin`\nis contained within the quad, `hit_point` is set to the `origin` and `hit_distance`\nis set to 0. If no intersection is found, `hit_point` and `hit_distance` are not modified.", "brief": null, "return": { - "type": "double", - "description": "The distance between the two points", + "type": "bool", + "description": "True if the ray intersects the quad, false otherwise", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt1": { + "origin": { "type": "point_2d", - "description": "The first point", + "description": "The starting point of the ray", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19395,60 +19139,113 @@ "is_vector": false, "type_parameter": null }, - "pt2": { - "type": "point_2d", - "description": "The other point", + "heading": { + "type": "vector_2d", + "description": "The direction of the ray as a vector", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "q": { + "type": "quad", + "description": "The quad to check for intersection", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "hit_point": { + "type": "point_2d", + "description": "The point to set to where the ray intersects the quad", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "hit_distance": { + "type": "double", + "description": "The double to set to the distance from the ray's origin to\nthe intersection point", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { + "suffix": "with_hit_point_and_distance", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def point_point_distance(pt1, pt2):" - ], "cpp": [ - "double point_point_distance(const point_2d &pt1, const point_2d &pt2)" + "bool quad_ray_intersection(const point_2d &origin, const vector_2d &heading, const quad &q, point_2d &hit_point, double &hit_distance)" + ], + "python": [ + "def quad_ray_intersection_with_hit_point_and_distance(origin, heading, q, hit_point, hit_distance):" ], "csharp": [ - "public static double SplashKit.PointPointDistance(Point2D pt1, Point2D pt2);" + "public static bool SplashKit.QuadRayIntersection(Point2D origin, Vector2D heading, Quad q, ref Point2D hitPoint, ref double hitDistance);" ], "pascal": [ - "function PointPointDistance(const pt1: Point2D; const pt2: Point2D): Double" + "function QuadRayIntersection(const origin: Point2D; const heading: Vector2D; const q: Quad; var hitPoint: Point2D; var hitDistance: Double): Boolean" ] } }, { - "signature": "string point_to_string(const point_2d &pt);", - "name": "point_to_string", + "signature": "bool quads_intersect(const quad &q1,const quad &q2);", + "name": "quads_intersect", "method_name": null, - "unique_global_name": "point_to_string", + "unique_global_name": "quads_intersect", "unique_method_name": null, "suffix_name": null, - "description": "Get a text description of the `point_2d`.", + "description": "Returns true if two quads intersect.", "brief": null, "return": { - "type": "string", - "description": "A string representation of the point", + "type": "bool", + "description": "True if the two quads intersect.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { - "type": "point_2d", - "description": "The point details", + "q1": { + "type": "quad", + "description": "The first quad", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "q2": { + "type": "quad", + "description": "The second quad", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19465,47 +19262,73 @@ "static": "geometry" }, "signatures": { - "python": [ - "def point_to_string(pt):" - ], "cpp": [ - "string point_to_string(const point_2d &pt)" + "bool quads_intersect(const quad &q1, const quad &q2)" + ], + "python": [ + "def quads_intersect(q1, q2):" ], "csharp": [ - "public static string SplashKit.PointToString(Point2D pt);" + "public static bool SplashKit.QuadsIntersect(Quad q1, Quad q2);" ], "pascal": [ - "function PointToString(const pt: Point2D): String" + "function QuadsIntersect(const q1: Quad; const q2: Quad): Boolean" ] } }, { - "signature": "point_2d random_bitmap_point(bitmap bmp);", - "name": "random_bitmap_point", + "signature": "void set_quad_point(quad &q,int idx,const point_2d &value);", + "name": "set_quad_point", "method_name": null, - "unique_global_name": "random_bitmap_point", + "unique_global_name": "set_quad_point", "unique_method_name": null, "suffix_name": null, - "description": "Returns a random point within the bounds of the bitmap.", + "description": "Change a point in a quad.", "brief": null, "return": { - "type": "point_2d", - "description": "A point within the bounds of the bitmap", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap", + "q": { + "type": "quad", + "description": "The quad to change", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "idx": { + "type": "int", + "description": "The index of the point: 0 is top left, 1 is top right, 2 is\nbottom left, and 3 is bottom right", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "value": { + "type": "point_2d", + "description": "The new value for that point in the quad", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null @@ -19516,79 +19339,105 @@ "static": "geometry" }, "signatures": { - "python": [ - "def random_bitmap_point(bmp):" - ], "cpp": [ - "point_2d random_bitmap_point(bitmap bmp)" + "void set_quad_point(quad &q, int idx, const point_2d &value)" + ], + "python": [ + "def set_quad_point(q, idx, value):" ], "csharp": [ - "public static Point2D SplashKit.RandomBitmapPoint(Bitmap bmp);" + "public static void SplashKit.SetQuadPoint(ref Quad q, int idx, Point2D value);" ], "pascal": [ - "function RandomBitmapPoint(bmp: Bitmap): Point2D" + "procedure SetQuadPoint(var q: Quad; idx: Integer; const value: Point2D)" ] } }, { - "signature": "point_2d random_screen_point();", - "name": "random_screen_point", + "signature": "vector triangles_from(const quad &q);", + "name": "triangles_from", "method_name": null, - "unique_global_name": "random_screen_point", + "unique_global_name": "triangles_from", "unique_method_name": null, "suffix_name": null, - "description": "Returns a random point on the current window.", + "description": "Returns the two triangles that make up a quad in a vector.", "brief": null, "return": { - "type": "point_2d", - "description": "A point within the bounds of the current window", + "type": "vector", + "description": "A vector with the two triangles from the quad.", "is_pointer": false, "is_reference": false, - "is_vector": false, - "type_parameter": null + "is_vector": true, + "type_parameter": "triangle" }, "parameters": { + "q": { + "type": "quad", + "description": "The quad", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def random_screen_point():" - ], "cpp": [ - "point_2d random_screen_point()" + "vector triangles_from(const quad &q)" + ], + "python": [ + "def triangles_from(q):" ], "csharp": [ - "public static Point2D SplashKit.RandomScreenPoint();" + "public static List SplashKit.TrianglesFrom(Quad q);" ], "pascal": [ - "function RandomScreenPoint(): Point2D" + "function TrianglesFrom(const q: Quad): ArrayOfTriangle" ] } }, { - "signature": "point_2d random_window_point(window wind);", - "name": "random_window_point", - "method_name": "random_point", - "unique_global_name": "random_window_point", - "unique_method_name": "window.random_point", + "signature": "rectangle inset_rectangle(const rectangle &rect,float inset_amount);", + "name": "inset_rectangle", + "method_name": null, + "unique_global_name": "inset_rectangle", + "unique_method_name": null, "suffix_name": null, - "description": "Returns a random point on the provided window.", + "description": "Return a rectangle that is inset an amount from a given rectangle.", "brief": null, "return": { - "type": "point_2d", - "description": "A point within the bounds of the window", + "type": "rectangle", + "description": "A new rectangle created inset from `rect`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "wind": { - "type": "window", - "description": "The window", + "rect": { + "type": "rectangle", + "description": "The rectangle to inset", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "inset_amount": { + "type": "float", + "description": "The amount to inset the rectangle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -19601,49 +19450,45 @@ } }, "attributes": { - "class": "window", - "method": "random_point", "group": "geometry", - "static": "geometry", - "self": "wind" + "static": "geometry" }, "signatures": { - "python": [ - "def random_window_point(wind):" - ], "cpp": [ - "point_2d random_window_point(window wind)" + "rectangle inset_rectangle(const rectangle &rect, float inset_amount)" + ], + "python": [ + "def inset_rectangle(rect, inset_amount):" ], "csharp": [ - "public Point2D Window.RandomPoint();", - "public static Point2D SplashKit.RandomWindowPoint(Window wind);" + "public static Rectangle SplashKit.InsetRectangle(Rectangle rect, float insetAmount);" ], "pascal": [ - "function RandomWindowPoint(wind: Window): Point2D" + "function InsetRectangle(const rect: Rectangle; insetAmount: Single): Rectangle" ] } }, { - "signature": "bool same_point(const point_2d &pt1,const point_2d &pt2);", - "name": "same_point", + "signature": "rectangle intersection(const rectangle &rect1,const rectangle &rect2);", + "name": "intersection", "method_name": null, - "unique_global_name": "same_point", + "unique_global_name": "intersection", "unique_method_name": null, "suffix_name": null, - "description": "Returns True of `pt1` is at the same point as `pt2`. This checks at an\ninteger level, indicating the two points refer to the same pixel.", + "description": "Returns a rectangle that represents the intersection of two rectangles.", "brief": null, "return": { - "type": "bool", - "description": "True if the two points are at the same location", + "type": "rectangle", + "description": "The intersection of rect1 and rect2.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt1": { - "type": "point_2d", - "description": "The first point", + "rect1": { + "type": "rectangle", + "description": "The first rectangle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19654,9 +19499,9 @@ "is_vector": false, "type_parameter": null }, - "pt2": { - "type": "point_2d", - "description": "The other point", + "rect2": { + "type": "rectangle", + "description": "The second rectangle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19673,119 +19518,93 @@ "static": "geometry" }, "signatures": { - "python": [ - "def same_point(pt1, pt2):" - ], "cpp": [ - "bool same_point(const point_2d &pt1, const point_2d &pt2)" + "rectangle intersection(const rectangle &rect1, const rectangle &rect2)" + ], + "python": [ + "def intersection(rect1, rect2):" ], "csharp": [ - "public static bool SplashKit.SamePoint(Point2D pt1, Point2D pt2);" + "public static Rectangle SplashKit.Intersection(Rectangle rect1, Rectangle rect2);" ], "pascal": [ - "function SamePoint(const pt1: Point2D; const pt2: Point2D): Boolean" + "function Intersection(const rect1: Rectangle; const rect2: Rectangle): Rectangle" ] } }, { - "signature": "quad quad_from(const point_2d& line_origin,const point_2d& line_end,double width);", - "name": "quad_from", + "signature": "rectangle rectangle_around(const circle &c);", + "name": "rectangle_around", "method_name": null, - "unique_global_name": "quad_from_from_line", + "unique_global_name": "rectangle_around_circle", "unique_method_name": null, "suffix_name": null, - "description": "Returns a quad from the passed in line and width.\nThe quad will be a rectangle with the line as the diagonal,\nand the width as the width of the rectangle.", + "description": "Returns a rectangle that surrounds a given circle", "brief": null, "return": { - "type": "quad", - "description": "A quad that represents the line with the given width", + "type": "rectangle", + "description": "A rectangle that will surround the circle", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "line_origin": { - "type": "point_2d", - "description": "The origin of the line", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "line_end": { - "type": "point_2d", - "description": "The end of the line", + "c": { + "type": "circle", + "description": "The circle", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "width": { - "type": "double", - "description": "The width of the quad", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "suffix": "from_line", + "suffix": "circle", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def quad_from_from_line(line_origin, line_end, width):" - ], "cpp": [ - "quad quad_from(const point_2d &line_origin, const point_2d &line_end, double width)" + "rectangle rectangle_around(const circle &c)" + ], + "python": [ + "def rectangle_around_circle(c):" ], "csharp": [ - "public static Quad SplashKit.QuadFrom(Point2D lineOrigin, Point2D lineEnd, double width);" + "public static Rectangle SplashKit.RectangleAround(Circle c);" ], "pascal": [ - "function QuadFrom(const lineOrigin: Point2D; const lineEnd: Point2D; width: Double): Quad" + "function RectangleAround(const c: Circle): Rectangle" ] } }, { - "signature": "quad quad_from(const point_2d &p1,const point_2d &p2,const point_2d &p3,const point_2d &p4);", - "name": "quad_from", + "signature": "rectangle rectangle_around(const line &l);", + "name": "rectangle_around", "method_name": null, - "unique_global_name": "quad_from_points", + "unique_global_name": "rectangle_around_line", "unique_method_name": null, "suffix_name": null, - "description": "Returns a quad from the passed in points.", + "description": "Returns a rectangle that surrounds a given line segment", "brief": null, "return": { - "type": "quad", - "description": "A quad from the passed in points", + "type": "rectangle", + "description": "A rectangle that will surround the line", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "p1": { - "type": "point_2d", - "description": "The top left of the quad.", + "l": { + "type": "line", + "description": "The line", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19795,23 +19614,49 @@ ], "is_vector": false, "type_parameter": null - }, - "p2": { - "type": "point_2d", - "description": "The top right of the quad", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "p3": { - "type": "point_2d", - "description": "The bottom left of the quad", + } + }, + "attributes": { + "suffix": "line", + "group": "geometry", + "static": "geometry" + }, + "signatures": { + "cpp": [ + "rectangle rectangle_around(const line &l)" + ], + "python": [ + "def rectangle_around_line(l):" + ], + "csharp": [ + "public static Rectangle SplashKit.RectangleAround(Line l);" + ], + "pascal": [ + "function RectangleAround(const l: Line): Rectangle" + ] + } + }, + { + "signature": "rectangle rectangle_around(const quad &q);", + "name": "rectangle_around", + "method_name": null, + "unique_global_name": "rectangle_around_quad", + "unique_method_name": null, + "suffix_name": null, + "description": "Returns a rectangle that surrounds a given quad.", + "brief": null, + "return": { + "type": "rectangle", + "description": "A rectangle that will surround the quad", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "q": { + "type": "quad", + "description": "The quad", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19821,10 +19666,49 @@ ], "is_vector": false, "type_parameter": null - }, - "p4": { - "type": "point_2d", - "description": "The bottom right of the quad", + } + }, + "attributes": { + "suffix": "quad", + "group": "geometry", + "static": "geometry" + }, + "signatures": { + "cpp": [ + "rectangle rectangle_around(const quad &q)" + ], + "python": [ + "def rectangle_around_quad(q):" + ], + "csharp": [ + "public static Rectangle SplashKit.RectangleAround(Quad q);" + ], + "pascal": [ + "function RectangleAround(const q: Quad): Rectangle" + ] + } + }, + { + "signature": "rectangle rectangle_around(const triangle &t);", + "name": "rectangle_around", + "method_name": null, + "unique_global_name": "rectangle_around_triangle", + "unique_method_name": null, + "suffix_name": null, + "description": "Returns a rectangle that surrounds a given triangle", + "brief": null, + "return": { + "type": "rectangle", + "description": "A rectangle that will surround the triangle", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "t": { + "type": "triangle", + "description": "The triangle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19837,37 +19721,37 @@ } }, "attributes": { - "suffix": "points", + "suffix": "triangle", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def quad_from_points(p1, p2, p3, p4):" - ], "cpp": [ - "quad quad_from(const point_2d &p1, const point_2d &p2, const point_2d &p3, const point_2d &p4)" + "rectangle rectangle_around(const triangle &t)" + ], + "python": [ + "def rectangle_around_triangle(t):" ], "csharp": [ - "public static Quad SplashKit.QuadFrom(Point2D p1, Point2D p2, Point2D p3, Point2D p4);" + "public static Rectangle SplashKit.RectangleAround(Triangle t);" ], "pascal": [ - "function QuadFrom(const p1: Point2D; const p2: Point2D; const p3: Point2D; const p4: Point2D): Quad" + "function RectangleAround(const t: Triangle): Rectangle" ] } }, { - "signature": "quad quad_from(const rectangle &rect);", - "name": "quad_from", + "signature": "double rectangle_bottom(const rectangle &rect);", + "name": "rectangle_bottom", "method_name": null, - "unique_global_name": "quad_from_rectangle", + "unique_global_name": "rectangle_bottom", "unique_method_name": null, "suffix_name": null, - "description": "Returns a quad from the x-y points of a given recatangle", + "description": "The location of the bottom of the rectangle.", "brief": null, "return": { - "type": "quad", - "description": "A quad at the same location as the rectangle", + "type": "double", + "description": "The distance from the top of the screen to the bottom of\nthe rectangle.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -19876,7 +19760,7 @@ "parameters": { "rect": { "type": "rectangle", - "description": "The rectangle to convert to a quad", + "description": "The rectangle.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19889,37 +19773,36 @@ } }, "attributes": { - "suffix": "rectangle", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def quad_from_rectangle(rect):" - ], "cpp": [ - "quad quad_from(const rectangle &rect)" + "double rectangle_bottom(const rectangle &rect)" + ], + "python": [ + "def rectangle_bottom(rect):" ], "csharp": [ - "public static Quad SplashKit.QuadFrom(Rectangle rect);" + "public static double SplashKit.RectangleBottom(Rectangle rect);" ], "pascal": [ - "function QuadFrom(const rect: Rectangle): Quad" + "function RectangleBottom(const rect: Rectangle): Double" ] } }, { - "signature": "quad quad_from(const rectangle &rect,const matrix_2d &transform);", - "name": "quad_from", + "signature": "point_2d rectangle_center(const rectangle &rect);", + "name": "rectangle_center", "method_name": null, - "unique_global_name": "quad_from_rectangle_with_transformation", + "unique_global_name": "rectangle_center", "unique_method_name": null, "suffix_name": null, - "description": "Returns a quad from the rectangle, then applies the transformation to\nthe quads points.", + "description": "Returns the center point of a given rectangle", "brief": null, "return": { - "type": "quad", - "description": "A quad that represents the rectangle after the transformation.", + "type": "point_2d", + "description": "The center point of the vector", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -19928,20 +19811,7 @@ "parameters": { "rect": { "type": "rectangle", - "description": "The rectangle to transform to a quad.", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "transform": { - "type": "matrix_2d", - "description": "A transform to apply to the resulting quad.", + "description": "The rectangle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -19954,88 +19824,48 @@ } }, "attributes": { - "suffix": "rectangle_with_transformation", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def quad_from_rectangle_with_transformation(rect, transform):" - ], "cpp": [ - "quad quad_from(const rectangle &rect, const matrix_2d &transform)" + "point_2d rectangle_center(const rectangle &rect)" + ], + "python": [ + "def rectangle_center(rect):" ], "csharp": [ - "public static Quad SplashKit.QuadFrom(Rectangle rect, Matrix2D transform);" + "public static Point2D SplashKit.RectangleCenter(Rectangle rect);" ], "pascal": [ - "function QuadFrom(const rect: Rectangle; const transform: Matrix2D): Quad" + "function RectangleCenter(const rect: Rectangle): Point2D" ] } }, { - "signature": "quad quad_from(double x_top_left,double y_top_left,double x_top_right,double y_top_right,double x_bottom_left,double y_bottom_left,double x_bottom_right,double y_bottom_right );", - "name": "quad_from", + "signature": "bool rectangle_circle_intersect(const rectangle &rect,const circle &c);", + "name": "rectangle_circle_intersect", "method_name": null, - "unique_global_name": "quad_from", + "unique_global_name": "rectangle_circle_intersect", "unique_method_name": null, "suffix_name": null, - "description": "Returns a quad for the passed in x & y points.", + "description": "Detects if a rectangle intersects with a circle.", "brief": null, "return": { - "type": "quad", - "description": "A quad with the indicated points", + "type": "bool", + "description": "True if the rectangle and circle intersect, false otherwise", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "x_top_left": { - "type": "double", - "description": "X coordinate of the top left of the quad", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y_top_left": { - "type": "double", - "description": "Y coordinate of the top left of the quad", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x_top_right": { - "type": "double", - "description": "X coordinate of the top right of the quad", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y_top_right": { - "type": "double", - "description": "Y coordinate of the top right of the quad", + "rect": { + "type": "rectangle", + "description": "The rectangle to test", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -20043,24 +19873,62 @@ "is_vector": false, "type_parameter": null }, - "x_bottom_left": { - "type": "double", - "description": "X coordinate of the bottom left of the quad", + "c": { + "type": "circle", + "description": "The circle to test", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - }, - "y_bottom_left": { - "type": "double", - "description": "Y coordinate of the bottom left of the quad", + } + }, + "attributes": { + "group": "geometry", + "static": "geometry" + }, + "signatures": { + "cpp": [ + "bool rectangle_circle_intersect(const rectangle &rect, const circle &c)" + ], + "python": [ + "def rectangle_circle_intersect(rect, c):" + ], + "csharp": [ + "public static bool SplashKit.RectangleCircleIntersect(Rectangle rect, Circle c);" + ], + "pascal": [ + "function RectangleCircleIntersect(const rect: Rectangle; const c: Circle): Boolean" + ] + } + }, + { + "signature": "rectangle rectangle_from(const point_2d pt,const double width,const double height);", + "name": "rectangle_from", + "method_name": null, + "unique_global_name": "rectangle_from_point_and_size", + "unique_method_name": null, + "suffix_name": null, + "description": "Returns a rectangle at the specified point with a given width and height", + "brief": null, + "return": { + "type": "rectangle", + "description": "A rectangle with the specified dimensions and location", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "pt": { + "type": "point_2d", + "description": "The origin for the rectangle", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -20069,11 +19937,11 @@ "is_vector": false, "type_parameter": null }, - "x_bottom_right": { + "width": { "type": "double", - "description": "X coordinate of the bottom right of the quad", + "description": "Its width", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -20082,11 +19950,11 @@ "is_vector": false, "type_parameter": null }, - "y_bottom_right": { + "height": { "type": "double", - "description": "Y coordinate of the bottom right of the quad", + "description": "Its height", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -20097,61 +19965,49 @@ } }, "attributes": { + "suffix": "point_and_size", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def quad_from(x_top_left, y_top_left, x_top_right, y_top_right, x_bottom_left, y_bottom_left, x_bottom_right, y_bottom_right):" - ], "cpp": [ - "quad quad_from(double x_top_left, double y_top_left, double x_top_right, double y_top_right, double x_bottom_left, double y_bottom_left, double x_bottom_right, double y_bottom_right)" + "rectangle rectangle_from(const point_2d pt, const double width, const double height)" + ], + "python": [ + "def rectangle_from_point_and_size(pt, width, height):" ], "csharp": [ - "public static Quad SplashKit.QuadFrom(double xTopLeft, double yTopLeft, double xTopRight, double yTopRight, double xBottomLeft, double yBottomLeft, double xBottomRight, double yBottomRight);" + "public static Rectangle SplashKit.RectangleFrom(Point2D pt, double width, double height);" ], "pascal": [ - "function QuadFrom(xTopLeft: Double; yTopLeft: Double; xTopRight: Double; yTopRight: Double; xBottomLeft: Double; yBottomLeft: Double; xBottomRight: Double; yBottomRight: Double): Quad" + "function RectangleFrom(pt: Point2D; width: Double; height: Double): Rectangle" ] } }, { - "signature": "bool quad_ray_intersection(const point_2d &origin,const vector_2d &heading,const quad &q);", - "name": "quad_ray_intersection", + "signature": "rectangle rectangle_from(const point_2d pt1,const point_2d pt2);", + "name": "rectangle_from", "method_name": null, - "unique_global_name": "quad_ray_intersection", + "unique_global_name": "rectangle_from_points", "unique_method_name": null, "suffix_name": null, - "description": "Detects if a ray intersects a quad.", + "description": "Returns a rectangle with pt1 and pt2 defining the two distant edge points.", "brief": null, "return": { - "type": "bool", - "description": "True if the ray intersects the quad, false otherwise", + "type": "rectangle", + "description": "A rectangle enclosing the two points.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "origin": { + "pt1": { "type": "point_2d", - "description": "The starting point of the ray", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "heading": { - "type": "vector_2d", - "description": "The direction of the ray as a vector", + "description": "The first point", "is_pointer": false, "is_const": true, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -20159,12 +20015,12 @@ "is_vector": false, "type_parameter": null }, - "q": { - "type": "quad", - "description": "The quad to check for intersection", + "pt2": { + "type": "point_2d", + "description": "The second point", "is_pointer": false, "is_const": true, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -20174,61 +20030,49 @@ } }, "attributes": { + "suffix": "points", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def quad_ray_intersection(origin, heading, q):" - ], "cpp": [ - "bool quad_ray_intersection(const point_2d &origin, const vector_2d &heading, const quad &q)" + "rectangle rectangle_from(const point_2d pt1, const point_2d pt2)" + ], + "python": [ + "def rectangle_from_points(pt1, pt2):" ], "csharp": [ - "public static bool SplashKit.QuadRayIntersection(Point2D origin, Vector2D heading, Quad q);" + "public static Rectangle SplashKit.RectangleFrom(Point2D pt1, Point2D pt2);" ], "pascal": [ - "function QuadRayIntersection(const origin: Point2D; const heading: Vector2D; const q: Quad): Boolean" + "function RectangleFrom(pt1: Point2D; pt2: Point2D): Rectangle" ] } }, { - "signature": "bool quad_ray_intersection(const point_2d &origin,const vector_2d &heading,const quad &q,point_2d &hit_point,double &hit_distance);", - "name": "quad_ray_intersection", + "signature": "rectangle rectangle_from(double x,double y,double width,double height);", + "name": "rectangle_from", "method_name": null, - "unique_global_name": "quad_ray_intersection_with_hit_point_and_distance", + "unique_global_name": "rectangle_from", "unique_method_name": null, "suffix_name": null, - "description": "Detects if a ray intersects a quad. If an intersection is found, the\n`hit_point` and `hit_distance` are set to the point of intersection and the\ndistance from the ray's origin to the intersection point. If the ray's `origin`\nis contained within the quad, `hit_point` is set to the `origin` and `hit_distance`\nis set to 0. If no intersection is found, `hit_point` and `hit_distance` are not modified.", + "description": "Returns a rectangle from a given x,y location with the specified width\nand height.", "brief": null, "return": { - "type": "bool", - "description": "True if the ray intersects the quad, false otherwise", + "type": "rectangle", + "description": "A rectangle with the specified dimensions and location.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "origin": { - "type": "point_2d", - "description": "The starting point of the ray", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "heading": { - "type": "vector_2d", - "description": "The direction of the ray as a vector", + "x": { + "type": "double", + "description": "The x coordinate of the rectangle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -20236,12 +20080,12 @@ "is_vector": false, "type_parameter": null }, - "q": { - "type": "quad", - "description": "The quad to check for intersection", + "y": { + "type": "double", + "description": "The y coordinate of the rectangle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -20249,12 +20093,12 @@ "is_vector": false, "type_parameter": null }, - "hit_point": { - "type": "point_2d", - "description": "The point to set to where the ray intersects the quad", + "width": { + "type": "double", + "description": "The width of the rectangle", "is_pointer": false, "is_const": false, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -20262,12 +20106,12 @@ "is_vector": false, "type_parameter": null }, - "hit_distance": { + "height": { "type": "double", - "description": "The double to set to the distance from the ray's origin to\nthe intersection point", + "description": "The height of the rectangle", "is_pointer": false, "is_const": false, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -20277,59 +20121,45 @@ } }, "attributes": { - "suffix": "with_hit_point_and_distance", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def quad_ray_intersection_with_hit_point_and_distance(origin, heading, q, hit_point, hit_distance):" - ], "cpp": [ - "bool quad_ray_intersection(const point_2d &origin, const vector_2d &heading, const quad &q, point_2d &hit_point, double &hit_distance)" + "rectangle rectangle_from(double x, double y, double width, double height)" + ], + "python": [ + "def rectangle_from(x, y, width, height):" ], "csharp": [ - "public static bool SplashKit.QuadRayIntersection(Point2D origin, Vector2D heading, Quad q, ref Point2D hitPoint, ref double hitDistance);" + "public static Rectangle SplashKit.RectangleFrom(double x, double y, double width, double height);" ], "pascal": [ - "function QuadRayIntersection(const origin: Point2D; const heading: Vector2D; const q: Quad; var hitPoint: Point2D; var hitDistance: Double): Boolean" + "function RectangleFrom(x: Double; y: Double; width: Double; height: Double): Rectangle" ] } }, { - "signature": "bool quads_intersect(const quad &q1,const quad &q2);", - "name": "quads_intersect", + "signature": "double rectangle_left(const rectangle &rect);", + "name": "rectangle_left", "method_name": null, - "unique_global_name": "quads_intersect", + "unique_global_name": "rectangle_left", "unique_method_name": null, "suffix_name": null, - "description": "Returns true if two quads intersect.", + "description": "The location of the left edge of the rectangle.", "brief": null, "return": { - "type": "bool", - "description": "True if the two quads intersect.", + "type": "double", + "description": "The distance from the left of the screen to the left side of\nthe rectangle.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "q1": { - "type": "quad", - "description": "The first quad", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "q2": { - "type": "quad", - "description": "The second quad", + "rect": { + "type": "rectangle", + "description": "The rectangle.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -20346,43 +20176,43 @@ "static": "geometry" }, "signatures": { - "python": [ - "def quads_intersect(q1, q2):" - ], "cpp": [ - "bool quads_intersect(const quad &q1, const quad &q2)" + "double rectangle_left(const rectangle &rect)" + ], + "python": [ + "def rectangle_left(rect):" ], "csharp": [ - "public static bool SplashKit.QuadsIntersect(Quad q1, Quad q2);" + "public static double SplashKit.RectangleLeft(Rectangle rect);" ], "pascal": [ - "function QuadsIntersect(const q1: Quad; const q2: Quad): Boolean" + "function RectangleLeft(const rect: Rectangle): Double" ] } }, { - "signature": "void set_quad_point(quad &q,int idx,const point_2d &value);", - "name": "set_quad_point", + "signature": "rectangle rectangle_offset_by(const rectangle &rect,const vector_2d &offset);", + "name": "rectangle_offset_by", "method_name": null, - "unique_global_name": "set_quad_point", + "unique_global_name": "rectangle_offset_by", "unique_method_name": null, "suffix_name": null, - "description": "Change a point in a quad.", + "description": "Returns a rectangle that is moved by the provided vector.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "rectangle", + "description": "A new rectangle that represents the original rectangle\nafter being moved by the offset vector.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "q": { - "type": "quad", - "description": "The quad to change", + "rect": { + "type": "rectangle", + "description": "The original rectangle", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -20391,22 +20221,9 @@ "is_vector": false, "type_parameter": null }, - "idx": { - "type": "int", - "description": "The index of the point: 0 is top left, 1 is top right, 2 is\nbottom left, and 3 is bottom right", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "value": { - "type": "point_2d", - "description": "The new value for that point in the quad", + "offset": { + "type": "vector_2d", + "description": "The amount and direction for the rectangle to move", "is_pointer": false, "is_const": true, "is_reference": true, @@ -20423,41 +20240,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def set_quad_point(q, idx, value):" - ], "cpp": [ - "void set_quad_point(quad &q, int idx, const point_2d &value)" + "rectangle rectangle_offset_by(const rectangle &rect, const vector_2d &offset)" + ], + "python": [ + "def rectangle_offset_by(rect, offset):" ], "csharp": [ - "public static void SplashKit.SetQuadPoint(ref Quad q, int idx, Point2D value);" + "public static Rectangle SplashKit.RectangleOffsetBy(Rectangle rect, Vector2D offset);" ], "pascal": [ - "procedure SetQuadPoint(var q: Quad; idx: Integer; const value: Point2D)" + "function RectangleOffsetBy(const rect: Rectangle; const offset: Vector2D): Rectangle" ] } }, { - "signature": "vector triangles_from(const quad &q);", - "name": "triangles_from", + "signature": "bool rectangle_ray_intersection(const point_2d &origin,const vector_2d &heading,const rectangle &rect);", + "name": "rectangle_ray_intersection", "method_name": null, - "unique_global_name": "triangles_from", + "unique_global_name": "rectangle_ray_intersection", "unique_method_name": null, "suffix_name": null, - "description": "Returns the two triangles that make up a quad in a vector.", + "description": "Detects if a ray intersects a rectangle.", "brief": null, "return": { - "type": "vector", - "description": "A vector with the two triangles from the quad.", + "type": "bool", + "description": "True if the ray intersects the rectangle, false otherwise", "is_pointer": false, "is_reference": false, - "is_vector": true, - "type_parameter": "triangle" + "is_vector": false, + "type_parameter": null }, "parameters": { - "q": { - "type": "quad", - "description": "The quad", + "origin": { + "type": "point_2d", + "description": "The starting point of the ray", "is_pointer": false, "is_const": true, "is_reference": true, @@ -20467,48 +20284,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "group": "geometry", - "static": "geometry" - }, - "signatures": { - "python": [ - "def triangles_from(q):" - ], - "cpp": [ - "vector triangles_from(const quad &q)" - ], - "csharp": [ - "public static List SplashKit.TrianglesFrom(Quad q);" - ], - "pascal": [ - "function TrianglesFrom(const q: Quad): ArrayOfTriangle" - ] - } - }, - { - "signature": "rectangle inset_rectangle(const rectangle &rect,float inset_amount);", - "name": "inset_rectangle", - "method_name": null, - "unique_global_name": "inset_rectangle", - "unique_method_name": null, - "suffix_name": null, - "description": "Return a rectangle that is inset an amount from a given rectangle.", - "brief": null, - "return": { - "type": "rectangle", - "description": "A new rectangle created inset from `rect`", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "rect": { - "type": "rectangle", - "description": "The rectangle to inset", + }, + "heading": { + "type": "vector_2d", + "description": "The direction of the ray as a vector", "is_pointer": false, "is_const": true, "is_reference": true, @@ -20519,12 +20298,12 @@ "is_vector": false, "type_parameter": null }, - "inset_amount": { - "type": "float", - "description": "The amount to inset the rectangle", + "rect": { + "type": "rectangle", + "description": "The rectangle to check for intersection", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -20538,41 +20317,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def inset_rectangle(rect, inset_amount):" - ], "cpp": [ - "rectangle inset_rectangle(const rectangle &rect, float inset_amount)" + "bool rectangle_ray_intersection(const point_2d &origin, const vector_2d &heading, const rectangle &rect)" + ], + "python": [ + "def rectangle_ray_intersection(origin, heading, rect):" ], "csharp": [ - "public static Rectangle SplashKit.InsetRectangle(Rectangle rect, float insetAmount);" + "public static bool SplashKit.RectangleRayIntersection(Point2D origin, Vector2D heading, Rectangle rect);" ], "pascal": [ - "function InsetRectangle(const rect: Rectangle; insetAmount: Single): Rectangle" + "function RectangleRayIntersection(const origin: Point2D; const heading: Vector2D; const rect: Rectangle): Boolean" ] } }, { - "signature": "rectangle intersection(const rectangle &rect1,const rectangle &rect2);", - "name": "intersection", + "signature": "bool rectangle_ray_intersection(const point_2d &origin,const vector_2d &heading,const rectangle &rect,point_2d &hit_point,double &hit_distance);", + "name": "rectangle_ray_intersection", "method_name": null, - "unique_global_name": "intersection", + "unique_global_name": "rectangle_ray_intersection_with_hit_point_and_distance", "unique_method_name": null, "suffix_name": null, - "description": "Returns a rectangle that represents the intersection of two rectangles.", + "description": "Detects if a ray intersects a rectangle. If an intersection is found, the\n`hit_point` and `hit_distance` are set to the point of intersection and the\ndistance from the ray's origin to the intersection point. If the ray's `origin`\nis contained within the rectangle, `hit_point` is set to the `origin` and `hit_distance`\nis set to 0. If no intersection is found, `hit_point` and `hit_distance` are not modified.", "brief": null, "return": { - "type": "rectangle", - "description": "The intersection of rect1 and rect2.", + "type": "bool", + "description": "True if the ray intersects the rectangle, false otherwise", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "rect1": { - "type": "rectangle", - "description": "The first rectangle", + "origin": { + "type": "point_2d", + "description": "The starting point of the ray", "is_pointer": false, "is_const": true, "is_reference": true, @@ -20583,60 +20362,100 @@ "is_vector": false, "type_parameter": null }, - "rect2": { + "heading": { + "type": "vector_2d", + "description": "The direction of the ray as a vector", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect": { "type": "rectangle", - "description": "The second rectangle", + "description": "The rectangle to check for intersection", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "hit_point": { + "type": "point_2d", + "description": "The point to set to where the ray intersects the rectangle", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "hit_distance": { + "type": "double", + "description": "The double to set to the distance from the ray's origin to\nthe intersection point", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { + "suffix": "with_hit_point_and_distance", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def intersection(rect1, rect2):" - ], "cpp": [ - "rectangle intersection(const rectangle &rect1, const rectangle &rect2)" + "bool rectangle_ray_intersection(const point_2d &origin, const vector_2d &heading, const rectangle &rect, point_2d &hit_point, double &hit_distance)" + ], + "python": [ + "def rectangle_ray_intersection_with_hit_point_and_distance(origin, heading, rect, hit_point, hit_distance):" ], "csharp": [ - "public static Rectangle SplashKit.Intersection(Rectangle rect1, Rectangle rect2);" + "public static bool SplashKit.RectangleRayIntersection(Point2D origin, Vector2D heading, Rectangle rect, ref Point2D hitPoint, ref double hitDistance);" ], "pascal": [ - "function Intersection(const rect1: Rectangle; const rect2: Rectangle): Rectangle" + "function RectangleRayIntersection(const origin: Point2D; const heading: Vector2D; const rect: Rectangle; var hitPoint: Point2D; var hitDistance: Double): Boolean" ] } }, { - "signature": "rectangle rectangle_around(const circle &c);", - "name": "rectangle_around", + "signature": "double rectangle_right(const rectangle &rect);", + "name": "rectangle_right", "method_name": null, - "unique_global_name": "rectangle_around_circle", + "unique_global_name": "rectangle_right", "unique_method_name": null, "suffix_name": null, - "description": "Returns a rectangle that surrounds a given circle", + "description": "The location of the right edge of the rectangle.", "brief": null, "return": { - "type": "rectangle", - "description": "A rectangle that will surround the circle", + "type": "double", + "description": "The distance from the left of the screen to the right side\nof the rectangle.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "c": { - "type": "circle", - "description": "The circle", + "rect": { + "type": "rectangle", + "description": "The rectangle.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -20649,46 +20468,45 @@ } }, "attributes": { - "suffix": "circle", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def rectangle_around_circle(c):" - ], "cpp": [ - "rectangle rectangle_around(const circle &c)" + "double rectangle_right(const rectangle &rect)" + ], + "python": [ + "def rectangle_right(rect):" ], "csharp": [ - "public static Rectangle SplashKit.RectangleAround(Circle c);" + "public static double SplashKit.RectangleRight(Rectangle rect);" ], "pascal": [ - "function RectangleAround(const c: Circle): Rectangle" + "function RectangleRight(const rect: Rectangle): Double" ] } }, { - "signature": "rectangle rectangle_around(const line &l);", - "name": "rectangle_around", + "signature": "string rectangle_to_string(const rectangle &rect);", + "name": "rectangle_to_string", "method_name": null, - "unique_global_name": "rectangle_around_line", + "unique_global_name": "rectangle_to_string", "unique_method_name": null, "suffix_name": null, - "description": "Returns a rectangle that surrounds a given line segment", + "description": "Get a text representation of the passed in rectangle.", "brief": null, "return": { - "type": "rectangle", - "description": "A rectangle that will surround the line", + "type": "string", + "description": "A string representation of the rectangle.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "l": { - "type": "line", - "description": "The line", + "rect": { + "type": "rectangle", + "description": "The rectangle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -20701,46 +20519,45 @@ } }, "attributes": { - "suffix": "line", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def rectangle_around_line(l):" - ], "cpp": [ - "rectangle rectangle_around(const line &l)" + "string rectangle_to_string(const rectangle &rect)" + ], + "python": [ + "def rectangle_to_string(rect):" ], "csharp": [ - "public static Rectangle SplashKit.RectangleAround(Line l);" + "public static string SplashKit.RectangleToString(Rectangle rect);" ], "pascal": [ - "function RectangleAround(const l: Line): Rectangle" + "function RectangleToString(const rect: Rectangle): String" ] } }, { - "signature": "rectangle rectangle_around(const quad &q);", - "name": "rectangle_around", + "signature": "double rectangle_top(const rectangle &rect);", + "name": "rectangle_top", "method_name": null, - "unique_global_name": "rectangle_around_quad", + "unique_global_name": "rectangle_top", "unique_method_name": null, "suffix_name": null, - "description": "Returns a rectangle that surrounds a given quad.", + "description": "The top of the rectangle.", "brief": null, "return": { - "type": "rectangle", - "description": "A rectangle that will surround the quad", + "type": "double", + "description": "Its distance from the top of the screen.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "q": { - "type": "quad", - "description": "The quad", + "rect": { + "type": "rectangle", + "description": "The rectangle.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -20753,46 +20570,45 @@ } }, "attributes": { - "suffix": "quad", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def rectangle_around_quad(q):" - ], "cpp": [ - "rectangle rectangle_around(const quad &q)" + "double rectangle_top(const rectangle &rect)" + ], + "python": [ + "def rectangle_top(rect):" ], "csharp": [ - "public static Rectangle SplashKit.RectangleAround(Quad q);" + "public static double SplashKit.RectangleTop(Rectangle rect);" ], "pascal": [ - "function RectangleAround(const q: Quad): Rectangle" + "function RectangleTop(const rect: Rectangle): Double" ] } }, { - "signature": "rectangle rectangle_around(const triangle &t);", - "name": "rectangle_around", + "signature": "bool rectangles_intersect(const rectangle &rect1,const rectangle &rect2);", + "name": "rectangles_intersect", "method_name": null, - "unique_global_name": "rectangle_around_triangle", + "unique_global_name": "rectangles_intersect", "unique_method_name": null, "suffix_name": null, - "description": "Returns a rectangle that surrounds a given triangle", + "description": "Returns true if the two rectangles intersect.", "brief": null, "return": { - "type": "rectangle", - "description": "A rectangle that will surround the triangle", + "type": "bool", + "description": "True when rect1 and rect2 intersect.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "t": { - "type": "triangle", - "description": "The triangle", + "rect1": { + "type": "rectangle", + "description": "The first rectangle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -20802,49 +20618,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "suffix": "triangle", - "group": "geometry", - "static": "geometry" - }, - "signatures": { - "python": [ - "def rectangle_around_triangle(t):" - ], - "cpp": [ - "rectangle rectangle_around(const triangle &t)" - ], - "csharp": [ - "public static Rectangle SplashKit.RectangleAround(Triangle t);" - ], - "pascal": [ - "function RectangleAround(const t: Triangle): Rectangle" - ] - } - }, - { - "signature": "double rectangle_bottom(const rectangle &rect);", - "name": "rectangle_bottom", - "method_name": null, - "unique_global_name": "rectangle_bottom", - "unique_method_name": null, - "suffix_name": null, - "description": "The location of the bottom of the rectangle.", - "brief": null, - "return": { - "type": "double", - "description": "The distance from the top of the screen to the bottom of\nthe rectangle.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "rect": { + }, + "rect2": { "type": "rectangle", - "description": "The rectangle.", + "description": "The second rectangle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -20861,41 +20638,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def rectangle_bottom(rect):" - ], "cpp": [ - "double rectangle_bottom(const rectangle &rect)" + "bool rectangles_intersect(const rectangle &rect1, const rectangle &rect2)" + ], + "python": [ + "def rectangles_intersect(rect1, rect2):" ], "csharp": [ - "public static double SplashKit.RectangleBottom(Rectangle rect);" + "public static bool SplashKit.RectanglesIntersect(Rectangle rect1, Rectangle rect2);" ], "pascal": [ - "function RectangleBottom(const rect: Rectangle): Double" + "function RectanglesIntersect(const rect1: Rectangle; const rect2: Rectangle): Boolean" ] } }, { - "signature": "point_2d rectangle_center(const rectangle &rect);", - "name": "rectangle_center", + "signature": "point_2d triangle_barycenter(const triangle &tri);", + "name": "triangle_barycenter", "method_name": null, - "unique_global_name": "rectangle_center", + "unique_global_name": "triangle_barycenter", "unique_method_name": null, "suffix_name": null, - "description": "Returns the center point of a given rectangle", + "description": "Return the barycenter of the triangle. This is one way of calculating the\ncenter point of a triangle.", "brief": null, "return": { "type": "point_2d", - "description": "The center point of the vector", + "description": "The point that is the barycenter of `tri`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "rect": { - "type": "rectangle", - "description": "The rectangle", + "tri": { + "type": "triangle", + "description": "The triangle to get the center of", "is_pointer": false, "is_const": true, "is_reference": true, @@ -20912,41 +20689,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def rectangle_center(rect):" - ], "cpp": [ - "point_2d rectangle_center(const rectangle &rect)" + "point_2d triangle_barycenter(const triangle &tri)" + ], + "python": [ + "def triangle_barycenter(tri):" ], "csharp": [ - "public static Point2D SplashKit.RectangleCenter(Rectangle rect);" + "public static Point2D SplashKit.TriangleBarycenter(Triangle tri);" ], "pascal": [ - "function RectangleCenter(const rect: Rectangle): Point2D" + "function TriangleBarycenter(const tri: Triangle): Point2D" ] } }, { - "signature": "bool rectangle_circle_intersect(const rectangle &rect,const circle &c);", - "name": "rectangle_circle_intersect", + "signature": "triangle triangle_from(const point_2d &p1,const point_2d &p2,const point_2d &p3);", + "name": "triangle_from", "method_name": null, - "unique_global_name": "rectangle_circle_intersect", + "unique_global_name": "triangle_from", "unique_method_name": null, "suffix_name": null, - "description": "Detects if a rectangle intersects with a circle.", + "description": "Generate a triangle from a set of points.", "brief": null, "return": { - "type": "bool", - "description": "True if the rectangle and circle intersect, false otherwise", + "type": "triangle", + "description": "A triangle with the indicated points", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "rect": { - "type": "rectangle", - "description": "The rectangle to test", + "p1": { + "type": "point_2d", + "description": "The first point of the triangle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -20957,9 +20734,22 @@ "is_vector": false, "type_parameter": null }, - "c": { - "type": "circle", - "description": "The circle to test", + "p2": { + "type": "point_2d", + "description": "The second point of the triangle", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "p3": { + "type": "point_2d", + "description": "The third point of the triangle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -20976,43 +20766,43 @@ "static": "geometry" }, "signatures": { - "python": [ - "def rectangle_circle_intersect(rect, c):" - ], "cpp": [ - "bool rectangle_circle_intersect(const rectangle &rect, const circle &c)" + "triangle triangle_from(const point_2d &p1, const point_2d &p2, const point_2d &p3)" + ], + "python": [ + "def triangle_from(p1, p2, p3):" ], "csharp": [ - "public static bool SplashKit.RectangleCircleIntersect(Rectangle rect, Circle c);" + "public static Triangle SplashKit.TriangleFrom(Point2D p1, Point2D p2, Point2D p3);" ], "pascal": [ - "function RectangleCircleIntersect(const rect: Rectangle; const c: Circle): Boolean" + "function TriangleFrom(const p1: Point2D; const p2: Point2D; const p3: Point2D): Triangle" ] } }, { - "signature": "rectangle rectangle_from(const point_2d pt,const double width,const double height);", - "name": "rectangle_from", + "signature": "triangle triangle_from(double x1,double y1,double x2,double y2,double x3,double y3);", + "name": "triangle_from", "method_name": null, - "unique_global_name": "rectangle_from_point_and_size", + "unique_global_name": "triangle_from_coordinates", "unique_method_name": null, "suffix_name": null, - "description": "Returns a rectangle at the specified point with a given width and height", + "description": "Generate a triangle from a set of points.", "brief": null, "return": { - "type": "rectangle", - "description": "A rectangle with the specified dimensions and location", + "type": "triangle", + "description": "A triangle at the indicated points", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { - "type": "point_2d", - "description": "The origin for the rectangle", + "x1": { + "type": "double", + "description": "The x coordinate for the first point", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -21021,11 +20811,11 @@ "is_vector": false, "type_parameter": null }, - "width": { + "y1": { "type": "double", - "description": "Its width", + "description": "The y coordinate for the first point", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -21034,11 +20824,50 @@ "is_vector": false, "type_parameter": null }, - "height": { + "x2": { "type": "double", - "description": "Its height", + "description": "The x coordinate for the second point", "is_pointer": false, - "is_const": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y2": { + "type": "double", + "description": "The y coordinate for the second point", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x3": { + "type": "double", + "description": "The x coordinate for the third point", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y3": { + "type": "double", + "description": "The y coordinate for the third point", + "is_pointer": false, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -21049,252 +20878,46 @@ } }, "attributes": { - "suffix": "point_and_size", + "suffix": "coordinates", "group": "geometry", "static": "geometry" }, "signatures": { - "python": [ - "def rectangle_from_point_and_size(pt, width, height):" - ], "cpp": [ - "rectangle rectangle_from(const point_2d pt, const double width, const double height)" - ], - "csharp": [ - "public static Rectangle SplashKit.RectangleFrom(Point2D pt, double width, double height);" - ], - "pascal": [ - "function RectangleFrom(pt: Point2D; width: Double; height: Double): Rectangle" - ] - } - }, - { - "signature": "rectangle rectangle_from(const point_2d pt1,const point_2d pt2);", - "name": "rectangle_from", - "method_name": null, - "unique_global_name": "rectangle_from_points", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns a rectangle with pt1 and pt2 defining the two distant edge points.", - "brief": null, - "return": { - "type": "rectangle", - "description": "A rectangle enclosing the two points.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "pt1": { - "type": "point_2d", - "description": "The first point", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "pt2": { - "type": "point_2d", - "description": "The second point", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "points", - "group": "geometry", - "static": "geometry" - }, - "signatures": { - "python": [ - "def rectangle_from_points(pt1, pt2):" - ], - "cpp": [ - "rectangle rectangle_from(const point_2d pt1, const point_2d pt2)" - ], - "csharp": [ - "public static Rectangle SplashKit.RectangleFrom(Point2D pt1, Point2D pt2);" - ], - "pascal": [ - "function RectangleFrom(pt1: Point2D; pt2: Point2D): Rectangle" - ] - } - }, - { - "signature": "rectangle rectangle_from(double x,double y,double width,double height);", - "name": "rectangle_from", - "method_name": null, - "unique_global_name": "rectangle_from", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns a rectangle from a given x,y location with the specified width\nand height.", - "brief": null, - "return": { - "type": "rectangle", - "description": "A rectangle with the specified dimensions and location.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "x": { - "type": "double", - "description": "The x coordinate of the rectangle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y coordinate of the rectangle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "width": { - "type": "double", - "description": "The width of the rectangle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "height": { - "type": "double", - "description": "The height of the rectangle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "geometry", - "static": "geometry" - }, - "signatures": { - "python": [ - "def rectangle_from(x, y, width, height):" - ], - "cpp": [ - "rectangle rectangle_from(double x, double y, double width, double height)" - ], - "csharp": [ - "public static Rectangle SplashKit.RectangleFrom(double x, double y, double width, double height);" + "triangle triangle_from(double x1, double y1, double x2, double y2, double x3, double y3)" ], - "pascal": [ - "function RectangleFrom(x: Double; y: Double; width: Double; height: Double): Rectangle" - ] - } - }, - { - "signature": "double rectangle_left(const rectangle &rect);", - "name": "rectangle_left", - "method_name": null, - "unique_global_name": "rectangle_left", - "unique_method_name": null, - "suffix_name": null, - "description": "The location of the left edge of the rectangle.", - "brief": null, - "return": { - "type": "double", - "description": "The distance from the left of the screen to the left side of\nthe rectangle.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "rect": { - "type": "rectangle", - "description": "The rectangle.", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "geometry", - "static": "geometry" - }, - "signatures": { "python": [ - "def rectangle_left(rect):" - ], - "cpp": [ - "double rectangle_left(const rectangle &rect)" + "def triangle_from_coordinates(x1, y1, x2, y2, x3, y3):" ], "csharp": [ - "public static double SplashKit.RectangleLeft(Rectangle rect);" + "public static Triangle SplashKit.TriangleFrom(double x1, double y1, double x2, double y2, double x3, double y3);" ], "pascal": [ - "function RectangleLeft(const rect: Rectangle): Double" + "function TriangleFrom(x1: Double; y1: Double; x2: Double; y2: Double; x3: Double; y3: Double): Triangle" ] } }, { - "signature": "rectangle rectangle_offset_by(const rectangle &rect,const vector_2d &offset);", - "name": "rectangle_offset_by", + "signature": "bool triangle_quad_intersect(const triangle &tri,const quad &q);", + "name": "triangle_quad_intersect", "method_name": null, - "unique_global_name": "rectangle_offset_by", + "unique_global_name": "triangle_quad_intersect", "unique_method_name": null, "suffix_name": null, - "description": "Returns a rectangle that is moved by the provided vector.", + "description": "Returns true if the triangle intersects with the quad.", "brief": null, "return": { - "type": "rectangle", - "description": "A new rectangle that represents the original rectangle\nafter being moved by the offset vector.", + "type": "bool", + "description": "True if the triangle and quad intersect", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "rect": { - "type": "rectangle", - "description": "The original rectangle", + "tri": { + "type": "triangle", + "description": "The triangle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -21305,9 +20928,9 @@ "is_vector": false, "type_parameter": null }, - "offset": { - "type": "vector_2d", - "description": "The amount and direction for the rectangle to move", + "q": { + "type": "quad", + "description": "The quad to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -21324,32 +20947,32 @@ "static": "geometry" }, "signatures": { - "python": [ - "def rectangle_offset_by(rect, offset):" - ], "cpp": [ - "rectangle rectangle_offset_by(const rectangle &rect, const vector_2d &offset)" + "bool triangle_quad_intersect(const triangle &tri, const quad &q)" + ], + "python": [ + "def triangle_quad_intersect(tri, q):" ], "csharp": [ - "public static Rectangle SplashKit.RectangleOffsetBy(Rectangle rect, Vector2D offset);" + "public static bool SplashKit.TriangleQuadIntersect(Triangle tri, Quad q);" ], "pascal": [ - "function RectangleOffsetBy(const rect: Rectangle; const offset: Vector2D): Rectangle" + "function TriangleQuadIntersect(const tri: Triangle; const q: Quad): Boolean" ] } }, { - "signature": "bool rectangle_ray_intersection(const point_2d &origin,const vector_2d &heading,const rectangle &rect);", - "name": "rectangle_ray_intersection", + "signature": "bool triangle_ray_intersection(const point_2d &origin,const vector_2d &heading,const triangle &tri);", + "name": "triangle_ray_intersection", "method_name": null, - "unique_global_name": "rectangle_ray_intersection", + "unique_global_name": "triangle_ray_intersection", "unique_method_name": null, "suffix_name": null, - "description": "Detects if a ray intersects a rectangle.", + "description": "Detects if a ray intersects a triangle.", "brief": null, "return": { "type": "bool", - "description": "True if the ray intersects the rectangle, false otherwise", + "description": "True if the ray intersects the triangle, false otherwise", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -21382,9 +21005,9 @@ "is_vector": false, "type_parameter": null }, - "rect": { - "type": "rectangle", - "description": "The rectangle to check for intersection", + "tri": { + "type": "triangle", + "description": "The triangle to check for intersection", "is_pointer": false, "is_const": true, "is_reference": true, @@ -21401,32 +21024,32 @@ "static": "geometry" }, "signatures": { - "python": [ - "def rectangle_ray_intersection(origin, heading, rect):" - ], "cpp": [ - "bool rectangle_ray_intersection(const point_2d &origin, const vector_2d &heading, const rectangle &rect)" + "bool triangle_ray_intersection(const point_2d &origin, const vector_2d &heading, const triangle &tri)" + ], + "python": [ + "def triangle_ray_intersection(origin, heading, tri):" ], "csharp": [ - "public static bool SplashKit.RectangleRayIntersection(Point2D origin, Vector2D heading, Rectangle rect);" + "public static bool SplashKit.TriangleRayIntersection(Point2D origin, Vector2D heading, Triangle tri);" ], "pascal": [ - "function RectangleRayIntersection(const origin: Point2D; const heading: Vector2D; const rect: Rectangle): Boolean" + "function TriangleRayIntersection(const origin: Point2D; const heading: Vector2D; const tri: Triangle): Boolean" ] } }, { - "signature": "bool rectangle_ray_intersection(const point_2d &origin,const vector_2d &heading,const rectangle &rect,point_2d &hit_point,double &hit_distance);", - "name": "rectangle_ray_intersection", + "signature": "bool triangle_ray_intersection(const point_2d &origin,const vector_2d &heading,const triangle &tri,point_2d &hit_point,double &hit_distance);", + "name": "triangle_ray_intersection", "method_name": null, - "unique_global_name": "rectangle_ray_intersection_with_hit_point_and_distance", + "unique_global_name": "triangle_ray_intersection_with_hit_point_and_distance", "unique_method_name": null, "suffix_name": null, - "description": "Detects if a ray intersects a rectangle. If an intersection is found, the\n`hit_point` and `hit_distance` are set to the point of intersection and the\ndistance from the ray's origin to the intersection point. If the ray's `origin`\nis contained within the rectangle, `hit_point` is set to the `origin` and `hit_distance`\nis set to 0. If no intersection is found, `hit_point` and `hit_distance` are not modified.", + "description": "Detects if a ray intersects a triangle. If an intersection is found, the\n`hit_point` and `hit_distance` are set to the point of intersection and the\ndistance from the ray's origin to the intersection point. If the ray's `origin`\nis contained within the triangle, `hit_point` is set to the `origin` and `hit_distance`\nis set to 0. If no intersection is found, `hit_point` and `hit_distance` are not modified.", "brief": null, "return": { "type": "bool", - "description": "True if the ray intersects the rectangle, false otherwise", + "description": "True if the ray intersects the triangle, false otherwise", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -21459,9 +21082,9 @@ "is_vector": false, "type_parameter": null }, - "rect": { - "type": "rectangle", - "description": "The rectangle to check for intersection", + "tri": { + "type": "triangle", + "description": "The triangle to check for intersection", "is_pointer": false, "is_const": true, "is_reference": true, @@ -21474,7 +21097,7 @@ }, "hit_point": { "type": "point_2d", - "description": "The point to set to where the ray intersects the rectangle", + "description": "The point to set to where the ray intersects the triangle", "is_pointer": false, "is_const": false, "is_reference": true, @@ -21505,41 +21128,54 @@ "static": "geometry" }, "signatures": { - "python": [ - "def rectangle_ray_intersection_with_hit_point_and_distance(origin, heading, rect, hit_point, hit_distance):" - ], "cpp": [ - "bool rectangle_ray_intersection(const point_2d &origin, const vector_2d &heading, const rectangle &rect, point_2d &hit_point, double &hit_distance)" + "bool triangle_ray_intersection(const point_2d &origin, const vector_2d &heading, const triangle &tri, point_2d &hit_point, double &hit_distance)" + ], + "python": [ + "def triangle_ray_intersection_with_hit_point_and_distance(origin, heading, tri, hit_point, hit_distance):" ], "csharp": [ - "public static bool SplashKit.RectangleRayIntersection(Point2D origin, Vector2D heading, Rectangle rect, ref Point2D hitPoint, ref double hitDistance);" + "public static bool SplashKit.TriangleRayIntersection(Point2D origin, Vector2D heading, Triangle tri, ref Point2D hitPoint, ref double hitDistance);" ], "pascal": [ - "function RectangleRayIntersection(const origin: Point2D; const heading: Vector2D; const rect: Rectangle; var hitPoint: Point2D; var hitDistance: Double): Boolean" + "function TriangleRayIntersection(const origin: Point2D; const heading: Vector2D; const tri: Triangle; var hitPoint: Point2D; var hitDistance: Double): Boolean" ] } }, { - "signature": "double rectangle_right(const rectangle &rect);", - "name": "rectangle_right", + "signature": "bool triangle_rectangle_intersect(const triangle &tri,const rectangle &rect);", + "name": "triangle_rectangle_intersect", "method_name": null, - "unique_global_name": "rectangle_right", + "unique_global_name": "triangle_rectangle_intersect", "unique_method_name": null, "suffix_name": null, - "description": "The location of the right edge of the rectangle.", + "description": "Returns true if the triangle intersects with the rectangle.", "brief": null, "return": { - "type": "double", - "description": "The distance from the left of the screen to the right side\nof the rectangle.", + "type": "bool", + "description": "True if the triangle and rect intersect", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "tri": { + "type": "triangle", + "description": "The triangle to test", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "rect": { "type": "rectangle", - "description": "The rectangle.", + "description": "The rectangle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -21556,41 +21192,41 @@ "static": "geometry" }, "signatures": { - "python": [ - "def rectangle_right(rect):" - ], "cpp": [ - "double rectangle_right(const rectangle &rect)" + "bool triangle_rectangle_intersect(const triangle &tri, const rectangle &rect)" + ], + "python": [ + "def triangle_rectangle_intersect(tri, rect):" ], "csharp": [ - "public static double SplashKit.RectangleRight(Rectangle rect);" + "public static bool SplashKit.TriangleRectangleIntersect(Triangle tri, Rectangle rect);" ], "pascal": [ - "function RectangleRight(const rect: Rectangle): Double" + "function TriangleRectangleIntersect(const tri: Triangle; const rect: Rectangle): Boolean" ] } }, { - "signature": "string rectangle_to_string(const rectangle &rect);", - "name": "rectangle_to_string", + "signature": "string triangle_to_string(const triangle &tri);", + "name": "triangle_to_string", "method_name": null, - "unique_global_name": "rectangle_to_string", + "unique_global_name": "triangle_to_string", "unique_method_name": null, "suffix_name": null, - "description": "Get a text representation of the passed in rectangle.", + "description": "Returns a text description of the triangle.", "brief": null, "return": { "type": "string", - "description": "A string representation of the rectangle.", + "description": "A text description of the triangle.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "rect": { - "type": "rectangle", - "description": "The rectangle", + "tri": { + "type": "triangle", + "description": "The triangle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -21607,41 +21243,54 @@ "static": "geometry" }, "signatures": { - "python": [ - "def rectangle_to_string(rect):" - ], "cpp": [ - "string rectangle_to_string(const rectangle &rect)" + "string triangle_to_string(const triangle &tri)" + ], + "python": [ + "def triangle_to_string(tri):" ], "csharp": [ - "public static string SplashKit.RectangleToString(Rectangle rect);" + "public static string SplashKit.TriangleToString(Triangle tri);" ], "pascal": [ - "function RectangleToString(const rect: Rectangle): String" + "function TriangleToString(const tri: Triangle): String" ] } }, { - "signature": "double rectangle_top(const rectangle &rect);", - "name": "rectangle_top", + "signature": "bool triangles_intersect(const triangle &t1,const triangle &t2);", + "name": "triangles_intersect", "method_name": null, - "unique_global_name": "rectangle_top", + "unique_global_name": "triangles_intersect", "unique_method_name": null, "suffix_name": null, - "description": "The top of the rectangle.", + "description": "Returns true if the two triangles intersect.", "brief": null, "return": { - "type": "double", - "description": "Its distance from the top of the screen.", + "type": "bool", + "description": "True if the two triangles intersect", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "rect": { - "type": "rectangle", - "description": "The rectangle.", + "t1": { + "type": "triangle", + "description": "The first triangle", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "t2": { + "type": "triangle", + "description": "The other triangle", "is_pointer": false, "is_const": true, "is_reference": true, @@ -21658,44 +21307,62 @@ "static": "geometry" }, "signatures": { - "python": [ - "def rectangle_top(rect):" - ], "cpp": [ - "double rectangle_top(const rectangle &rect)" + "bool triangles_intersect(const triangle &t1, const triangle &t2)" + ], + "python": [ + "def triangles_intersect(t1, t2):" ], "csharp": [ - "public static double SplashKit.RectangleTop(Rectangle rect);" + "public static bool SplashKit.TrianglesIntersect(Triangle t1, Triangle t2);" ], "pascal": [ - "function RectangleTop(const rect: Rectangle): Double" + "function TrianglesIntersect(const t1: Triangle; const t2: Triangle): Boolean" ] } - }, + } + ], + "typedefs": [ + + ], + "structs": [ + + ], + "enums": [ + + ], + "defines": [ + + ] + }, + "graphics": { + "brief": "SplashKit Images allow drawing of bitmaps and sprites to graphic windows.SplashKit Text allows for drawing text in a variety of ways to\ngraphic windows.", + "description": "", + "functions": [ { - "signature": "bool rectangles_intersect(const rectangle &rect1,const rectangle &rect2);", - "name": "rectangles_intersect", - "method_name": null, - "unique_global_name": "rectangles_intersect", - "unique_method_name": null, + "signature": "void draw_circle(color clr,const circle &c);", + "name": "draw_circle", + "method_name": "draw", + "unique_global_name": "draw_circle_record", + "unique_method_name": "circle.draw_record", "suffix_name": null, - "description": "Returns true if the two rectangles intersect.", + "description": "Draw a circle on the current window. The circle is centred on its x, y\ncoordinates, and has the provided radius.", "brief": null, "return": { - "type": "bool", - "description": "True when rect1 and rect2 intersect.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "rect1": { - "type": "rectangle", - "description": "The first rectangle", + "clr": { + "type": "color", + "description": "The color of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -21703,9 +21370,9 @@ "is_vector": false, "type_parameter": null }, - "rect2": { - "type": "rectangle", - "description": "The second rectangle", + "c": { + "type": "circle", + "description": "The circle being drawn", "is_pointer": false, "is_const": true, "is_reference": true, @@ -21718,49 +21385,79 @@ } }, "attributes": { - "group": "geometry", - "static": "geometry" + "class": "circle", + "method": "draw", + "self": "c", + "suffix": "record", + "group": "graphics" }, "signatures": { - "python": [ - "def rectangles_intersect(rect1, rect2):" - ], "cpp": [ - "bool rectangles_intersect(const rectangle &rect1, const rectangle &rect2)" + "void draw_circle(color clr, const circle &c)" + ], + "python": [ + "def draw_circle_record(clr, c):" ], "csharp": [ - "public static bool SplashKit.RectanglesIntersect(Rectangle rect1, Rectangle rect2);" + "public void Circle.Draw(Color clr);", + "public static void SplashKit.DrawCircle(Color clr, Circle c);" ], "pascal": [ - "function RectanglesIntersect(const rect1: Rectangle; const rect2: Rectangle): Boolean" + "procedure DrawCircle(clr: Color; const c: Circle)" ] } }, { - "signature": "point_2d triangle_barycenter(const triangle &tri);", - "name": "triangle_barycenter", - "method_name": null, - "unique_global_name": "triangle_barycenter", - "unique_method_name": null, + "signature": "void draw_circle(color clr,const circle &c,drawing_options opts);", + "name": "draw_circle", + "method_name": "draw", + "unique_global_name": "draw_circle_record_with_options", + "unique_method_name": "circle.draw_record_with_options", "suffix_name": null, - "description": "Return the barycenter of the triangle. This is one way of calculating the\ncenter point of a triangle.", + "description": "Draw a circle with the provided drawing options, which may include options related to\nthe drawing destination.", "brief": null, "return": { - "type": "point_2d", - "description": "The point that is the barycenter of `tri`", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "tri": { - "type": "triangle", - "description": "The triangle to get the center of", + "clr": { + "type": "color", + "description": "The color of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "c": { + "type": "circle", + "description": "The circle being drawn", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "opts": { + "type": "drawing_options", + "description": "Drawing options to configure the drawing operation", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, "array_dimension_sizes": [ ], @@ -21769,48 +21466,52 @@ } }, "attributes": { - "group": "geometry", - "static": "geometry" + "class": "circle", + "method": "draw", + "self": "c", + "suffix": "record_with_options", + "group": "graphics" }, "signatures": { - "python": [ - "def triangle_barycenter(tri):" - ], "cpp": [ - "point_2d triangle_barycenter(const triangle &tri)" + "void draw_circle(color clr, const circle &c, drawing_options opts)" + ], + "python": [ + "def draw_circle_record_with_options(clr, c, opts):" ], "csharp": [ - "public static Point2D SplashKit.TriangleBarycenter(Triangle tri);" + "public void Circle.Draw(Color clr, DrawingOptions opts);", + "public static void SplashKit.DrawCircle(Color clr, Circle c, DrawingOptions opts);" ], "pascal": [ - "function TriangleBarycenter(const tri: Triangle): Point2D" + "procedure DrawCircle(clr: Color; const c: Circle; opts: DrawingOptions)" ] } }, { - "signature": "triangle triangle_from(const point_2d &p1,const point_2d &p2,const point_2d &p3);", - "name": "triangle_from", + "signature": "void draw_circle(color clr,double x,double y,double radius);", + "name": "draw_circle", "method_name": null, - "unique_global_name": "triangle_from", + "unique_global_name": "draw_circle", "unique_method_name": null, "suffix_name": null, - "description": "Generate a triangle from a set of points.", + "description": "Draw a circle onto the current window. The circle is centred on its x, y\ncoordinates, and has the provided radius.", "brief": null, "return": { - "type": "triangle", - "description": "A triangle with the indicated points", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "p1": { - "type": "point_2d", - "description": "The first point of the triangle", + "clr": { + "type": "color", + "description": "The color of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -21818,12 +21519,12 @@ "is_vector": false, "type_parameter": null }, - "p2": { - "type": "point_2d", - "description": "The second point of the triangle", + "x": { + "type": "double", + "description": "The x location of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -21831,12 +21532,25 @@ "is_vector": false, "type_parameter": null }, - "p3": { - "type": "point_2d", - "description": "The third point of the triangle", + "y": { + "type": "double", + "description": "The y location of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "radius": { + "type": "double", + "description": "The radius of the circle", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -21846,58 +21560,44 @@ } }, "attributes": { - "group": "geometry", - "static": "geometry" + "group": "graphics" }, "signatures": { - "python": [ - "def triangle_from(p1, p2, p3):" - ], "cpp": [ - "triangle triangle_from(const point_2d &p1, const point_2d &p2, const point_2d &p3)" + "void draw_circle(color clr, double x, double y, double radius)" + ], + "python": [ + "def draw_circle(clr, x, y, radius):" ], "csharp": [ - "public static Triangle SplashKit.TriangleFrom(Point2D p1, Point2D p2, Point2D p3);" + "public static void SplashKit.DrawCircle(Color clr, double x, double y, double radius);" ], "pascal": [ - "function TriangleFrom(const p1: Point2D; const p2: Point2D; const p3: Point2D): Triangle" + "procedure DrawCircle(clr: Color; x: Double; y: Double; radius: Double)" ] } }, { - "signature": "triangle triangle_from(double x1,double y1,double x2,double y2,double x3,double y3);", - "name": "triangle_from", + "signature": "void draw_circle(color clr,double x,double y,double radius,drawing_options opts);", + "name": "draw_circle", "method_name": null, - "unique_global_name": "triangle_from_coordinates", + "unique_global_name": "draw_circle_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Generate a triangle from a set of points.", + "description": "Draw a circle using the supplied drawing options. The circle is centred on its x, y\ncoordinates, and has the provided radius. This will use `drawing_options` to determine\nthe destination.", "brief": null, "return": { - "type": "triangle", - "description": "A triangle at the indicated points", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "x1": { - "type": "double", - "description": "The x coordinate for the first point", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y1": { - "type": "double", - "description": "The y coordinate for the first point", + "clr": { + "type": "color", + "description": "The color of the circle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -21908,9 +21608,9 @@ "is_vector": false, "type_parameter": null }, - "x2": { + "x": { "type": "double", - "description": "The x coordinate for the second point", + "description": "The x location of the circle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -21921,9 +21621,9 @@ "is_vector": false, "type_parameter": null }, - "y2": { + "y": { "type": "double", - "description": "The y coordinate for the second point", + "description": "The y location of the circle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -21934,9 +21634,9 @@ "is_vector": false, "type_parameter": null }, - "x3": { + "radius": { "type": "double", - "description": "The x coordinate for the third point", + "description": "The radius of the circle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -21947,9 +21647,9 @@ "is_vector": false, "type_parameter": null }, - "y3": { - "type": "double", - "description": "The y coordinate for the third point", + "opts": { + "type": "drawing_options", + "description": "Drawing options to configure the drawing operation", "is_pointer": false, "is_const": false, "is_reference": false, @@ -21962,49 +21662,48 @@ } }, "attributes": { - "suffix": "coordinates", - "group": "geometry", - "static": "geometry" + "suffix": "with_options", + "group": "graphics" }, "signatures": { - "python": [ - "def triangle_from_coordinates(x1, y1, x2, y2, x3, y3):" - ], "cpp": [ - "triangle triangle_from(double x1, double y1, double x2, double y2, double x3, double y3)" + "void draw_circle(color clr, double x, double y, double radius, drawing_options opts)" + ], + "python": [ + "def draw_circle_with_options(clr, x, y, radius, opts):" ], "csharp": [ - "public static Triangle SplashKit.TriangleFrom(double x1, double y1, double x2, double y2, double x3, double y3);" + "public static void SplashKit.DrawCircle(Color clr, double x, double y, double radius, DrawingOptions opts);" ], "pascal": [ - "function TriangleFrom(x1: Double; y1: Double; x2: Double; y2: Double; x3: Double; y3: Double): Triangle" + "procedure DrawCircle(clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)" ] } }, { - "signature": "bool triangle_quad_intersect(const triangle &tri,const quad &q);", - "name": "triangle_quad_intersect", - "method_name": null, - "unique_global_name": "triangle_quad_intersect", - "unique_method_name": null, + "signature": "void draw_circle_on_bitmap(bitmap destination,color clr,double x,double y,double radius);", + "name": "draw_circle_on_bitmap", + "method_name": "draw_circle", + "unique_global_name": "draw_circle_on_bitmap", + "unique_method_name": "bitmap.draw_circle", "suffix_name": null, - "description": "Returns true if the triangle intersects with the quad.", + "description": "Draw a circle onto the destination bitmap. The circle is centred on its x, y\ncoordinates, and has the provided radius.", "brief": null, "return": { - "type": "bool", - "description": "True if the triangle and quad intersect", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "tri": { - "type": "triangle", - "description": "The triangle to test", + "destination": { + "type": "bitmap", + "description": "The destination bitmap", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22012,12 +21711,51 @@ "is_vector": false, "type_parameter": null }, - "q": { - "type": "quad", - "description": "The quad to test", + "clr": { + "type": "color", + "description": "The color of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x": { + "type": "double", + "description": "The x location of the circle", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y location of the circle", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "radius": { + "type": "double", + "description": "The radius of the circle", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22027,48 +21765,51 @@ } }, "attributes": { - "group": "geometry", - "static": "geometry" + "class": "bitmap", + "method": "draw_circle", + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def triangle_quad_intersect(tri, q):" - ], "cpp": [ - "bool triangle_quad_intersect(const triangle &tri, const quad &q)" + "void draw_circle_on_bitmap(bitmap destination, color clr, double x, double y, double radius)" + ], + "python": [ + "def draw_circle_on_bitmap(destination, clr, x, y, radius):" ], "csharp": [ - "public static bool SplashKit.TriangleQuadIntersect(Triangle tri, Quad q);" + "public void Bitmap.DrawCircle(Color clr, double x, double y, double radius);", + "public static void SplashKit.DrawCircleOnBitmap(Bitmap destination, Color clr, double x, double y, double radius);" ], "pascal": [ - "function TriangleQuadIntersect(const tri: Triangle; const q: Quad): Boolean" + "procedure DrawCircleOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; radius: Double)" ] } }, { - "signature": "bool triangle_ray_intersection(const point_2d &origin,const vector_2d &heading,const triangle &tri);", - "name": "triangle_ray_intersection", - "method_name": null, - "unique_global_name": "triangle_ray_intersection", - "unique_method_name": null, + "signature": "void draw_circle_on_bitmap(bitmap destination,color clr,double x,double y,double radius,drawing_options opts);", + "name": "draw_circle_on_bitmap", + "method_name": "draw_circle", + "unique_global_name": "draw_circle_on_bitmap_with_options", + "unique_method_name": "bitmap.draw_circle_with_options", "suffix_name": null, - "description": "Detects if a ray intersects a triangle.", + "description": "Draw a circle to the bitmap using the supplied drawing options. The circle is centred on its x, y\ncoordinates, and has the provided radius.", "brief": null, "return": { - "type": "bool", - "description": "True if the ray intersects the triangle, false otherwise", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "origin": { - "type": "point_2d", - "description": "The starting point of the ray", + "destination": { + "type": "bitmap", + "description": "The destination bitmap", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22076,12 +21817,12 @@ "is_vector": false, "type_parameter": null }, - "heading": { - "type": "vector_2d", - "description": "The direction of the ray as a vector", + "clr": { + "type": "color", + "description": "The color of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22089,12 +21830,51 @@ "is_vector": false, "type_parameter": null }, - "tri": { - "type": "triangle", - "description": "The triangle to check for intersection", + "x": { + "type": "double", + "description": "The x location of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y location of the circle", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "radius": { + "type": "double", + "description": "The radius of the circle", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "opts": { + "type": "drawing_options", + "description": "Drawing options to configure the drawing operation", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22104,48 +21884,52 @@ } }, "attributes": { - "group": "geometry", - "static": "geometry" + "class": "bitmap", + "method": "draw_circle", + "suffix": "with_options", + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def triangle_ray_intersection(origin, heading, tri):" - ], "cpp": [ - "bool triangle_ray_intersection(const point_2d &origin, const vector_2d &heading, const triangle &tri)" + "void draw_circle_on_bitmap(bitmap destination, color clr, double x, double y, double radius, drawing_options opts)" + ], + "python": [ + "def draw_circle_on_bitmap_with_options(destination, clr, x, y, radius, opts):" ], "csharp": [ - "public static bool SplashKit.TriangleRayIntersection(Point2D origin, Vector2D heading, Triangle tri);" + "public void Bitmap.DrawCircle(Color clr, double x, double y, double radius, DrawingOptions opts);", + "public static void SplashKit.DrawCircleOnBitmap(Bitmap destination, Color clr, double x, double y, double radius, DrawingOptions opts);" ], "pascal": [ - "function TriangleRayIntersection(const origin: Point2D; const heading: Vector2D; const tri: Triangle): Boolean" + "procedure DrawCircleOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)" ] } }, { - "signature": "bool triangle_ray_intersection(const point_2d &origin,const vector_2d &heading,const triangle &tri,point_2d &hit_point,double &hit_distance);", - "name": "triangle_ray_intersection", - "method_name": null, - "unique_global_name": "triangle_ray_intersection_with_hit_point_and_distance", - "unique_method_name": null, + "signature": "void draw_circle_on_window(window destination,color clr,double x,double y,double radius);", + "name": "draw_circle_on_window", + "method_name": "draw_circle", + "unique_global_name": "draw_circle_on_window", + "unique_method_name": "window.draw_circle", "suffix_name": null, - "description": "Detects if a ray intersects a triangle. If an intersection is found, the\n`hit_point` and `hit_distance` are set to the point of intersection and the\ndistance from the ray's origin to the intersection point. If the ray's `origin`\nis contained within the triangle, `hit_point` is set to the `origin` and `hit_distance`\nis set to 0. If no intersection is found, `hit_point` and `hit_distance` are not modified.", + "description": "Draw a circle onto the destination window. The circle is centred on its x, y\ncoordinates, and has the provided radius.", "brief": null, "return": { - "type": "bool", - "description": "True if the ray intersects the triangle, false otherwise", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "origin": { - "type": "point_2d", - "description": "The starting point of the ray", + "destination": { + "type": "window", + "description": "The destination window", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22153,12 +21937,12 @@ "is_vector": false, "type_parameter": null }, - "heading": { - "type": "vector_2d", - "description": "The direction of the ray as a vector", + "clr": { + "type": "color", + "description": "The color of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22166,12 +21950,12 @@ "is_vector": false, "type_parameter": null }, - "tri": { - "type": "triangle", - "description": "The triangle to check for intersection", + "x": { + "type": "double", + "description": "The x location of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22179,12 +21963,12 @@ "is_vector": false, "type_parameter": null }, - "hit_point": { - "type": "point_2d", - "description": "The point to set to where the ray intersects the triangle", + "y": { + "type": "double", + "description": "The y location of the circle", "is_pointer": false, "is_const": false, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22192,12 +21976,12 @@ "is_vector": false, "type_parameter": null }, - "hit_distance": { + "radius": { "type": "double", - "description": "The double to set to the distance from the ray's origin to\nthe intersection point", + "description": "The radius of the circle", "is_pointer": false, "is_const": false, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22207,49 +21991,51 @@ } }, "attributes": { - "suffix": "with_hit_point_and_distance", - "group": "geometry", - "static": "geometry" + "class": "window", + "method": "draw_circle", + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def triangle_ray_intersection_with_hit_point_and_distance(origin, heading, tri, hit_point, hit_distance):" - ], "cpp": [ - "bool triangle_ray_intersection(const point_2d &origin, const vector_2d &heading, const triangle &tri, point_2d &hit_point, double &hit_distance)" + "void draw_circle_on_window(window destination, color clr, double x, double y, double radius)" + ], + "python": [ + "def draw_circle_on_window(destination, clr, x, y, radius):" ], "csharp": [ - "public static bool SplashKit.TriangleRayIntersection(Point2D origin, Vector2D heading, Triangle tri, ref Point2D hitPoint, ref double hitDistance);" + "public void Window.DrawCircle(Color clr, double x, double y, double radius);", + "public static void SplashKit.DrawCircleOnWindow(Window destination, Color clr, double x, double y, double radius);" ], "pascal": [ - "function TriangleRayIntersection(const origin: Point2D; const heading: Vector2D; const tri: Triangle; var hitPoint: Point2D; var hitDistance: Double): Boolean" + "procedure DrawCircleOnWindow(destination: Window; clr: Color; x: Double; y: Double; radius: Double)" ] } }, { - "signature": "bool triangle_rectangle_intersect(const triangle &tri,const rectangle &rect);", - "name": "triangle_rectangle_intersect", - "method_name": null, - "unique_global_name": "triangle_rectangle_intersect", - "unique_method_name": null, + "signature": "void draw_circle_on_window(window destination,color clr,double x,double y,double radius,drawing_options opts);", + "name": "draw_circle_on_window", + "method_name": "draw_circle", + "unique_global_name": "draw_circle_on_window_with_options", + "unique_method_name": "window.draw_circle_with_options", "suffix_name": null, - "description": "Returns true if the triangle intersects with the rectangle.", + "description": "Draw a circle to the window using the supplied drawing options. The circle is centred on its x, y\ncoordinates, and has the provided radius.", "brief": null, "return": { - "type": "bool", - "description": "True if the triangle and rect intersect", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "tri": { - "type": "triangle", - "description": "The triangle to test", + "destination": { + "type": "window", + "description": "The destination window", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22257,114 +22043,38 @@ "is_vector": false, "type_parameter": null }, - "rect": { - "type": "rectangle", - "description": "The rectangle to test", + "clr": { + "type": "color", + "description": "The color of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "group": "geometry", - "static": "geometry" - }, - "signatures": { - "python": [ - "def triangle_rectangle_intersect(tri, rect):" - ], - "cpp": [ - "bool triangle_rectangle_intersect(const triangle &tri, const rectangle &rect)" - ], - "csharp": [ - "public static bool SplashKit.TriangleRectangleIntersect(Triangle tri, Rectangle rect);" - ], - "pascal": [ - "function TriangleRectangleIntersect(const tri: Triangle; const rect: Rectangle): Boolean" - ] - } - }, - { - "signature": "string triangle_to_string(const triangle &tri);", - "name": "triangle_to_string", - "method_name": null, - "unique_global_name": "triangle_to_string", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns a text description of the triangle.", - "brief": null, - "return": { - "type": "string", - "description": "A text description of the triangle.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "tri": { - "type": "triangle", - "description": "The triangle", + }, + "x": { + "type": "double", + "description": "The x location of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "group": "geometry", - "static": "geometry" - }, - "signatures": { - "python": [ - "def triangle_to_string(tri):" - ], - "cpp": [ - "string triangle_to_string(const triangle &tri)" - ], - "csharp": [ - "public static string SplashKit.TriangleToString(Triangle tri);" - ], - "pascal": [ - "function TriangleToString(const tri: Triangle): String" - ] - } - }, - { - "signature": "bool triangles_intersect(const triangle &t1,const triangle &t2);", - "name": "triangles_intersect", - "method_name": null, - "unique_global_name": "triangles_intersect", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns true if the two triangles intersect.", - "brief": null, - "return": { - "type": "bool", - "description": "True if the two triangles intersect", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "t1": { - "type": "triangle", - "description": "The first triangle", + }, + "y": { + "type": "double", + "description": "The y location of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22372,12 +22082,25 @@ "is_vector": false, "type_parameter": null }, - "t2": { - "type": "triangle", - "description": "The other triangle", + "radius": { + "type": "double", + "description": "The radius of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "opts": { + "type": "drawing_options", + "description": "Drawing options to configure the drawing operation", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22387,48 +22110,34 @@ } }, "attributes": { - "group": "geometry", - "static": "geometry" + "class": "window", + "method": "draw_circle", + "suffix": "with_options", + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def triangles_intersect(t1, t2):" - ], "cpp": [ - "bool triangles_intersect(const triangle &t1, const triangle &t2)" + "void draw_circle_on_window(window destination, color clr, double x, double y, double radius, drawing_options opts)" + ], + "python": [ + "def draw_circle_on_window_with_options(destination, clr, x, y, radius, opts):" ], "csharp": [ - "public static bool SplashKit.TrianglesIntersect(Triangle t1, Triangle t2);" + "public void Window.DrawCircle(Color clr, double x, double y, double radius, DrawingOptions opts);", + "public static void SplashKit.DrawCircleOnWindow(Window destination, Color clr, double x, double y, double radius, DrawingOptions opts);" ], "pascal": [ - "function TrianglesIntersect(const t1: Triangle; const t2: Triangle): Boolean" + "procedure DrawCircleOnWindow(destination: Window; clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)" ] } - } - ], - "typedefs": [ - - ], - "structs": [ - - ], - "enums": [ - - ], - "defines": [ - - ] - }, - "graphics": { - "brief": "SplashKit Images allow drawing of bitmaps and sprites to graphic windows.SplashKit Text allows for drawing text in a variety of ways to\ngraphic windows.", - "description": "", - "functions": [ + }, { - "signature": "void draw_circle(color clr,const circle &c);", - "name": "draw_circle", - "method_name": "draw", - "unique_global_name": "draw_circle_record", - "unique_method_name": "circle.draw_record", + "signature": "void fill_circle(color clr,const circle &c);", + "name": "fill_circle", + "method_name": "fill", + "unique_global_name": "fill_circle_record", + "unique_method_name": "circle.fill_record", "suffix_name": null, "description": "Draw a circle on the current window. The circle is centred on its x, y\ncoordinates, and has the provided radius.", "brief": null, @@ -22470,35 +22179,35 @@ }, "attributes": { "class": "circle", - "method": "draw", + "method": "fill", "self": "c", "suffix": "record", "group": "graphics" }, "signatures": { - "python": [ - "def draw_circle_record(clr, c):" - ], "cpp": [ - "void draw_circle(color clr, const circle &c)" + "void fill_circle(color clr, const circle &c)" + ], + "python": [ + "def fill_circle_record(clr, c):" ], "csharp": [ - "public void Circle.Draw(Color clr);", - "public static void SplashKit.DrawCircle(Color clr, Circle c);" + "public void Circle.Fill(Color clr);", + "public static void SplashKit.FillCircle(Color clr, Circle c);" ], "pascal": [ - "procedure DrawCircle(clr: Color; const c: Circle)" + "procedure FillCircle(clr: Color; const c: Circle)" ] } }, { - "signature": "void draw_circle(color clr,const circle &c,drawing_options opts);", - "name": "draw_circle", - "method_name": "draw", - "unique_global_name": "draw_circle_record_with_options", - "unique_method_name": "circle.draw_record_with_options", + "signature": "void fill_circle(color clr,const circle &c,drawing_options opts);", + "name": "fill_circle", + "method_name": "fill", + "unique_global_name": "fill_circle_record_with_options", + "unique_method_name": "circle.fill_record_with_options", "suffix_name": null, - "description": "Draw a circle with the provided drawing options, which may include options related to\nthe drawing destination.", + "description": "Fill a circle with the provided drawing options, which may include options related to\nthe drawing destination.", "brief": null, "return": { "type": "void", @@ -22551,35 +22260,35 @@ }, "attributes": { "class": "circle", - "method": "draw", + "method": "fill", "self": "c", "suffix": "record_with_options", "group": "graphics" }, "signatures": { - "python": [ - "def draw_circle_record_with_options(clr, c, opts):" - ], "cpp": [ - "void draw_circle(color clr, const circle &c, drawing_options opts)" + "void fill_circle(color clr, const circle &c, drawing_options opts)" + ], + "python": [ + "def fill_circle_record_with_options(clr, c, opts):" ], "csharp": [ - "public void Circle.Draw(Color clr, DrawingOptions opts);", - "public static void SplashKit.DrawCircle(Color clr, Circle c, DrawingOptions opts);" + "public void Circle.Fill(Color clr, DrawingOptions opts);", + "public static void SplashKit.FillCircle(Color clr, Circle c, DrawingOptions opts);" ], "pascal": [ - "procedure DrawCircle(clr: Color; const c: Circle; opts: DrawingOptions)" + "procedure FillCircle(clr: Color; const c: Circle; opts: DrawingOptions)" ] } }, { - "signature": "void draw_circle(color clr,const point_2d &pt,double radius);", - "name": "draw_circle", + "signature": "void fill_circle(color clr,double x,double y,double radius);", + "name": "fill_circle", "method_name": null, - "unique_global_name": "draw_circle_at_point", + "unique_global_name": "fill_circle", "unique_method_name": null, "suffix_name": null, - "description": "Draw a circle at a point, with a specified radius, onto the current window.", + "description": "Fill a circle onto the current window. The circle is centred on its x, y\ncoordinates, and has the provided radius.", "brief": null, "return": { "type": "void", @@ -22603,12 +22312,25 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The location of the center of the circle", + "x": { + "type": "double", + "description": "The x location of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y location of the circle", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22631,32 +22353,31 @@ } }, "attributes": { - "suffix": "at_point", "group": "graphics" }, "signatures": { - "python": [ - "def draw_circle_at_point(clr, pt, radius):" - ], "cpp": [ - "void draw_circle(color clr, const point_2d &pt, double radius)" + "void fill_circle(color clr, double x, double y, double radius)" + ], + "python": [ + "def fill_circle(clr, x, y, radius):" ], "csharp": [ - "public static void SplashKit.DrawCircle(Color clr, Point2D pt, double radius);" + "public static void SplashKit.FillCircle(Color clr, double x, double y, double radius);" ], "pascal": [ - "procedure DrawCircle(clr: Color; const pt: Point2D; radius: Double)" + "procedure FillCircle(clr: Color; x: Double; y: Double; radius: Double)" ] } }, { - "signature": "void draw_circle(color clr,const point_2d &pt,double radius,drawing_options opts);", - "name": "draw_circle", + "signature": "void fill_circle(color clr,double x,double y,double radius,drawing_options opts);", + "name": "fill_circle", "method_name": null, - "unique_global_name": "draw_circle_at_point_with_options", + "unique_global_name": "fill_circle_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Draw a circle at a point, with a specified radius, using the supplied drawing options. This will use `drawing_options` to determine\nthe destination.", + "description": "Fill a circle using the supplied drawing options. The circle is centred on its x, y\ncoordinates, and has the provided radius. This will use `drawing_options` to determine\nthe destination.", "brief": null, "return": { "type": "void", @@ -22680,12 +22401,25 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The location of the center of the circle", + "x": { + "type": "double", + "description": "The x location of the circle", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y location of the circle", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -22721,32 +22455,32 @@ } }, "attributes": { - "suffix": "at_point_with_options", + "suffix": "with_options", "group": "graphics" }, "signatures": { - "python": [ - "def draw_circle_at_point_with_options(clr, pt, radius, opts):" - ], "cpp": [ - "void draw_circle(color clr, const point_2d &pt, double radius, drawing_options opts)" + "void fill_circle(color clr, double x, double y, double radius, drawing_options opts)" + ], + "python": [ + "def fill_circle_with_options(clr, x, y, radius, opts):" ], "csharp": [ - "public static void SplashKit.DrawCircle(Color clr, Point2D pt, double radius, DrawingOptions opts);" + "public static void SplashKit.FillCircle(Color clr, double x, double y, double radius, DrawingOptions opts);" ], "pascal": [ - "procedure DrawCircle(clr: Color; const pt: Point2D; radius: Double; opts: DrawingOptions)" + "procedure FillCircle(clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)" ] } }, { - "signature": "void draw_circle(color clr,double x,double y,double radius);", - "name": "draw_circle", - "method_name": null, - "unique_global_name": "draw_circle", - "unique_method_name": null, + "signature": "void fill_circle_on_bitmap(bitmap destination,color clr,double x,double y,double radius);", + "name": "fill_circle_on_bitmap", + "method_name": "fill_circle", + "unique_global_name": "fill_circle_on_bitmap", + "unique_method_name": "bitmap.fill_circle", "suffix_name": null, - "description": "Draw a circle onto the current window. The circle is centred on its x, y\ncoordinates, and has the provided radius.", + "description": "Fill a circle onto the destination bitmap. The circle is centred on its x, y\ncoordinates, and has the provided radius.", "brief": null, "return": { "type": "void", @@ -22757,6 +22491,19 @@ "type_parameter": null }, "parameters": { + "destination": { + "type": "bitmap", + "description": "The destination bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "clr": { "type": "color", "description": "The color of the circle", @@ -22811,31 +22558,35 @@ } }, "attributes": { - "group": "graphics" + "class": "bitmap", + "method": "fill_circle", + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def draw_circle(clr, x, y, radius):" - ], "cpp": [ - "void draw_circle(color clr, double x, double y, double radius)" + "void fill_circle_on_bitmap(bitmap destination, color clr, double x, double y, double radius)" + ], + "python": [ + "def fill_circle_on_bitmap(destination, clr, x, y, radius):" ], "csharp": [ - "public static void SplashKit.DrawCircle(Color clr, double x, double y, double radius);" + "public void Bitmap.FillCircle(Color clr, double x, double y, double radius);", + "public static void SplashKit.FillCircleOnBitmap(Bitmap destination, Color clr, double x, double y, double radius);" ], "pascal": [ - "procedure DrawCircle(clr: Color; x: Double; y: Double; radius: Double)" + "procedure FillCircleOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; radius: Double)" ] } }, { - "signature": "void draw_circle(color clr,double x,double y,double radius,drawing_options opts);", - "name": "draw_circle", - "method_name": null, - "unique_global_name": "draw_circle_with_options", - "unique_method_name": null, + "signature": "void fill_circle_on_bitmap(bitmap destination,color clr,double x,double y,double radius,drawing_options opts);", + "name": "fill_circle_on_bitmap", + "method_name": "fill_circle", + "unique_global_name": "fill_circle_on_bitmap_with_options", + "unique_method_name": "bitmap.fill_circle_with_options", "suffix_name": null, - "description": "Draw a circle using the supplied drawing options. The circle is centred on its x, y\ncoordinates, and has the provided radius. This will use `drawing_options` to determine\nthe destination.", + "description": "Fill a circle to the bitmap using the supplied drawing options. The circle is centred on its x, y\ncoordinates, and has the provided radius.", "brief": null, "return": { "type": "void", @@ -22846,6 +22597,19 @@ "type_parameter": null }, "parameters": { + "destination": { + "type": "bitmap", + "description": "The destination bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "clr": { "type": "color", "description": "The color of the circle", @@ -22913,32 +22677,36 @@ } }, "attributes": { + "class": "bitmap", + "method": "fill_circle", "suffix": "with_options", - "group": "graphics" + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def draw_circle_with_options(clr, x, y, radius, opts):" - ], "cpp": [ - "void draw_circle(color clr, double x, double y, double radius, drawing_options opts)" + "void fill_circle_on_bitmap(bitmap destination, color clr, double x, double y, double radius, drawing_options opts)" + ], + "python": [ + "def fill_circle_on_bitmap_with_options(destination, clr, x, y, radius, opts):" ], "csharp": [ - "public static void SplashKit.DrawCircle(Color clr, double x, double y, double radius, DrawingOptions opts);" + "public void Bitmap.FillCircle(Color clr, double x, double y, double radius, DrawingOptions opts);", + "public static void SplashKit.FillCircleOnBitmap(Bitmap destination, Color clr, double x, double y, double radius, DrawingOptions opts);" ], "pascal": [ - "procedure DrawCircle(clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)" + "procedure FillCircleOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)" ] } }, { - "signature": "void draw_circle_on_bitmap(bitmap destination,color clr,double x,double y,double radius);", - "name": "draw_circle_on_bitmap", - "method_name": "draw_circle", - "unique_global_name": "draw_circle_on_bitmap", - "unique_method_name": "bitmap.draw_circle", + "signature": "void fill_circle_on_window(window destination,color clr,double x,double y,double radius);", + "name": "fill_circle_on_window", + "method_name": "fill_circle", + "unique_global_name": "fill_circle_on_window", + "unique_method_name": "window.fill_circle", "suffix_name": null, - "description": "Draw a circle onto the destination bitmap. The circle is centred on its x, y\ncoordinates, and has the provided radius.", + "description": "Fill a circle onto the destination window. The circle is centred on its x, y\ncoordinates, and has the provided radius.", "brief": null, "return": { "type": "void", @@ -22950,8 +22718,8 @@ }, "parameters": { "destination": { - "type": "bitmap", - "description": "The destination bitmap", + "type": "window", + "description": "The destination window", "is_pointer": false, "is_const": false, "is_reference": false, @@ -23016,35 +22784,35 @@ } }, "attributes": { - "class": "bitmap", - "method": "draw_circle", + "class": "window", + "method": "fill_circle", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_circle_on_bitmap(destination, clr, x, y, radius):" - ], "cpp": [ - "void draw_circle_on_bitmap(bitmap destination, color clr, double x, double y, double radius)" + "void fill_circle_on_window(window destination, color clr, double x, double y, double radius)" + ], + "python": [ + "def fill_circle_on_window(destination, clr, x, y, radius):" ], "csharp": [ - "public void Bitmap.DrawCircle(Color clr, double x, double y, double radius);", - "public static void SplashKit.DrawCircleOnBitmap(Bitmap destination, Color clr, double x, double y, double radius);" + "public void Window.FillCircle(Color clr, double x, double y, double radius);", + "public static void SplashKit.FillCircleOnWindow(Window destination, Color clr, double x, double y, double radius);" ], "pascal": [ - "procedure DrawCircleOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; radius: Double)" + "procedure FillCircleOnWindow(destination: Window; clr: Color; x: Double; y: Double; radius: Double)" ] } }, { - "signature": "void draw_circle_on_bitmap(bitmap destination,color clr,double x,double y,double radius,drawing_options opts);", - "name": "draw_circle_on_bitmap", - "method_name": "draw_circle", - "unique_global_name": "draw_circle_on_bitmap_with_options", - "unique_method_name": "bitmap.draw_circle_with_options", + "signature": "void fill_circle_on_window(window destination,color clr,double x,double y,double radius,drawing_options opts);", + "name": "fill_circle_on_window", + "method_name": "fill_circle", + "unique_global_name": "fill_circle_on_window_with_options", + "unique_method_name": "window.fill_circle_with_options", "suffix_name": null, - "description": "Draw a circle to the bitmap using the supplied drawing options. The circle is centred on its x, y\ncoordinates, and has the provided radius.", + "description": "Fill a circle to the window using the supplied drawing options. The circle is centred on its x, y\ncoordinates, and has the provided radius.", "brief": null, "return": { "type": "void", @@ -23056,8 +22824,8 @@ }, "parameters": { "destination": { - "type": "bitmap", - "description": "The destination bitmap", + "type": "window", + "description": "The destination window", "is_pointer": false, "is_const": false, "is_reference": false, @@ -23135,101 +22903,86 @@ } }, "attributes": { - "class": "bitmap", - "method": "draw_circle", + "class": "window", + "method": "fill_circle", "suffix": "with_options", "group": "graphics", "self": "destination" }, "signatures": { + "cpp": [ + "void fill_circle_on_window(window destination, color clr, double x, double y, double radius, drawing_options opts)" + ], "python": [ - "def draw_circle_on_bitmap_with_options(destination, clr, x, y, radius, opts):" + "def fill_circle_on_window_with_options(destination, clr, x, y, radius, opts):" + ], + "csharp": [ + "public void Window.FillCircle(Color clr, double x, double y, double radius, DrawingOptions opts);", + "public static void SplashKit.FillCircleOnWindow(Window destination, Color clr, double x, double y, double radius, DrawingOptions opts);" ], + "pascal": [ + "procedure FillCircleOnWindow(destination: Window; clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)" + ] + } + }, + { + "signature": "rectangle current_clip();", + "name": "current_clip", + "method_name": null, + "unique_global_name": "current_clip", + "unique_method_name": null, + "suffix_name": null, + "description": "Returns the rectangle of the current clip area for the current window", + "brief": null, + "return": { + "type": "rectangle", + "description": "The current clipping rectangle for the current window", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + }, + "attributes": { + "group": "graphics" + }, + "signatures": { "cpp": [ - "void draw_circle_on_bitmap(bitmap destination, color clr, double x, double y, double radius, drawing_options opts)" + "rectangle current_clip()" + ], + "python": [ + "def current_clip():" ], "csharp": [ - "public void Bitmap.DrawCircle(Color clr, double x, double y, double radius, DrawingOptions opts);", - "public static void SplashKit.DrawCircleOnBitmap(Bitmap destination, Color clr, double x, double y, double radius, DrawingOptions opts);" + "public static Rectangle SplashKit.CurrentClip();" ], "pascal": [ - "procedure DrawCircleOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)" + "function CurrentClip(): Rectangle" ] } }, { - "signature": "void draw_circle_on_window(window destination,color clr,double x,double y,double radius);", - "name": "draw_circle_on_window", - "method_name": "draw_circle", - "unique_global_name": "draw_circle_on_window", - "unique_method_name": "window.draw_circle", + "signature": "rectangle current_clip(bitmap bmp);", + "name": "current_clip", + "method_name": null, + "unique_global_name": "current_clip_for_bitmap", + "unique_method_name": null, "suffix_name": null, - "description": "Draw a circle onto the destination window. The circle is centred on its x, y\ncoordinates, and has the provided radius.", + "description": "Returns the rectangle of the current clip area for a bitmap", "brief": null, "return": { - "type": "void", - "description": null, + "type": "rectangle", + "description": "The current clipping rectangle for the bitmap", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "The destination window", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The x location of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "radius": { - "type": "double", - "description": "The radius of the circle", + "bmp": { + "type": "bitmap", + "description": "The bitmap to get the clipping rectangle from", "is_pointer": false, "is_const": false, "is_reference": false, @@ -23242,113 +22995,45 @@ } }, "attributes": { - "class": "window", - "method": "draw_circle", - "group": "graphics", - "self": "destination" + "suffix": "for_bitmap", + "group": "graphics" }, "signatures": { - "python": [ - "def draw_circle_on_window(destination, clr, x, y, radius):" - ], "cpp": [ - "void draw_circle_on_window(window destination, color clr, double x, double y, double radius)" + "rectangle current_clip(bitmap bmp)" + ], + "python": [ + "def current_clip_for_bitmap(bmp):" ], "csharp": [ - "public void Window.DrawCircle(Color clr, double x, double y, double radius);", - "public static void SplashKit.DrawCircleOnWindow(Window destination, Color clr, double x, double y, double radius);" + "public static Rectangle SplashKit.CurrentClip(Bitmap bmp);" ], "pascal": [ - "procedure DrawCircleOnWindow(destination: Window; clr: Color; x: Double; y: Double; radius: Double)" + "function CurrentClip(bmp: Bitmap): Rectangle" ] } }, { - "signature": "void draw_circle_on_window(window destination,color clr,double x,double y,double radius,drawing_options opts);", - "name": "draw_circle_on_window", - "method_name": "draw_circle", - "unique_global_name": "draw_circle_on_window_with_options", - "unique_method_name": "window.draw_circle_with_options", + "signature": "rectangle current_clip(window wnd);", + "name": "current_clip", + "method_name": null, + "unique_global_name": "current_clip_for_window", + "unique_method_name": null, "suffix_name": null, - "description": "Draw a circle to the window using the supplied drawing options. The circle is centred on its x, y\ncoordinates, and has the provided radius.", + "description": "Returns the rectangle of the current clip area for a window", "brief": null, "return": { - "type": "void", - "description": null, + "type": "rectangle", + "description": "The current clipping rectangle for the window", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { + "wnd": { "type": "window", - "description": "The destination window", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The x location of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "radius": { - "type": "double", - "description": "The radius of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "Drawing options to configure the drawing operation", + "description": "The window to get the clipping rectangle from", "is_pointer": false, "is_const": false, "is_reference": false, @@ -23361,36 +23046,32 @@ } }, "attributes": { - "class": "window", - "method": "draw_circle", - "suffix": "with_options", - "group": "graphics", - "self": "destination" + "suffix": "for_window", + "group": "graphics" }, "signatures": { - "python": [ - "def draw_circle_on_window_with_options(destination, clr, x, y, radius, opts):" - ], "cpp": [ - "void draw_circle_on_window(window destination, color clr, double x, double y, double radius, drawing_options opts)" + "rectangle current_clip(window wnd)" + ], + "python": [ + "def current_clip_for_window(wnd):" ], "csharp": [ - "public void Window.DrawCircle(Color clr, double x, double y, double radius, DrawingOptions opts);", - "public static void SplashKit.DrawCircleOnWindow(Window destination, Color clr, double x, double y, double radius, DrawingOptions opts);" + "public static Rectangle SplashKit.CurrentClip(Window wnd);" ], "pascal": [ - "procedure DrawCircleOnWindow(destination: Window; clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)" + "function CurrentClip(wnd: Window): Rectangle" ] } }, { - "signature": "void fill_circle(color clr,const circle &c);", - "name": "fill_circle", - "method_name": "fill", - "unique_global_name": "fill_circle_record", - "unique_method_name": "circle.fill_record", + "signature": "void pop_clip(window wnd);", + "name": "pop_clip", + "method_name": null, + "unique_global_name": "pop_clip_for_window", + "unique_method_name": null, "suffix_name": null, - "description": "Draw a circle on the current window. The circle is centred on its x, y\ncoordinates, and has the provided radius.", + "description": "Remove the last clipping rectangle pushed to the window. This\nwill then apply the previously pushed clipping rectangle.", "brief": null, "return": { "type": "void", @@ -23401,64 +23082,84 @@ "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color of the circle", + "wnd": { + "type": "window", + "description": "The window to change", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "c": { - "type": "circle", - "description": "The circle being drawn", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "circle", - "method": "fill", - "self": "c", - "suffix": "record", + "suffix": "for_window", "group": "graphics" }, "signatures": { + "cpp": [ + "void pop_clip(window wnd)" + ], "python": [ - "def fill_circle_record(clr, c):" + "def pop_clip_for_window(wnd):" + ], + "csharp": [ + "public static void SplashKit.PopClip(Window wnd);" ], + "pascal": [ + "procedure PopClip(wnd: Window)" + ] + } + }, + { + "signature": "void pop_clip();", + "name": "pop_clip", + "method_name": null, + "unique_global_name": "pop_clip", + "unique_method_name": null, + "suffix_name": null, + "description": "Remove the last clipping rectangle pushed to the current window. This\nwill then apply the previously pushed clipping rectangle.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + }, + "attributes": { + "group": "graphics" + }, + "signatures": { "cpp": [ - "void fill_circle(color clr, const circle &c)" + "void pop_clip()" + ], + "python": [ + "def pop_clip():" ], "csharp": [ - "public void Circle.Fill(Color clr);", - "public static void SplashKit.FillCircle(Color clr, Circle c);" + "public static void SplashKit.PopClip();" ], "pascal": [ - "procedure FillCircle(clr: Color; const c: Circle)" + "procedure PopClip()" ] } }, { - "signature": "void fill_circle(color clr,const circle &c,drawing_options opts);", - "name": "fill_circle", - "method_name": "fill", - "unique_global_name": "fill_circle_record_with_options", - "unique_method_name": "circle.fill_record_with_options", + "signature": "void pop_clip(bitmap bmp);", + "name": "pop_clip", + "method_name": null, + "unique_global_name": "pop_clip_for_bitmap", + "unique_method_name": null, "suffix_name": null, - "description": "Fill a circle with the provided drawing options, which may include options related to\nthe drawing destination.", + "description": "Remove the last clipping rectangle pushed to the bitmap. This\nwill then apply the previously pushed clipping rectangle.", "brief": null, "return": { "type": "void", @@ -23469,35 +23170,9 @@ "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "c": { - "type": "circle", - "description": "The circle being drawn", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "Drawing options to configure the drawing operation", + "bmp": { + "type": "bitmap", + "description": "The bitmap to change", "is_pointer": false, "is_const": false, "is_reference": false, @@ -23510,36 +23185,32 @@ } }, "attributes": { - "class": "circle", - "method": "fill", - "self": "c", - "suffix": "record_with_options", + "suffix": "for_bitmap", "group": "graphics" }, "signatures": { - "python": [ - "def fill_circle_record_with_options(clr, c, opts):" - ], "cpp": [ - "void fill_circle(color clr, const circle &c, drawing_options opts)" + "void pop_clip(bitmap bmp)" + ], + "python": [ + "def pop_clip_for_bitmap(bmp):" ], "csharp": [ - "public void Circle.Fill(Color clr, DrawingOptions opts);", - "public static void SplashKit.FillCircle(Color clr, Circle c, DrawingOptions opts);" + "public static void SplashKit.PopClip(Bitmap bmp);" ], "pascal": [ - "procedure FillCircle(clr: Color; const c: Circle; opts: DrawingOptions)" + "procedure PopClip(bmp: Bitmap)" ] } }, { - "signature": "void fill_circle(color clr,const point_2d &pt,double radius);", - "name": "fill_circle", + "signature": "void push_clip(window wnd,const rectangle &r);", + "name": "push_clip", "method_name": null, - "unique_global_name": "fill_circle_at_point", + "unique_global_name": "push_clip_for_window", "unique_method_name": null, "suffix_name": null, - "description": "Fill a circle at a point, with a specified radius, onto the current window.", + "description": "Add the clipping rectangle of a window and uses the intersect between\nthe new rectangle and previous clip.\n\nWhen a clipping rectangle is provided, drawing operations will only\naffect the area specified in the current clipping rectangle.", "brief": null, "return": { "type": "void", @@ -23550,9 +23221,9 @@ "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color of the circle", + "wnd": { + "type": "window", + "description": "The window to add clipping to", "is_pointer": false, "is_const": false, "is_reference": false, @@ -23563,60 +23234,47 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The location of the center of the circle", + "r": { + "type": "rectangle", + "description": "The new clipping rectangle", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "radius": { - "type": "double", - "description": "The radius of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "suffix": "at_point", + "suffix": "for_window", "group": "graphics" }, "signatures": { - "python": [ - "def fill_circle_at_point(clr, pt, radius):" - ], "cpp": [ - "void fill_circle(color clr, const point_2d &pt, double radius)" + "void push_clip(window wnd, const rectangle &r)" + ], + "python": [ + "def push_clip_for_window(wnd, r):" ], "csharp": [ - "public static void SplashKit.FillCircle(Color clr, Point2D pt, double radius);" + "public static void SplashKit.PushClip(Window wnd, Rectangle r);" ], "pascal": [ - "procedure FillCircle(clr: Color; const pt: Point2D; radius: Double)" + "procedure PushClip(wnd: Window; const r: Rectangle)" ] } }, { - "signature": "void fill_circle(color clr,const point_2d &pt,double radius,drawing_options opts);", - "name": "fill_circle", + "signature": "void push_clip(bitmap bmp,const rectangle &r);", + "name": "push_clip", "method_name": null, - "unique_global_name": "fill_circle_at_point_with_options", + "unique_global_name": "push_clip_for_bitmap", "unique_method_name": null, "suffix_name": null, - "description": "Fill a circle at a point, with a specified radius, using the supplied drawing options. This will use `drawing_options` to determine\nthe destination.", + "description": "Add the clipping rectangle of a bitmap and uses the intersect between\nthe new rectangle and previous clip.\n\nWhen a clipping rectangle is provided, drawing operations will only\naffect the area specified in the current clipping rectangle.", "brief": null, "return": { "type": "void", @@ -23627,9 +23285,9 @@ "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color of the circle", + "bmp": { + "type": "bitmap", + "description": "The bitmap to add clipping to", "is_pointer": false, "is_const": false, "is_reference": false, @@ -23640,73 +23298,47 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The location of the center of the circle", + "r": { + "type": "rectangle", + "description": "The new clipping rectangle", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "radius": { - "type": "double", - "description": "The radius of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "Drawing options to configure the drawing operation", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "suffix": "at_point_with_options", + "suffix": "for_bitmap", "group": "graphics" }, "signatures": { - "python": [ - "def fill_circle_at_point_with_options(clr, pt, radius, opts):" - ], "cpp": [ - "void fill_circle(color clr, const point_2d &pt, double radius, drawing_options opts)" + "void push_clip(bitmap bmp, const rectangle &r)" + ], + "python": [ + "def push_clip_for_bitmap(bmp, r):" ], "csharp": [ - "public static void SplashKit.FillCircle(Color clr, Point2D pt, double radius, DrawingOptions opts);" + "public static void SplashKit.PushClip(Bitmap bmp, Rectangle r);" ], "pascal": [ - "procedure FillCircle(clr: Color; const pt: Point2D; radius: Double; opts: DrawingOptions)" + "procedure PushClip(bmp: Bitmap; const r: Rectangle)" ] } }, { - "signature": "void fill_circle(color clr,double x,double y,double radius);", - "name": "fill_circle", + "signature": "void push_clip(const rectangle &r);", + "name": "push_clip", "method_name": null, - "unique_global_name": "fill_circle", + "unique_global_name": "push_clip", "unique_method_name": null, "suffix_name": null, - "description": "Fill a circle onto the current window. The circle is centred on its x, y\ncoordinates, and has the provided radius.", + "description": "Push a clip rectangle to the current window. The resulting clipping\nrectangle will be the intersection of the existing clipping rectangle\nwith the new rectangle provided in this call. This can be undone using\n`pop_clip`.\n\nWhen a clipping rectangle is provided, drawing operations will only\naffect the area specified in the current clipping rectangle.", "brief": null, "return": { "type": "void", @@ -23717,48 +23349,59 @@ "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color of the circle", + "r": { + "type": "rectangle", + "description": "The new clipping rectangle", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - }, - "x": { - "type": "double", - "description": "The x location of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "radius": { - "type": "double", - "description": "The radius of the circle", + } + }, + "attributes": { + "group": "graphics" + }, + "signatures": { + "cpp": [ + "void push_clip(const rectangle &r)" + ], + "python": [ + "def push_clip(r):" + ], + "csharp": [ + "public static void SplashKit.PushClip(Rectangle r);" + ], + "pascal": [ + "procedure PushClip(const r: Rectangle)" + ] + } + }, + { + "signature": "void reset_clip(bitmap bmp);", + "name": "reset_clip", + "method_name": null, + "unique_global_name": "reset_clip_for_bitmap", + "unique_method_name": null, + "suffix_name": null, + "description": "Reset the clipping rectangle on a bitmap. This will clear all\nof the clipping rectangles pushed to the bitmap.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "bmp": { + "type": "bitmap", + "description": "The bitmap to clear the clipping rectangle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -23771,31 +23414,69 @@ } }, "attributes": { + "suffix": "for_bitmap", "group": "graphics" }, "signatures": { + "cpp": [ + "void reset_clip(bitmap bmp)" + ], "python": [ - "def fill_circle(clr, x, y, radius):" + "def reset_clip_for_bitmap(bmp):" + ], + "csharp": [ + "public static void SplashKit.ResetClip(Bitmap bmp);" ], + "pascal": [ + "procedure ResetClip(bmp: Bitmap)" + ] + } + }, + { + "signature": "void reset_clip();", + "name": "reset_clip", + "method_name": null, + "unique_global_name": "reset_clip", + "unique_method_name": null, + "suffix_name": null, + "description": "Reset the clipping rectangle of the current window. This will clear all\nof the clipping rectangles pushed to the current window.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + }, + "attributes": { + "group": "graphics" + }, + "signatures": { "cpp": [ - "void fill_circle(color clr, double x, double y, double radius)" + "void reset_clip()" + ], + "python": [ + "def reset_clip():" ], "csharp": [ - "public static void SplashKit.FillCircle(Color clr, double x, double y, double radius);" + "public static void SplashKit.ResetClip();" ], "pascal": [ - "procedure FillCircle(clr: Color; x: Double; y: Double; radius: Double)" + "procedure ResetClip()" ] } }, { - "signature": "void fill_circle(color clr,double x,double y,double radius,drawing_options opts);", - "name": "fill_circle", + "signature": "void reset_clip(window wnd);", + "name": "reset_clip", "method_name": null, - "unique_global_name": "fill_circle_with_options", + "unique_global_name": "reset_clip_for_window", "unique_method_name": null, "suffix_name": null, - "description": "Fill a circle using the supplied drawing options. The circle is centred on its x, y\ncoordinates, and has the provided radius. This will use `drawing_options` to determine\nthe destination.", + "description": "Reset the clipping rectangle on a window. This will clear all\nof the clipping rectangles pushed to the window.", "brief": null, "return": { "type": "void", @@ -23806,22 +23487,9 @@ "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The x location of the circle", + "wnd": { + "type": "window", + "description": "The window to clear the clipping rectangle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -23831,23 +23499,98 @@ ], "is_vector": false, "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location of the circle", + } + }, + "attributes": { + "suffix": "for_window", + "group": "graphics" + }, + "signatures": { + "cpp": [ + "void reset_clip(window wnd)" + ], + "python": [ + "def reset_clip_for_window(wnd):" + ], + "csharp": [ + "public static void SplashKit.ResetClip(Window wnd);" + ], + "pascal": [ + "procedure ResetClip(wnd: Window)" + ] + } + }, + { + "signature": "void set_clip(const rectangle &r);", + "name": "set_clip", + "method_name": null, + "unique_global_name": "set_clip", + "unique_method_name": null, + "suffix_name": null, + "description": "Set the clip rectangle of the current window. This will clear any\nexisting clipping rectangles pushed to the current window, and use the\nsupplied rectangle for clipping.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "r": { + "type": "rectangle", + "description": "The new clipping rectangle", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - }, - "radius": { - "type": "double", - "description": "The radius of the circle", + } + }, + "attributes": { + "group": "graphics" + }, + "signatures": { + "cpp": [ + "void set_clip(const rectangle &r)" + ], + "python": [ + "def set_clip(r):" + ], + "csharp": [ + "public static void SplashKit.SetClip(Rectangle r);" + ], + "pascal": [ + "procedure SetClip(const r: Rectangle)" + ] + } + }, + { + "signature": "void set_clip(bitmap bmp,const rectangle &r);", + "name": "set_clip", + "method_name": null, + "unique_global_name": "set_clip_for_bitmap", + "unique_method_name": null, + "suffix_name": null, + "description": "Set the clip rectangle of the bitmap. This will clear any existing\nclipping rectangles pushed to the bitmap, and use the supplied rectangle\nfor clipping.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "bmp": { + "type": "bitmap", + "description": "The bitmap to change", "is_pointer": false, "is_const": false, "is_reference": false, @@ -23858,12 +23601,12 @@ "is_vector": false, "type_parameter": null }, - "opts": { - "type": "drawing_options", - "description": "Drawing options to configure the drawing operation", + "r": { + "type": "rectangle", + "description": "The new clipping rectangle", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -23873,32 +23616,32 @@ } }, "attributes": { - "suffix": "with_options", + "suffix": "for_bitmap", "group": "graphics" }, "signatures": { - "python": [ - "def fill_circle_with_options(clr, x, y, radius, opts):" - ], "cpp": [ - "void fill_circle(color clr, double x, double y, double radius, drawing_options opts)" + "void set_clip(bitmap bmp, const rectangle &r)" + ], + "python": [ + "def set_clip_for_bitmap(bmp, r):" ], "csharp": [ - "public static void SplashKit.FillCircle(Color clr, double x, double y, double radius, DrawingOptions opts);" + "public static void SplashKit.SetClip(Bitmap bmp, Rectangle r);" ], "pascal": [ - "procedure FillCircle(clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)" + "procedure SetClip(bmp: Bitmap; const r: Rectangle)" ] } }, { - "signature": "void fill_circle_on_bitmap(bitmap destination,color clr,double x,double y,double radius);", - "name": "fill_circle_on_bitmap", - "method_name": "fill_circle", - "unique_global_name": "fill_circle_on_bitmap", - "unique_method_name": "bitmap.fill_circle", + "signature": "void set_clip(window wnd,const rectangle &r);", + "name": "set_clip", + "method_name": null, + "unique_global_name": "set_clip_for_window", + "unique_method_name": null, "suffix_name": null, - "description": "Fill a circle onto the destination bitmap. The circle is centred on its x, y\ncoordinates, and has the provided radius.", + "description": "Set the clip rectangle of the window. This will clear any existing\nclipping rectangles pushed to the window, and use the supplied rectangle\nfor clipping.", "brief": null, "return": { "type": "void", @@ -23909,9 +23652,9 @@ "type_parameter": null }, "parameters": { - "destination": { - "type": "bitmap", - "description": "The destination bitmap", + "wnd": { + "type": "window", + "description": "The window to change", "is_pointer": false, "is_const": false, "is_reference": false, @@ -23922,22 +23665,97 @@ "is_vector": false, "type_parameter": null }, - "clr": { - "type": "color", - "description": "The color of the circle", + "r": { + "type": "rectangle", + "description": "The new clipping rectangle", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - }, - "x": { - "type": "double", - "description": "The x location of the circle", + } + }, + "attributes": { + "suffix": "for_window", + "group": "graphics" + }, + "signatures": { + "cpp": [ + "void set_clip(window wnd, const rectangle &r)" + ], + "python": [ + "def set_clip_for_window(wnd, r):" + ], + "csharp": [ + "public static void SplashKit.SetClip(Window wnd, Rectangle r);" + ], + "pascal": [ + "procedure SetClip(wnd: Window; const r: Rectangle)" + ] + } + }, + { + "signature": "drawing_options option_defaults();", + "name": "option_defaults", + "method_name": null, + "unique_global_name": "option_defaults", + "unique_method_name": null, + "suffix_name": null, + "description": "Returns a `drawing_options` with default values.\nThis will draw to the current window, with default scale of 1, no\nrotation or offset, not flipped, drawing whole images, with default\ncamera mechanisms and line width.", + "brief": null, + "return": { + "type": "drawing_options", + "description": "A default drawing options.", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + }, + "attributes": { + "group": "graphics" + }, + "signatures": { + "cpp": [ + "drawing_options option_defaults()" + ], + "python": [ + "def option_defaults():" + ], + "csharp": [ + "public static DrawingOptions SplashKit.OptionDefaults();" + ], + "pascal": [ + "function OptionDefaults(): DrawingOptions" + ] + } + }, + { + "signature": "drawing_options option_draw_to(bitmap dest);", + "name": "option_draw_to", + "method_name": null, + "unique_global_name": "option_draw_to_bitmap", + "unique_method_name": null, + "suffix_name": null, + "description": "Use this option to draw to a Bitmap. Pass dest the Bitmap you want to draw on.", + "brief": null, + "return": { + "type": "drawing_options", + "description": "Drawing options that will draw onto a bitmap.", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "dest": { + "type": "bitmap", + "description": "The bitmap to draw to.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -23947,10 +23765,48 @@ ], "is_vector": false, "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location of the circle", + } + }, + "attributes": { + "suffix": "bitmap", + "group": "graphics" + }, + "signatures": { + "cpp": [ + "drawing_options option_draw_to(bitmap dest)" + ], + "python": [ + "def option_draw_to_bitmap(dest):" + ], + "csharp": [ + "public static DrawingOptions SplashKit.OptionDrawTo(Bitmap dest);" + ], + "pascal": [ + "function OptionDrawTo(dest: Bitmap): DrawingOptions" + ] + } + }, + { + "signature": "drawing_options option_draw_to(bitmap dest,drawing_options opts);", + "name": "option_draw_to", + "method_name": null, + "unique_global_name": "option_draw_to_bitmap_with_options", + "unique_method_name": null, + "suffix_name": null, + "description": "Use this option to draw to a Bitmap. Pass dest the Bitmap you want to draw on.\nPass opts the other options you want use.", + "brief": null, + "return": { + "type": "drawing_options", + "description": "Drawing options that will draw onto a bitmap.", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "dest": { + "type": "bitmap", + "description": "The bitmap to draw to.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -23961,9 +23817,9 @@ "is_vector": false, "type_parameter": null }, - "radius": { - "type": "double", - "description": "The radius of the circle", + "opts": { + "type": "drawing_options", + "description": "Values for the other options.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -23976,48 +23832,45 @@ } }, "attributes": { - "class": "bitmap", - "method": "fill_circle", - "group": "graphics", - "self": "destination" + "suffix": "bitmap_with_options", + "group": "graphics" }, "signatures": { - "python": [ - "def fill_circle_on_bitmap(destination, clr, x, y, radius):" - ], "cpp": [ - "void fill_circle_on_bitmap(bitmap destination, color clr, double x, double y, double radius)" + "drawing_options option_draw_to(bitmap dest, drawing_options opts)" + ], + "python": [ + "def option_draw_to_bitmap_with_options(dest, opts):" ], "csharp": [ - "public void Bitmap.FillCircle(Color clr, double x, double y, double radius);", - "public static void SplashKit.FillCircleOnBitmap(Bitmap destination, Color clr, double x, double y, double radius);" + "public static DrawingOptions SplashKit.OptionDrawTo(Bitmap dest, DrawingOptions opts);" ], "pascal": [ - "procedure FillCircleOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; radius: Double)" + "function OptionDrawTo(dest: Bitmap; opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "void fill_circle_on_bitmap(bitmap destination,color clr,double x,double y,double radius,drawing_options opts);", - "name": "fill_circle_on_bitmap", - "method_name": "fill_circle", - "unique_global_name": "fill_circle_on_bitmap_with_options", - "unique_method_name": "bitmap.fill_circle_with_options", + "signature": "drawing_options option_draw_to(window dest);", + "name": "option_draw_to", + "method_name": null, + "unique_global_name": "option_draw_to_window", + "unique_method_name": null, "suffix_name": null, - "description": "Fill a circle to the bitmap using the supplied drawing options. The circle is centred on its x, y\ncoordinates, and has the provided radius.", + "description": "Use this option to draw to a specified Window. Pass dest the Window you want to draw on.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "drawing_options", + "description": "A drawing option that will draw to the indicated window.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "bitmap", - "description": "The destination bitmap", + "dest": { + "type": "window", + "description": "The window to draw onto.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -24027,10 +23880,48 @@ ], "is_vector": false, "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the circle", + } + }, + "attributes": { + "suffix": "window", + "group": "graphics" + }, + "signatures": { + "cpp": [ + "drawing_options option_draw_to(window dest)" + ], + "python": [ + "def option_draw_to_window(dest):" + ], + "csharp": [ + "public static DrawingOptions SplashKit.OptionDrawTo(Window dest);" + ], + "pascal": [ + "function OptionDrawTo(dest: Window): DrawingOptions" + ] + } + }, + { + "signature": "drawing_options option_draw_to(window dest,drawing_options opts);", + "name": "option_draw_to", + "method_name": null, + "unique_global_name": "option_draw_to_window_with_options", + "unique_method_name": null, + "suffix_name": null, + "description": "Use this option to draw to a Bitmap. Pass dest the Bitmap you want to draw on to.\nPass opts the other options you want use.", + "brief": null, + "return": { + "type": "drawing_options", + "description": "A drawing option that will draw to the indicated window.", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "dest": { + "type": "window", + "description": "The window to draw onto.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -24041,48 +23932,9 @@ "is_vector": false, "type_parameter": null }, - "x": { - "type": "double", - "description": "The x location of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "radius": { - "type": "double", - "description": "The radius of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "Drawing options to configure the drawing operation", + "opts": { + "type": "drawing_options", + "description": "Values for the other options.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -24095,220 +23947,82 @@ } }, "attributes": { - "class": "bitmap", - "method": "fill_circle", - "suffix": "with_options", - "group": "graphics", - "self": "destination" + "suffix": "window_with_options", + "group": "graphics" }, "signatures": { - "python": [ - "def fill_circle_on_bitmap_with_options(destination, clr, x, y, radius, opts):" - ], "cpp": [ - "void fill_circle_on_bitmap(bitmap destination, color clr, double x, double y, double radius, drawing_options opts)" + "drawing_options option_draw_to(window dest, drawing_options opts)" + ], + "python": [ + "def option_draw_to_window_with_options(dest, opts):" ], "csharp": [ - "public void Bitmap.FillCircle(Color clr, double x, double y, double radius, DrawingOptions opts);", - "public static void SplashKit.FillCircleOnBitmap(Bitmap destination, Color clr, double x, double y, double radius, DrawingOptions opts);" + "public static DrawingOptions SplashKit.OptionDrawTo(Window dest, DrawingOptions opts);" ], "pascal": [ - "procedure FillCircleOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)" + "function OptionDrawTo(dest: Window; opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "void fill_circle_on_window(window destination,color clr,double x,double y,double radius);", - "name": "fill_circle_on_window", - "method_name": "fill_circle", - "unique_global_name": "fill_circle_on_window", - "unique_method_name": "window.fill_circle", + "signature": "drawing_options option_flip_x();", + "name": "option_flip_x", + "method_name": null, + "unique_global_name": "option_flip_x", + "unique_method_name": null, "suffix_name": null, - "description": "Fill a circle onto the destination window. The circle is centred on its x, y\ncoordinates, and has the provided radius.", + "description": "Use this option to flip an image along its X axis.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "drawing_options", + "description": "Options that will flip bitmaps horizontally.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "The destination window", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The x location of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "radius": { - "type": "double", - "description": "The radius of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { - "class": "window", - "method": "fill_circle", - "group": "graphics", - "self": "destination" + "group": "graphics" }, "signatures": { - "python": [ - "def fill_circle_on_window(destination, clr, x, y, radius):" - ], "cpp": [ - "void fill_circle_on_window(window destination, color clr, double x, double y, double radius)" + "drawing_options option_flip_x()" + ], + "python": [ + "def option_flip_x():" ], "csharp": [ - "public void Window.FillCircle(Color clr, double x, double y, double radius);", - "public static void SplashKit.FillCircleOnWindow(Window destination, Color clr, double x, double y, double radius);" + "public static DrawingOptions SplashKit.OptionFlipX();" ], "pascal": [ - "procedure FillCircleOnWindow(destination: Window; clr: Color; x: Double; y: Double; radius: Double)" + "function OptionFlipX(): DrawingOptions" ] } }, { - "signature": "void fill_circle_on_window(window destination,color clr,double x,double y,double radius,drawing_options opts);", - "name": "fill_circle_on_window", - "method_name": "fill_circle", - "unique_global_name": "fill_circle_on_window_with_options", - "unique_method_name": "window.fill_circle_with_options", + "signature": "drawing_options option_flip_x(drawing_options opts);", + "name": "option_flip_x", + "method_name": null, + "unique_global_name": "option_flip_x_with_options", + "unique_method_name": null, "suffix_name": null, - "description": "Fill a circle to the window using the supplied drawing options. The circle is centred on its x, y\ncoordinates, and has the provided radius.", + "description": "Use this option to flip an image along its X axis.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "drawing_options", + "description": "Options that will flip bitmaps horizontally.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "The destination window", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The x location of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "radius": { - "type": "double", - "description": "The radius of the circle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, "opts": { "type": "drawing_options", - "description": "Drawing options to configure the drawing operation", + "description": "Values for the other options.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -24321,40 +24035,36 @@ } }, "attributes": { - "class": "window", - "method": "fill_circle", "suffix": "with_options", - "group": "graphics", - "self": "destination" + "group": "graphics" }, "signatures": { - "python": [ - "def fill_circle_on_window_with_options(destination, clr, x, y, radius, opts):" - ], "cpp": [ - "void fill_circle_on_window(window destination, color clr, double x, double y, double radius, drawing_options opts)" + "drawing_options option_flip_x(drawing_options opts)" + ], + "python": [ + "def option_flip_x_with_options(opts):" ], "csharp": [ - "public void Window.FillCircle(Color clr, double x, double y, double radius, DrawingOptions opts);", - "public static void SplashKit.FillCircleOnWindow(Window destination, Color clr, double x, double y, double radius, DrawingOptions opts);" + "public static DrawingOptions SplashKit.OptionFlipX(DrawingOptions opts);" ], "pascal": [ - "procedure FillCircleOnWindow(destination: Window; clr: Color; x: Double; y: Double; radius: Double; opts: DrawingOptions)" + "function OptionFlipX(opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "rectangle current_clip();", - "name": "current_clip", + "signature": "drawing_options option_flip_xy();", + "name": "option_flip_xy", "method_name": null, - "unique_global_name": "current_clip", + "unique_global_name": "option_flip_xy", "unique_method_name": null, "suffix_name": null, - "description": "Returns the rectangle of the current clip area for the current window", + "description": "Use this option to flip the drawing of an image along both X and Y axis.", "brief": null, "return": { - "type": "rectangle", - "description": "The current clipping rectangle for the current window", + "type": "drawing_options", + "description": "Options that flip bitmap drawing both vertically and\nhorizontally.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -24366,41 +24076,41 @@ "group": "graphics" }, "signatures": { - "python": [ - "def current_clip():" - ], "cpp": [ - "rectangle current_clip()" + "drawing_options option_flip_xy()" + ], + "python": [ + "def option_flip_xy():" ], "csharp": [ - "public static Rectangle SplashKit.CurrentClip();" + "public static DrawingOptions SplashKit.OptionFlipXy();" ], "pascal": [ - "function CurrentClip(): Rectangle" + "function OptionFlipXy(): DrawingOptions" ] } }, { - "signature": "rectangle current_clip(bitmap bmp);", - "name": "current_clip", + "signature": "drawing_options option_flip_xy(drawing_options opts);", + "name": "option_flip_xy", "method_name": null, - "unique_global_name": "current_clip_for_bitmap", + "unique_global_name": "option_flip_xy_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Returns the rectangle of the current clip area for a bitmap", + "description": "Use this option to flip the drawing of an image along both X and Y axis.", "brief": null, "return": { - "type": "rectangle", - "description": "The current clipping rectangle for the bitmap", + "type": "drawing_options", + "description": "Options that flip bitmap drawing both vertically and\nhorizontally.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to get the clipping rectangle from", + "opts": { + "type": "drawing_options", + "description": "Values for the other options.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -24413,100 +24123,82 @@ } }, "attributes": { - "suffix": "for_bitmap", + "suffix": "with_options", "group": "graphics" }, "signatures": { - "python": [ - "def current_clip_for_bitmap(bmp):" - ], "cpp": [ - "rectangle current_clip(bitmap bmp)" + "drawing_options option_flip_xy(drawing_options opts)" + ], + "python": [ + "def option_flip_xy_with_options(opts):" ], "csharp": [ - "public static Rectangle SplashKit.CurrentClip(Bitmap bmp);" + "public static DrawingOptions SplashKit.OptionFlipXy(DrawingOptions opts);" ], "pascal": [ - "function CurrentClip(bmp: Bitmap): Rectangle" + "function OptionFlipXy(opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "rectangle current_clip(window wnd);", - "name": "current_clip", - "method_name": "current_clip", - "unique_global_name": "current_clip_for_window", - "unique_method_name": "window.current_clip_for_window", + "signature": "drawing_options option_flip_y();", + "name": "option_flip_y", + "method_name": null, + "unique_global_name": "option_flip_y", + "unique_method_name": null, "suffix_name": null, - "description": "Returns the rectangle of the current clip area for a window", + "description": "Use this option to flip the drawing of an image along its Y axis.", "brief": null, "return": { - "type": "rectangle", - "description": "The current clipping rectangle for the window", + "type": "drawing_options", + "description": "Options that will flip bitmaps vertically.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "wnd": { - "type": "window", - "description": "The window to get the clipping rectangle from", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { - "class": "window", - "method": "current_clip", - "self": "wnd", - "suffix": "for_window", "group": "graphics" }, "signatures": { - "python": [ - "def current_clip_for_window(wnd):" - ], "cpp": [ - "rectangle current_clip(window wnd)" + "drawing_options option_flip_y()" + ], + "python": [ + "def option_flip_y():" ], "csharp": [ - "public Rectangle Window.CurrentClip();", - "public static Rectangle SplashKit.CurrentClip(Window wnd);" + "public static DrawingOptions SplashKit.OptionFlipY();" ], "pascal": [ - "function CurrentClip(wnd: Window): Rectangle" + "function OptionFlipY(): DrawingOptions" ] } }, { - "signature": "void pop_clip(window wnd);", - "name": "pop_clip", - "method_name": "pop_clip", - "unique_global_name": "pop_clip_for_window", - "unique_method_name": "window.pop_clip_for_window", + "signature": "drawing_options option_flip_y(drawing_options opts);", + "name": "option_flip_y", + "method_name": null, + "unique_global_name": "option_flip_y_with_options", + "unique_method_name": null, "suffix_name": null, - "description": "Remove the last clipping rectangle pushed to the window. This\nwill then apply the previously pushed clipping rectangle.", + "description": "Use this option to flip the drawing of an image along its Y axis.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "drawing_options", + "description": "Options that will flip bitmaps vertically.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "wnd": { - "type": "window", - "description": "The window to change", + "opts": { + "type": "drawing_options", + "description": "Values for the other options.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -24519,86 +24211,45 @@ } }, "attributes": { - "class": "window", - "method": "pop_clip", - "self": "wnd", - "suffix": "for_window", + "suffix": "with_options", "group": "graphics" }, "signatures": { - "python": [ - "def pop_clip_for_window(wnd):" - ], "cpp": [ - "void pop_clip(window wnd)" - ], - "csharp": [ - "public void Window.PopClip();", - "public static void SplashKit.PopClip(Window wnd);" + "drawing_options option_flip_y(drawing_options opts)" ], - "pascal": [ - "procedure PopClip(wnd: Window)" - ] - } - }, - { - "signature": "void pop_clip();", - "name": "pop_clip", - "method_name": null, - "unique_global_name": "pop_clip", - "unique_method_name": null, - "suffix_name": null, - "description": "Remove the last clipping rectangle pushed to the current window. This\nwill then apply the previously pushed clipping rectangle.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "graphics" - }, - "signatures": { "python": [ - "def pop_clip():" - ], - "cpp": [ - "void pop_clip()" + "def option_flip_y_with_options(opts):" ], "csharp": [ - "public static void SplashKit.PopClip();" + "public static DrawingOptions SplashKit.OptionFlipY(DrawingOptions opts);" ], "pascal": [ - "procedure PopClip()" + "function OptionFlipY(opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "void pop_clip(bitmap bmp);", - "name": "pop_clip", + "signature": "drawing_options option_line_width(int width);", + "name": "option_line_width", "method_name": null, - "unique_global_name": "pop_clip_for_bitmap", + "unique_global_name": "option_line_width", "unique_method_name": null, "suffix_name": null, - "description": "Remove the last clipping rectangle pushed to the bitmap. This\nwill then apply the previously pushed clipping rectangle.", + "description": "Use this option to change the width of line drawings.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "drawing_options", + "description": "Options to draw lines with the indicated width.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to change", + "width": { + "type": "int", + "description": "The new line width for line drawing.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -24611,45 +24262,44 @@ } }, "attributes": { - "suffix": "for_bitmap", "group": "graphics" }, "signatures": { - "python": [ - "def pop_clip_for_bitmap(bmp):" - ], "cpp": [ - "void pop_clip(bitmap bmp)" + "drawing_options option_line_width(int width)" + ], + "python": [ + "def option_line_width(width):" ], "csharp": [ - "public static void SplashKit.PopClip(Bitmap bmp);" + "public static DrawingOptions SplashKit.OptionLineWidth(int width);" ], "pascal": [ - "procedure PopClip(bmp: Bitmap)" + "function OptionLineWidth(width: Integer): DrawingOptions" ] } }, { - "signature": "void push_clip(window wnd,const rectangle &r);", - "name": "push_clip", - "method_name": "push_clip", - "unique_global_name": "push_clip_for_window", - "unique_method_name": "window.push_clip_for_window", + "signature": "drawing_options option_line_width(int width,drawing_options opts);", + "name": "option_line_width", + "method_name": null, + "unique_global_name": "option_line_width_with_options", + "unique_method_name": null, "suffix_name": null, - "description": "Add the clipping rectangle of a window and uses the intersect between\nthe new rectangle and previous clip.\n\nWhen a clipping rectangle is provided, drawing operations will only\naffect the area specified in the current clipping rectangle.", + "description": "Use this option to change the width of line drawings.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "drawing_options", + "description": "Options to draw lines with the indicated width.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "wnd": { - "type": "window", - "description": "The window to add clipping to", + "width": { + "type": "int", + "description": "The new line width for line drawing.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -24660,12 +24310,12 @@ "is_vector": false, "type_parameter": null }, - "r": { - "type": "rectangle", - "description": "The new clipping rectangle", + "opts": { + "type": "drawing_options", + "description": "Values for the other options.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -24675,49 +24325,45 @@ } }, "attributes": { - "class": "window", - "method": "push_clip", - "self": "wnd", - "suffix": "for_window", + "suffix": "with_options", "group": "graphics" }, "signatures": { - "python": [ - "def push_clip_for_window(wnd, r):" - ], "cpp": [ - "void push_clip(window wnd, const rectangle &r)" + "drawing_options option_line_width(int width, drawing_options opts)" + ], + "python": [ + "def option_line_width_with_options(width, opts):" ], "csharp": [ - "public void Window.PushClip(Rectangle r);", - "public static void SplashKit.PushClip(Window wnd, Rectangle r);" + "public static DrawingOptions SplashKit.OptionLineWidth(int width, DrawingOptions opts);" ], "pascal": [ - "procedure PushClip(wnd: Window; const r: Rectangle)" + "function OptionLineWidth(width: Integer; opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "void push_clip(bitmap bmp,const rectangle &r);", - "name": "push_clip", + "signature": "drawing_options option_part_bmp(double x,double y,double w,double h);", + "name": "option_part_bmp", "method_name": null, - "unique_global_name": "push_clip_for_bitmap", + "unique_global_name": "option_part_bmp", "unique_method_name": null, "suffix_name": null, - "description": "Add the clipping rectangle of a bitmap and uses the intersect between\nthe new rectangle and previous clip.\n\nWhen a clipping rectangle is provided, drawing operations will only\naffect the area specified in the current clipping rectangle.", + "description": "Use this option to draw only a part of a bitmap.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "drawing_options", + "description": "Options to draw parts of a bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to add clipping to", + "x": { + "type": "double", + "description": "The x coordinate of the part within the bitmap.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -24728,12 +24374,38 @@ "is_vector": false, "type_parameter": null }, - "r": { - "type": "rectangle", - "description": "The new clipping rectangle", + "y": { + "type": "double", + "description": "The y coordinate of the part within the bitmap.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "w": { + "type": "double", + "description": "The width of the part within the bitmap.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "h": { + "type": "double", + "description": "The height of the part within the bitmap.", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -24743,48 +24415,99 @@ } }, "attributes": { - "suffix": "for_bitmap", "group": "graphics" }, "signatures": { - "python": [ - "def push_clip_for_bitmap(bmp, r):" - ], "cpp": [ - "void push_clip(bitmap bmp, const rectangle &r)" + "drawing_options option_part_bmp(double x, double y, double w, double h)" + ], + "python": [ + "def option_part_bmp(x, y, w, h):" ], "csharp": [ - "public static void SplashKit.PushClip(Bitmap bmp, Rectangle r);" + "public static DrawingOptions SplashKit.OptionPartBmp(double x, double y, double w, double h);" ], "pascal": [ - "procedure PushClip(bmp: Bitmap; const r: Rectangle)" + "function OptionPartBmp(x: Double; y: Double; w: Double; h: Double): DrawingOptions" ] } }, { - "signature": "void push_clip(const rectangle &r);", - "name": "push_clip", + "signature": "drawing_options option_part_bmp(double x,double y,double w,double h,drawing_options opts);", + "name": "option_part_bmp", "method_name": null, - "unique_global_name": "push_clip", + "unique_global_name": "option_part_bmp_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Push a clip rectangle to the current window. The resulting clipping\nrectangle will be the intersection of the existing clipping rectangle\nwith the new rectangle provided in this call. This can be undone using\n`pop_clip`.\n\nWhen a clipping rectangle is provided, drawing operations will only\naffect the area specified in the current clipping rectangle.", + "description": "Use this option to draw only a part of a bitmap.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "drawing_options", + "description": "Options to draw parts of a bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "rectangle", - "description": "The new clipping rectangle", + "x": { + "type": "double", + "description": "The x coordinate of the part within the bitmap.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y coordinate of the part within the bitmap.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "w": { + "type": "double", + "description": "The width of the part within the bitmap.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "h": { + "type": "double", + "description": "The height of the part within the bitmap.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "opts": { + "type": "drawing_options", + "description": "Values for the other options.", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -24794,44 +24517,45 @@ } }, "attributes": { + "suffix": "with_options", "group": "graphics" }, "signatures": { - "python": [ - "def push_clip(r):" - ], "cpp": [ - "void push_clip(const rectangle &r)" + "drawing_options option_part_bmp(double x, double y, double w, double h, drawing_options opts)" + ], + "python": [ + "def option_part_bmp_with_options(x, y, w, h, opts):" ], "csharp": [ - "public static void SplashKit.PushClip(Rectangle r);" + "public static DrawingOptions SplashKit.OptionPartBmp(double x, double y, double w, double h, DrawingOptions opts);" ], "pascal": [ - "procedure PushClip(const r: Rectangle)" + "function OptionPartBmp(x: Double; y: Double; w: Double; h: Double; opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "void reset_clip(bitmap bmp);", - "name": "reset_clip", + "signature": "drawing_options option_part_bmp(rectangle part);", + "name": "option_part_bmp", "method_name": null, - "unique_global_name": "reset_clip_for_bitmap", + "unique_global_name": "option_part_bmp_from_rectangle", "unique_method_name": null, "suffix_name": null, - "description": "Reset the clipping rectangle on a bitmap. This will clear all\nof the clipping rectangles pushed to the bitmap.", + "description": "Use this option to draw only part of a bitmap.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "drawing_options", + "description": "Options to draw parts of a bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to clear the clipping rectangle", + "part": { + "type": "rectangle", + "description": "The rectangle of the part of the bitmap to draw.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -24844,82 +24568,58 @@ } }, "attributes": { - "suffix": "for_bitmap", + "suffix": "from_rectangle", "group": "graphics" }, "signatures": { - "python": [ - "def reset_clip_for_bitmap(bmp):" - ], "cpp": [ - "void reset_clip(bitmap bmp)" - ], - "csharp": [ - "public static void SplashKit.ResetClip(Bitmap bmp);" + "drawing_options option_part_bmp(rectangle part)" ], - "pascal": [ - "procedure ResetClip(bmp: Bitmap)" - ] - } - }, - { - "signature": "void reset_clip();", - "name": "reset_clip", - "method_name": null, - "unique_global_name": "reset_clip", - "unique_method_name": null, - "suffix_name": null, - "description": "Reset the clipping rectangle of the current window. This will clear all\nof the clipping rectangles pushed to the current window.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "graphics" - }, - "signatures": { "python": [ - "def reset_clip():" - ], - "cpp": [ - "void reset_clip()" + "def option_part_bmp_from_rectangle(part):" ], "csharp": [ - "public static void SplashKit.ResetClip();" + "public static DrawingOptions SplashKit.OptionPartBmp(Rectangle part);" ], "pascal": [ - "procedure ResetClip()" + "function OptionPartBmp(part: Rectangle): DrawingOptions" ] } }, { - "signature": "void reset_clip(window wnd);", - "name": "reset_clip", - "method_name": "reset_clip", - "unique_global_name": "reset_clip_for_window", - "unique_method_name": "window.reset_clip_for_window", + "signature": "drawing_options option_part_bmp(rectangle part,drawing_options opts);", + "name": "option_part_bmp", + "method_name": null, + "unique_global_name": "option_part_bmp_from_rectangle_with_options", + "unique_method_name": null, "suffix_name": null, - "description": "Reset the clipping rectangle on a window. This will clear all\nof the clipping rectangles pushed to the window.", + "description": "Use this option to draw only part of a bitmap.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "drawing_options", + "description": "Options to draw parts of a bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "wnd": { - "type": "window", - "description": "The window to clear the clipping rectangle", + "part": { + "type": "rectangle", + "description": "The rectangle of the part of the bitmap to draw.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "opts": { + "type": "drawing_options", + "description": "Values for the other options.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -24932,52 +24632,48 @@ } }, "attributes": { - "class": "window", - "method": "reset_clip", - "self": "wnd", - "suffix": "for_window", + "suffix": "from_rectangle_with_options", "group": "graphics" }, "signatures": { - "python": [ - "def reset_clip_for_window(wnd):" - ], "cpp": [ - "void reset_clip(window wnd)" + "drawing_options option_part_bmp(rectangle part, drawing_options opts)" + ], + "python": [ + "def option_part_bmp_from_rectangle_with_options(part, opts):" ], "csharp": [ - "public void Window.ResetClip();", - "public static void SplashKit.ResetClip(Window wnd);" + "public static DrawingOptions SplashKit.OptionPartBmp(Rectangle part, DrawingOptions opts);" ], "pascal": [ - "procedure ResetClip(wnd: Window)" + "function OptionPartBmp(part: Rectangle; opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "void set_clip(const rectangle &r);", - "name": "set_clip", + "signature": "drawing_options option_rotate_bmp(double angle);", + "name": "option_rotate_bmp", "method_name": null, - "unique_global_name": "set_clip", + "unique_global_name": "option_rotate_bmp", "unique_method_name": null, "suffix_name": null, - "description": "Set the clip rectangle of the current window. This will clear any\nexisting clipping rectangles pushed to the current window, and use the\nsupplied rectangle for clipping.", + "description": "Use this option to rotate a bitmap around its centre point.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "drawing_options", + "description": "Options that will rotate bitmaps around its center point.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "rectangle", - "description": "The new clipping rectangle", + "angle": { + "type": "double", + "description": "The angle to rotate bitmaps.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -24990,41 +24686,41 @@ "group": "graphics" }, "signatures": { - "python": [ - "def set_clip(r):" - ], "cpp": [ - "void set_clip(const rectangle &r)" + "drawing_options option_rotate_bmp(double angle)" + ], + "python": [ + "def option_rotate_bmp(angle):" ], "csharp": [ - "public static void SplashKit.SetClip(Rectangle r);" + "public static DrawingOptions SplashKit.OptionRotateBmp(double angle);" ], "pascal": [ - "procedure SetClip(const r: Rectangle)" + "function OptionRotateBmp(angle: Double): DrawingOptions" ] } }, { - "signature": "void set_clip(bitmap bmp,const rectangle &r);", - "name": "set_clip", + "signature": "drawing_options option_rotate_bmp(double angle,double anchor_x,double anchor_y);", + "name": "option_rotate_bmp", "method_name": null, - "unique_global_name": "set_clip_for_bitmap", + "unique_global_name": "option_rotate_bmp_with_anchor", "unique_method_name": null, "suffix_name": null, - "description": "Set the clip rectangle of the bitmap. This will clear any existing\nclipping rectangles pushed to the bitmap, and use the supplied rectangle\nfor clipping.", + "description": "Use this option to rotate the drawing of a bitmap. This allows you to set the\nanchor point and rotate around that by a number of degrees.\nPass opts the other options you want use.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "drawing_options", + "description": "Options that will rotate bitmaps around an anchor point.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to change", + "angle": { + "type": "double", + "description": "The angle to rotate bitmaps.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25035,12 +24731,25 @@ "is_vector": false, "type_parameter": null }, - "r": { - "type": "rectangle", - "description": "The new clipping rectangle", + "anchor_x": { + "type": "double", + "description": "The x location of the anchor within the bitmap", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "anchor_y": { + "type": "double", + "description": "The y location of the anchor within the bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -25050,45 +24759,45 @@ } }, "attributes": { - "suffix": "for_bitmap", + "suffix": "with_anchor", "group": "graphics" }, "signatures": { - "python": [ - "def set_clip_for_bitmap(bmp, r):" - ], "cpp": [ - "void set_clip(bitmap bmp, const rectangle &r)" + "drawing_options option_rotate_bmp(double angle, double anchor_x, double anchor_y)" + ], + "python": [ + "def option_rotate_bmp_with_anchor(angle, anchor_x, anchor_y):" ], "csharp": [ - "public static void SplashKit.SetClip(Bitmap bmp, Rectangle r);" + "public static DrawingOptions SplashKit.OptionRotateBmp(double angle, double anchorX, double anchorY);" ], "pascal": [ - "procedure SetClip(bmp: Bitmap; const r: Rectangle)" + "function OptionRotateBmp(angle: Double; anchorX: Double; anchorY: Double): DrawingOptions" ] } }, { - "signature": "void set_clip(window wnd,const rectangle &r);", - "name": "set_clip", - "method_name": "set_clip", - "unique_global_name": "set_clip_for_window", - "unique_method_name": "window.set_clip_for_window", + "signature": "drawing_options option_rotate_bmp(double angle,double anchor_x,double anchor_y,drawing_options opts);", + "name": "option_rotate_bmp", + "method_name": null, + "unique_global_name": "option_rotate_bmp_with_anchor_and_options", + "unique_method_name": null, "suffix_name": null, - "description": "Set the clip rectangle of the window. This will clear any existing\nclipping rectangles pushed to the window, and use the supplied rectangle\nfor clipping.", + "description": "Use this option to rotate the drawing of a bitmap. This allows you to set the\nanchor point and rotate around that by a number of degrees.\nPass opts the other options you want use.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "drawing_options", + "description": "Options that will rotate bitmaps around an anchor point.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "wnd": { - "type": "window", - "description": "The window to change", + "angle": { + "type": "double", + "description": "The angle to rotate bitmaps.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25099,12 +24808,38 @@ "is_vector": false, "type_parameter": null }, - "r": { - "type": "rectangle", - "description": "The new clipping rectangle", + "anchor_x": { + "type": "double", + "description": "The x location of the anchor within the bitmap", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "anchor_y": { + "type": "double", + "description": "The y location of the anchor within the bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "opts": { + "type": "drawing_options", + "description": "Values for the other options.", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -25114,86 +24849,58 @@ } }, "attributes": { - "class": "window", - "method": "set_clip", - "self": "wnd", - "suffix": "for_window", + "suffix": "with_anchor_and_options", "group": "graphics" }, "signatures": { - "python": [ - "def set_clip_for_window(wnd, r):" - ], "cpp": [ - "void set_clip(window wnd, const rectangle &r)" - ], - "csharp": [ - "public void Window.SetClip(Rectangle r);", - "public static void SplashKit.SetClip(Window wnd, Rectangle r);" + "drawing_options option_rotate_bmp(double angle, double anchor_x, double anchor_y, drawing_options opts)" ], - "pascal": [ - "procedure SetClip(wnd: Window; const r: Rectangle)" - ] - } - }, - { - "signature": "drawing_options option_defaults();", - "name": "option_defaults", - "method_name": null, - "unique_global_name": "option_defaults", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns a `drawing_options` with default values.\nThis will draw to the current window, with default scale of 1, no\nrotation or offset, not flipped, drawing whole images, with default\ncamera mechanisms and line width.", - "brief": null, - "return": { - "type": "drawing_options", - "description": "A default drawing options.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "graphics" - }, - "signatures": { "python": [ - "def option_defaults():" - ], - "cpp": [ - "drawing_options option_defaults()" + "def option_rotate_bmp_with_anchor_and_options(angle, anchor_x, anchor_y, opts):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionDefaults();" + "public static DrawingOptions SplashKit.OptionRotateBmp(double angle, double anchorX, double anchorY, DrawingOptions opts);" ], "pascal": [ - "function OptionDefaults(): DrawingOptions" + "function OptionRotateBmp(angle: Double; anchorX: Double; anchorY: Double; opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "drawing_options option_draw_to(bitmap dest);", - "name": "option_draw_to", + "signature": "drawing_options option_rotate_bmp(double angle,drawing_options opts);", + "name": "option_rotate_bmp", "method_name": null, - "unique_global_name": "option_draw_to_bitmap", + "unique_global_name": "option_rotate_bmp_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Use this option to draw to a Bitmap. Pass dest the Bitmap you want to draw on.", + "description": "Use this option to rotate a bitmap around its centre point.", "brief": null, "return": { "type": "drawing_options", - "description": "Drawing options that will draw onto a bitmap.", + "description": "Options that will rotate bitmaps around its center point.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "dest": { - "type": "bitmap", - "description": "The bitmap to draw to.", + "angle": { + "type": "double", + "description": "The angle to rotate bitmaps.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "opts": { + "type": "drawing_options", + "description": "Values for the other options.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25206,45 +24913,45 @@ } }, "attributes": { - "suffix": "bitmap", + "suffix": "with_options", "group": "graphics" }, "signatures": { - "python": [ - "def option_draw_to_bitmap(dest):" - ], "cpp": [ - "drawing_options option_draw_to(bitmap dest)" + "drawing_options option_rotate_bmp(double angle, drawing_options opts)" + ], + "python": [ + "def option_rotate_bmp_with_options(angle, opts):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionDrawTo(Bitmap dest);" + "public static DrawingOptions SplashKit.OptionRotateBmp(double angle, DrawingOptions opts);" ], "pascal": [ - "function OptionDrawTo(dest: Bitmap): DrawingOptions" + "function OptionRotateBmp(angle: Double; opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "drawing_options option_draw_to(bitmap dest,drawing_options opts);", - "name": "option_draw_to", + "signature": "drawing_options option_scale_bmp(double scale_x,double scale_y);", + "name": "option_scale_bmp", "method_name": null, - "unique_global_name": "option_draw_to_bitmap_with_options", + "unique_global_name": "option_scale_bmp", "unique_method_name": null, "suffix_name": null, - "description": "Use this option to draw to a Bitmap. Pass dest the Bitmap you want to draw on.\nPass opts the other options you want use.", + "description": "Use this option to scale the drawing of bitmaps. You can scale x and y separately.", "brief": null, "return": { "type": "drawing_options", - "description": "Drawing options that will draw onto a bitmap.", + "description": "Options that will scale bitmaps along the x,y axis.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "dest": { - "type": "bitmap", - "description": "The bitmap to draw to.", + "scale_x": { + "type": "double", + "description": "The amount to scale bitmaps aalong the x axis", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25255,9 +24962,9 @@ "is_vector": false, "type_parameter": null }, - "opts": { - "type": "drawing_options", - "description": "Values for the other options.", + "scale_y": { + "type": "double", + "description": "The amount to scale bitmaps aalong the y axis", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25270,45 +24977,44 @@ } }, "attributes": { - "suffix": "bitmap_with_options", "group": "graphics" }, "signatures": { - "python": [ - "def option_draw_to_bitmap_with_options(dest, opts):" - ], "cpp": [ - "drawing_options option_draw_to(bitmap dest, drawing_options opts)" + "drawing_options option_scale_bmp(double scale_x, double scale_y)" + ], + "python": [ + "def option_scale_bmp(scale_x, scale_y):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionDrawTo(Bitmap dest, DrawingOptions opts);" + "public static DrawingOptions SplashKit.OptionScaleBmp(double scaleX, double scaleY);" ], "pascal": [ - "function OptionDrawTo(dest: Bitmap; opts: DrawingOptions): DrawingOptions" + "function OptionScaleBmp(scaleX: Double; scaleY: Double): DrawingOptions" ] } }, { - "signature": "drawing_options option_draw_to(window dest);", - "name": "option_draw_to", - "method_name": "option_draw_to", - "unique_global_name": "option_draw_to_window", - "unique_method_name": "window.option_draw_to_window", + "signature": "drawing_options option_scale_bmp(double scale_x,double scale_y,drawing_options opts);", + "name": "option_scale_bmp", + "method_name": null, + "unique_global_name": "option_scale_bmp_with_options", + "unique_method_name": null, "suffix_name": null, - "description": "Use this option to draw to a specified Window. Pass dest the Window you want to draw on.", + "description": "Use this option to scale the drawing of bitmaps. You can scale x and y separately.\nPass opts the other options you want use.", "brief": null, "return": { "type": "drawing_options", - "description": "A drawing option that will draw to the indicated window.", + "description": "Options that will scale bitmaps along the x,y axis.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "dest": { - "type": "window", - "description": "The window to draw onto.", + "scale_x": { + "type": "double", + "description": "The amount to scale bitmaps aalong the x axis", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25318,52 +25024,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "window", - "method": "option_draw_to", - "self": "dest", - "suffix": "window", - "group": "graphics" - }, - "signatures": { - "python": [ - "def option_draw_to_window(dest):" - ], - "cpp": [ - "drawing_options option_draw_to(window dest)" - ], - "csharp": [ - "public DrawingOptions Window.OptionDrawTo();", - "public static DrawingOptions SplashKit.OptionDrawTo(Window dest);" - ], - "pascal": [ - "function OptionDrawTo(dest: Window): DrawingOptions" - ] - } - }, - { - "signature": "drawing_options option_draw_to(window dest,drawing_options opts);", - "name": "option_draw_to", - "method_name": "option_draw_to", - "unique_global_name": "option_draw_to_window_with_options", - "unique_method_name": "window.option_draw_to_window_with_options", - "suffix_name": null, - "description": "Use this option to draw to a Bitmap. Pass dest the Bitmap you want to draw on to.\nPass opts the other options you want use.", - "brief": null, - "return": { - "type": "drawing_options", - "description": "A drawing option that will draw to the indicated window.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "dest": { - "type": "window", - "description": "The window to draw onto.", + }, + "scale_y": { + "type": "double", + "description": "The amount to scale bitmaps aalong the y axis", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25389,40 +25053,36 @@ } }, "attributes": { - "class": "window", - "method": "option_draw_to", - "self": "dest", - "suffix": "window_with_options", + "suffix": "with_options", "group": "graphics" }, "signatures": { - "python": [ - "def option_draw_to_window_with_options(dest, opts):" - ], "cpp": [ - "drawing_options option_draw_to(window dest, drawing_options opts)" + "drawing_options option_scale_bmp(double scale_x, double scale_y, drawing_options opts)" + ], + "python": [ + "def option_scale_bmp_with_options(scale_x, scale_y, opts):" ], "csharp": [ - "public DrawingOptions Window.OptionDrawTo(DrawingOptions opts);", - "public static DrawingOptions SplashKit.OptionDrawTo(Window dest, DrawingOptions opts);" + "public static DrawingOptions SplashKit.OptionScaleBmp(double scaleX, double scaleY, DrawingOptions opts);" ], "pascal": [ - "function OptionDrawTo(dest: Window; opts: DrawingOptions): DrawingOptions" + "function OptionScaleBmp(scaleX: Double; scaleY: Double; opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "drawing_options option_flip_x();", - "name": "option_flip_x", + "signature": "drawing_options option_to_screen();", + "name": "option_to_screen", "method_name": null, - "unique_global_name": "option_flip_x", + "unique_global_name": "option_to_screen", "unique_method_name": null, "suffix_name": null, - "description": "Use this option to flip an image along its X axis.", + "description": "Use this option to draw to the screen, ignoring the positon of the\ncamera.", "brief": null, "return": { "type": "drawing_options", - "description": "Options that will flip bitmaps horizontally.", + "description": "Options that will draw to the surface without camera effects.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -25434,32 +25094,32 @@ "group": "graphics" }, "signatures": { - "python": [ - "def option_flip_x():" - ], "cpp": [ - "drawing_options option_flip_x()" + "drawing_options option_to_screen()" + ], + "python": [ + "def option_to_screen():" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionFlipX();" + "public static DrawingOptions SplashKit.OptionToScreen();" ], "pascal": [ - "function OptionFlipX(): DrawingOptions" + "function OptionToScreen(): DrawingOptions" ] } }, { - "signature": "drawing_options option_flip_x(drawing_options opts);", - "name": "option_flip_x", + "signature": "drawing_options option_to_screen(drawing_options opts);", + "name": "option_to_screen", "method_name": null, - "unique_global_name": "option_flip_x_with_options", + "unique_global_name": "option_to_screen_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Use this option to flip an image along its X axis.", + "description": "Use this option to draw to the screen, ignoring the positon of the\ncamera.", "brief": null, "return": { "type": "drawing_options", - "description": "Options that will flip bitmaps horizontally.", + "description": "Options that will draw to the surface without camera effects.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -25485,32 +25145,32 @@ "group": "graphics" }, "signatures": { - "python": [ - "def option_flip_x_with_options(opts):" - ], "cpp": [ - "drawing_options option_flip_x(drawing_options opts)" + "drawing_options option_to_screen(drawing_options opts)" + ], + "python": [ + "def option_to_screen_with_options(opts):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionFlipX(DrawingOptions opts);" + "public static DrawingOptions SplashKit.OptionToScreen(DrawingOptions opts);" ], "pascal": [ - "function OptionFlipX(opts: DrawingOptions): DrawingOptions" + "function OptionToScreen(opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "drawing_options option_flip_xy();", - "name": "option_flip_xy", + "signature": "drawing_options option_to_world();", + "name": "option_to_world", "method_name": null, - "unique_global_name": "option_flip_xy", + "unique_global_name": "option_to_world", "unique_method_name": null, "suffix_name": null, - "description": "Use this option to flip the drawing of an image along both X and Y axis.", + "description": "Use this option to draw in World coordinates -- these are affected by\nthe movement of the camera.", "brief": null, "return": { "type": "drawing_options", - "description": "Options that flip bitmap drawing both vertically and\nhorizontally.", + "description": "Options that will draw with camera effects.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -25522,32 +25182,32 @@ "group": "graphics" }, "signatures": { - "python": [ - "def option_flip_xy():" - ], "cpp": [ - "drawing_options option_flip_xy()" + "drawing_options option_to_world()" + ], + "python": [ + "def option_to_world():" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionFlipXy();" + "public static DrawingOptions SplashKit.OptionToWorld();" ], "pascal": [ - "function OptionFlipXy(): DrawingOptions" + "function OptionToWorld(): DrawingOptions" ] } }, { - "signature": "drawing_options option_flip_xy(drawing_options opts);", - "name": "option_flip_xy", + "signature": "drawing_options option_to_world(drawing_options opts);", + "name": "option_to_world", "method_name": null, - "unique_global_name": "option_flip_xy_with_options", + "unique_global_name": "option_to_world_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Use this option to flip the drawing of an image along both X and Y axis.", + "description": "Use this option to draw in World coordinates -- these are affected by\nthe movement of the camera.", "brief": null, "return": { "type": "drawing_options", - "description": "Options that flip bitmap drawing both vertically and\nhorizontally.", + "description": "Options that will draw with camera effects.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -25573,78 +25233,104 @@ "group": "graphics" }, "signatures": { - "python": [ - "def option_flip_xy_with_options(opts):" - ], "cpp": [ - "drawing_options option_flip_xy(drawing_options opts)" + "drawing_options option_to_world(drawing_options opts)" + ], + "python": [ + "def option_to_world_with_options(opts):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionFlipXy(DrawingOptions opts);" + "public static DrawingOptions SplashKit.OptionToWorld(DrawingOptions opts);" ], "pascal": [ - "function OptionFlipXy(opts: DrawingOptions): DrawingOptions" + "function OptionToWorld(opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "drawing_options option_flip_y();", - "name": "option_flip_y", + "signature": "drawing_options option_with_animation(animation anim);", + "name": "option_with_animation", "method_name": null, - "unique_global_name": "option_flip_y", + "unique_global_name": "option_with_animation", "unique_method_name": null, "suffix_name": null, - "description": "Use this option to flip the drawing of an image along its Y axis.", + "description": "Use details from the animation to select an appropriate cell from the\nbitmaps being drawn.", "brief": null, "return": { "type": "drawing_options", - "description": "Options that will flip bitmaps vertically.", + "description": "A drawing option that will draw the current cell from the\nanimation.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "anim": { + "type": "animation", + "description": "The animation with the cell details to be used.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { "group": "graphics" }, "signatures": { - "python": [ - "def option_flip_y():" - ], "cpp": [ - "drawing_options option_flip_y()" + "drawing_options option_with_animation(animation anim)" + ], + "python": [ + "def option_with_animation(anim):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionFlipY();" + "public static DrawingOptions SplashKit.OptionWithAnimation(Animation anim);" ], "pascal": [ - "function OptionFlipY(): DrawingOptions" + "function OptionWithAnimation(anim: Animation): DrawingOptions" ] } }, { - "signature": "drawing_options option_flip_y(drawing_options opts);", - "name": "option_flip_y", + "signature": "drawing_options option_with_animation(animation anim,drawing_options opts);", + "name": "option_with_animation", "method_name": null, - "unique_global_name": "option_flip_y_with_options", + "unique_global_name": "option_with_animation_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Use this option to flip the drawing of an image along its Y axis.", + "description": "Use details from the animation to select an appropriate cell from the\nbitmaps being drawn. This extends the passed in drawing options with\nthe animation details.", "brief": null, "return": { "type": "drawing_options", - "description": "Options that will flip bitmaps vertically.", + "description": "A drawing option that will draw the current cell from the\nanimation.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "anim": { + "type": "animation", + "description": "The animation with the cell details to be used.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "opts": { "type": "drawing_options", - "description": "Values for the other options.", + "description": "The existing options to extend.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25661,41 +25347,41 @@ "group": "graphics" }, "signatures": { - "python": [ - "def option_flip_y_with_options(opts):" - ], "cpp": [ - "drawing_options option_flip_y(drawing_options opts)" + "drawing_options option_with_animation(animation anim, drawing_options opts)" + ], + "python": [ + "def option_with_animation_with_options(anim, opts):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionFlipY(DrawingOptions opts);" + "public static DrawingOptions SplashKit.OptionWithAnimation(Animation anim, DrawingOptions opts);" ], "pascal": [ - "function OptionFlipY(opts: DrawingOptions): DrawingOptions" + "function OptionWithAnimation(anim: Animation; opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "drawing_options option_line_width(int width);", - "name": "option_line_width", + "signature": "drawing_options option_with_bitmap_cell(int cell);", + "name": "option_with_bitmap_cell", "method_name": null, - "unique_global_name": "option_line_width", + "unique_global_name": "option_with_bitmap_cell", "unique_method_name": null, "suffix_name": null, - "description": "Use this option to change the width of line drawings.", + "description": "When drawing the bitmap this will only draw the cell. To use this the bitmap\nneeds to have been provided with its cell details (see `bitmap_set_cell_details`).\nThis option overrides the animation or part drawing options.", "brief": null, "return": { "type": "drawing_options", - "description": "Options to draw lines with the indicated width.", + "description": "A drawing option that will draw the selected cell.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "width": { + "cell": { "type": "int", - "description": "The new line width for line drawing.", + "description": "The cell to draw from the bitmap (-1 for entire bitmap)", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25711,41 +25397,41 @@ "group": "graphics" }, "signatures": { - "python": [ - "def option_line_width(width):" - ], "cpp": [ - "drawing_options option_line_width(int width)" + "drawing_options option_with_bitmap_cell(int cell)" + ], + "python": [ + "def option_with_bitmap_cell(cell):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionLineWidth(int width);" + "public static DrawingOptions SplashKit.OptionWithBitmapCell(int cell);" ], "pascal": [ - "function OptionLineWidth(width: Integer): DrawingOptions" + "function OptionWithBitmapCell(cell: Integer): DrawingOptions" ] } }, { - "signature": "drawing_options option_line_width(int width,drawing_options opts);", - "name": "option_line_width", + "signature": "drawing_options option_with_bitmap_cell(int cell,drawing_options opts);", + "name": "option_with_bitmap_cell", "method_name": null, - "unique_global_name": "option_line_width_with_options", + "unique_global_name": "option_with_bitmap_cell_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Use this option to change the width of line drawings.", + "description": "When drawing the bitmap this will only draw the cell. To use this the bitmap\nneeds to have been provided with its cell details (see `bitmap_set_cell_details`).\nThis option overrides the animation or part drawing options. This extends\nthe passed in drawing options with the cell details.", "brief": null, "return": { "type": "drawing_options", - "description": "Options to draw lines with the indicated width.", + "description": "A drawing option that will draw the selected cell.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "width": { + "cell": { "type": "int", - "description": "The new line width for line drawing.", + "description": "The cell to draw from the bitmap (-1 for entire bitmap)", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25758,7 +25444,7 @@ }, "opts": { "type": "drawing_options", - "description": "Values for the other options.", + "description": "The existing options to extend.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25775,41 +25461,41 @@ "group": "graphics" }, "signatures": { - "python": [ - "def option_line_width_with_options(width, opts):" - ], "cpp": [ - "drawing_options option_line_width(int width, drawing_options opts)" + "drawing_options option_with_bitmap_cell(int cell, drawing_options opts)" + ], + "python": [ + "def option_with_bitmap_cell_with_options(cell, opts):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionLineWidth(int width, DrawingOptions opts);" + "public static DrawingOptions SplashKit.OptionWithBitmapCell(int cell, DrawingOptions opts);" ], "pascal": [ - "function OptionLineWidth(width: Integer; opts: DrawingOptions): DrawingOptions" + "function OptionWithBitmapCell(cell: Integer; opts: DrawingOptions): DrawingOptions" ] } }, { - "signature": "drawing_options option_part_bmp(double x,double y,double w,double h);", - "name": "option_part_bmp", + "signature": "void draw_ellipse(color clr,const rectangle rect);", + "name": "draw_ellipse", "method_name": null, - "unique_global_name": "option_part_bmp", + "unique_global_name": "draw_ellipse_within_rectangle", "unique_method_name": null, "suffix_name": null, - "description": "Use this option to draw only a part of a bitmap.", + "description": "Draws an ellipse using the provided location, and size.", "brief": null, "return": { - "type": "drawing_options", - "description": "Options to draw parts of a bitmap.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "x": { - "type": "double", - "description": "The x coordinate of the part within the bitmap.", + "clr": { + "type": "color", + "description": "The color of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25820,9 +25506,60 @@ "is_vector": false, "type_parameter": null }, - "y": { - "type": "double", - "description": "The y coordinate of the part within the bitmap.", + "rect": { + "type": "rectangle", + "description": "Indicates the location and size of the ellipse", + "is_pointer": false, + "is_const": true, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } + }, + "attributes": { + "suffix": "within_rectangle", + "group": "graphics" + }, + "signatures": { + "cpp": [ + "void draw_ellipse(color clr, const rectangle rect)" + ], + "python": [ + "def draw_ellipse_within_rectangle(clr, rect):" + ], + "csharp": [ + "public static void SplashKit.DrawEllipse(Color clr, Rectangle rect);" + ], + "pascal": [ + "procedure DrawEllipse(clr: Color; rect: Rectangle)" + ] + } + }, + { + "signature": "void draw_ellipse(color clr,const rectangle rect,drawing_options opts);", + "name": "draw_ellipse", + "method_name": null, + "unique_global_name": "draw_ellipse_within_rectangle_with_options", + "unique_method_name": null, + "suffix_name": null, + "description": "Draws an ellipse using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "clr": { + "type": "color", + "description": "The color of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25833,11 +25570,11 @@ "is_vector": false, "type_parameter": null }, - "w": { - "type": "double", - "description": "The width of the part within the bitmap.", + "rect": { + "type": "rectangle", + "description": "Indicates the location and size of the ellipse", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -25846,9 +25583,9 @@ "is_vector": false, "type_parameter": null }, - "h": { - "type": "double", - "description": "The height of the part within the bitmap.", + "opts": { + "type": "drawing_options", + "description": "The drawing options", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25861,44 +25598,45 @@ } }, "attributes": { + "suffix": "within_rectangle_with_options", "group": "graphics" }, "signatures": { - "python": [ - "def option_part_bmp(x, y, w, h):" - ], "cpp": [ - "drawing_options option_part_bmp(double x, double y, double w, double h)" + "void draw_ellipse(color clr, const rectangle rect, drawing_options opts)" + ], + "python": [ + "def draw_ellipse_within_rectangle_with_options(clr, rect, opts):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionPartBmp(double x, double y, double w, double h);" + "public static void SplashKit.DrawEllipse(Color clr, Rectangle rect, DrawingOptions opts);" ], "pascal": [ - "function OptionPartBmp(x: Double; y: Double; w: Double; h: Double): DrawingOptions" + "procedure DrawEllipse(clr: Color; rect: Rectangle; opts: DrawingOptions)" ] } }, { - "signature": "drawing_options option_part_bmp(double x,double y,double w,double h,drawing_options opts);", - "name": "option_part_bmp", + "signature": "void draw_ellipse(color clr,double x,double y,double width,double height);", + "name": "draw_ellipse", "method_name": null, - "unique_global_name": "option_part_bmp_with_options", + "unique_global_name": "draw_ellipse", "unique_method_name": null, "suffix_name": null, - "description": "Use this option to draw only a part of a bitmap.", + "description": "Draws an ellipse using the provided location, and size.", "brief": null, "return": { - "type": "drawing_options", - "description": "Options to draw parts of a bitmap.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "x": { - "type": "double", - "description": "The x coordinate of the part within the bitmap.", + "clr": { + "type": "color", + "description": "The color of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25909,9 +25647,9 @@ "is_vector": false, "type_parameter": null }, - "y": { + "x": { "type": "double", - "description": "The y coordinate of the part within the bitmap.", + "description": "The distance from the left of the bitmap or window to the\nleft edge of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25922,9 +25660,9 @@ "is_vector": false, "type_parameter": null }, - "w": { + "y": { "type": "double", - "description": "The width of the part within the bitmap.", + "description": "The distance from the top of the bitmap or window to the\ntop edge of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25935,9 +25673,9 @@ "is_vector": false, "type_parameter": null }, - "h": { + "width": { "type": "double", - "description": "The height of the part within the bitmap.", + "description": "The width of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25948,9 +25686,9 @@ "is_vector": false, "type_parameter": null }, - "opts": { - "type": "drawing_options", - "description": "Values for the other options.", + "height": { + "type": "double", + "description": "The height of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -25963,45 +25701,44 @@ } }, "attributes": { - "suffix": "with_options", "group": "graphics" }, "signatures": { - "python": [ - "def option_part_bmp_with_options(x, y, w, h, opts):" - ], "cpp": [ - "drawing_options option_part_bmp(double x, double y, double w, double h, drawing_options opts)" + "void draw_ellipse(color clr, double x, double y, double width, double height)" + ], + "python": [ + "def draw_ellipse(clr, x, y, width, height):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionPartBmp(double x, double y, double w, double h, DrawingOptions opts);" + "public static void SplashKit.DrawEllipse(Color clr, double x, double y, double width, double height);" ], "pascal": [ - "function OptionPartBmp(x: Double; y: Double; w: Double; h: Double; opts: DrawingOptions): DrawingOptions" + "procedure DrawEllipse(clr: Color; x: Double; y: Double; width: Double; height: Double)" ] } }, { - "signature": "drawing_options option_part_bmp(rectangle part);", - "name": "option_part_bmp", + "signature": "void draw_ellipse(color clr,double x,double y,double width,double height,drawing_options opts);", + "name": "draw_ellipse", "method_name": null, - "unique_global_name": "option_part_bmp_from_rectangle", + "unique_global_name": "draw_ellipse_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Use this option to draw only part of a bitmap.", + "description": "Draws an ellipse using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", "brief": null, "return": { - "type": "drawing_options", - "description": "Options to draw parts of a bitmap.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "part": { - "type": "rectangle", - "description": "The rectangle of the part of the bitmap to draw.", + "clr": { + "type": "color", + "description": "The color of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26011,48 +25748,49 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "suffix": "from_rectangle", - "group": "graphics" - }, - "signatures": { - "python": [ - "def option_part_bmp_from_rectangle(part):" - ], - "cpp": [ - "drawing_options option_part_bmp(rectangle part)" - ], - "csharp": [ - "public static DrawingOptions SplashKit.OptionPartBmp(Rectangle part);" - ], - "pascal": [ - "function OptionPartBmp(part: Rectangle): DrawingOptions" - ] - } - }, - { - "signature": "drawing_options option_part_bmp(rectangle part,drawing_options opts);", - "name": "option_part_bmp", - "method_name": null, - "unique_global_name": "option_part_bmp_from_rectangle_with_options", - "unique_method_name": null, - "suffix_name": null, - "description": "Use this option to draw only part of a bitmap.", - "brief": null, - "return": { - "type": "drawing_options", - "description": "Options to draw parts of a bitmap.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "part": { - "type": "rectangle", - "description": "The rectangle of the part of the bitmap to draw.", + }, + "x": { + "type": "double", + "description": "The distance from the left of the bitmap or window to the\nleft edge of the ellipse", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The distance from the top of the bitmap or window to the\ntop edge of the ellipse", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "width": { + "type": "double", + "description": "The width of the ellipse", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "height": { + "type": "double", + "description": "The height of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26065,7 +25803,7 @@ }, "opts": { "type": "drawing_options", - "description": "Values for the other options.", + "description": "The drawing options", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26078,95 +25816,126 @@ } }, "attributes": { - "suffix": "from_rectangle_with_options", + "suffix": "with_options", "group": "graphics" }, "signatures": { - "python": [ - "def option_part_bmp_from_rectangle_with_options(part, opts):" - ], "cpp": [ - "drawing_options option_part_bmp(rectangle part, drawing_options opts)" + "void draw_ellipse(color clr, double x, double y, double width, double height, drawing_options opts)" + ], + "python": [ + "def draw_ellipse_with_options(clr, x, y, width, height, opts):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionPartBmp(Rectangle part, DrawingOptions opts);" + "public static void SplashKit.DrawEllipse(Color clr, double x, double y, double width, double height, DrawingOptions opts);" ], "pascal": [ - "function OptionPartBmp(part: Rectangle; opts: DrawingOptions): DrawingOptions" + "procedure DrawEllipse(clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)" ] } }, { - "signature": "drawing_options option_rotate_bmp(double angle);", - "name": "option_rotate_bmp", - "method_name": null, - "unique_global_name": "option_rotate_bmp", - "unique_method_name": null, + "signature": "void draw_ellipse_on_bitmap(bitmap destination,color clr,const rectangle rect);", + "name": "draw_ellipse_on_bitmap", + "method_name": "draw_ellipse", + "unique_global_name": "draw_ellipse_on_bitmap_within_rectangle", + "unique_method_name": "bitmap.draw_ellipse_within_rectangle", "suffix_name": null, - "description": "Use this option to rotate a bitmap around its centre point.", + "description": "Draws an ellipse on the given bitmap, using the provided location, and size.", "brief": null, "return": { - "type": "drawing_options", - "description": "Options that will rotate bitmaps around its center point.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "angle": { - "type": "double", - "description": "The angle to rotate bitmaps.", + "destination": { + "type": "bitmap", + "description": "the bitmap to draw the ellipse on", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "clr": { + "type": "color", + "description": "The color of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "rect": { + "type": "rectangle", + "description": "Indicates the location and size of the ellipse", + "is_pointer": false, + "is_const": true, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { - "group": "graphics" + "class": "bitmap", + "method": "draw_ellipse", + "suffix": "within_rectangle", + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def option_rotate_bmp(angle):" - ], "cpp": [ - "drawing_options option_rotate_bmp(double angle)" + "void draw_ellipse_on_bitmap(bitmap destination, color clr, const rectangle rect)" + ], + "python": [ + "def draw_ellipse_on_bitmap_within_rectangle(destination, clr, rect):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionRotateBmp(double angle);" + "public void Bitmap.DrawEllipse(Color clr, Rectangle rect);", + "public static void SplashKit.DrawEllipseOnBitmap(Bitmap destination, Color clr, Rectangle rect);" ], "pascal": [ - "function OptionRotateBmp(angle: Double): DrawingOptions" + "procedure DrawEllipseOnBitmap(destination: Bitmap; clr: Color; rect: Rectangle)" ] } }, { - "signature": "drawing_options option_rotate_bmp(double angle,double anchor_x,double anchor_y);", - "name": "option_rotate_bmp", - "method_name": null, - "unique_global_name": "option_rotate_bmp_with_anchor", - "unique_method_name": null, + "signature": "void draw_ellipse_on_bitmap(bitmap destination,color clr,const rectangle rect,drawing_options opts);", + "name": "draw_ellipse_on_bitmap", + "method_name": "draw_ellipse", + "unique_global_name": "draw_ellipse_on_bitmap_within_rectangle_with_options", + "unique_method_name": "bitmap.draw_ellipse_within_rectangle_with_options", "suffix_name": null, - "description": "Use this option to rotate the drawing of a bitmap. This allows you to set the\nanchor point and rotate around that by a number of degrees.\nPass opts the other options you want use.", + "description": "Draws an ellipse on the given bitmap, using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", "brief": null, "return": { - "type": "drawing_options", - "description": "Options that will rotate bitmaps around an anchor point.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "angle": { - "type": "double", - "description": "The angle to rotate bitmaps.", + "destination": { + "type": "bitmap", + "description": "the bitmap to draw the ellipse on", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26177,9 +25946,9 @@ "is_vector": false, "type_parameter": null }, - "anchor_x": { - "type": "double", - "description": "The x location of the anchor within the bitmap", + "clr": { + "type": "color", + "description": "The color of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26190,9 +25959,22 @@ "is_vector": false, "type_parameter": null }, - "anchor_y": { - "type": "double", - "description": "The y location of the anchor within the bitmap", + "rect": { + "type": "rectangle", + "description": "Indicates the location and size of the ellipse", + "is_pointer": false, + "is_const": true, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "opts": { + "type": "drawing_options", + "description": "The drawing options", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26205,45 +25987,75 @@ } }, "attributes": { - "suffix": "with_anchor", - "group": "graphics" + "class": "bitmap", + "method": "draw_ellipse", + "suffix": "within_rectangle_with_options", + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def option_rotate_bmp_with_anchor(angle, anchor_x, anchor_y):" - ], "cpp": [ - "drawing_options option_rotate_bmp(double angle, double anchor_x, double anchor_y)" + "void draw_ellipse_on_bitmap(bitmap destination, color clr, const rectangle rect, drawing_options opts)" + ], + "python": [ + "def draw_ellipse_on_bitmap_within_rectangle_with_options(destination, clr, rect, opts):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionRotateBmp(double angle, double anchorX, double anchorY);" + "public void Bitmap.DrawEllipse(Color clr, Rectangle rect, DrawingOptions opts);", + "public static void SplashKit.DrawEllipseOnBitmap(Bitmap destination, Color clr, Rectangle rect, DrawingOptions opts);" ], "pascal": [ - "function OptionRotateBmp(angle: Double; anchorX: Double; anchorY: Double): DrawingOptions" + "procedure DrawEllipseOnBitmap(destination: Bitmap; clr: Color; rect: Rectangle; opts: DrawingOptions)" ] } }, { - "signature": "drawing_options option_rotate_bmp(double angle,double anchor_x,double anchor_y,drawing_options opts);", - "name": "option_rotate_bmp", - "method_name": null, - "unique_global_name": "option_rotate_bmp_with_anchor_and_options", - "unique_method_name": null, + "signature": "void draw_ellipse_on_bitmap(bitmap destination,color clr,double x,double y,double width,double height);", + "name": "draw_ellipse_on_bitmap", + "method_name": "draw_ellipse", + "unique_global_name": "draw_ellipse_on_bitmap", + "unique_method_name": "bitmap.draw_ellipse", "suffix_name": null, - "description": "Use this option to rotate the drawing of a bitmap. This allows you to set the\nanchor point and rotate around that by a number of degrees.\nPass opts the other options you want use.", + "description": "Draws an ellipse on the given bitmap, using the provided location, and size.", "brief": null, "return": { - "type": "drawing_options", - "description": "Options that will rotate bitmaps around an anchor point.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "angle": { + "destination": { + "type": "bitmap", + "description": "the bitmap to draw the ellipse on", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "clr": { + "type": "color", + "description": "The color of the ellipse", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x": { "type": "double", - "description": "The angle to rotate bitmaps.", + "description": "The distance from the left of the bitmap or bitmap to the\nleft edge of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26254,9 +26066,9 @@ "is_vector": false, "type_parameter": null }, - "anchor_x": { + "y": { "type": "double", - "description": "The x location of the anchor within the bitmap", + "description": "The distance from the top of the bitmap or bitmap to the\ntop edge of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26267,9 +26079,9 @@ "is_vector": false, "type_parameter": null }, - "anchor_y": { + "width": { "type": "double", - "description": "The y location of the anchor within the bitmap", + "description": "The width of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26280,9 +26092,9 @@ "is_vector": false, "type_parameter": null }, - "opts": { - "type": "drawing_options", - "description": "Values for the other options.", + "height": { + "type": "double", + "description": "The height of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26295,45 +26107,113 @@ } }, "attributes": { - "suffix": "with_anchor_and_options", - "group": "graphics" + "class": "bitmap", + "method": "draw_ellipse", + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def option_rotate_bmp_with_anchor_and_options(angle, anchor_x, anchor_y, opts):" - ], "cpp": [ - "drawing_options option_rotate_bmp(double angle, double anchor_x, double anchor_y, drawing_options opts)" + "void draw_ellipse_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height)" + ], + "python": [ + "def draw_ellipse_on_bitmap(destination, clr, x, y, width, height):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionRotateBmp(double angle, double anchorX, double anchorY, DrawingOptions opts);" + "public void Bitmap.DrawEllipse(Color clr, double x, double y, double width, double height);", + "public static void SplashKit.DrawEllipseOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height);" ], "pascal": [ - "function OptionRotateBmp(angle: Double; anchorX: Double; anchorY: Double; opts: DrawingOptions): DrawingOptions" + "procedure DrawEllipseOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; width: Double; height: Double)" ] } }, { - "signature": "drawing_options option_rotate_bmp(double angle,drawing_options opts);", - "name": "option_rotate_bmp", - "method_name": null, - "unique_global_name": "option_rotate_bmp_with_options", - "unique_method_name": null, + "signature": "void draw_ellipse_on_bitmap(bitmap destination,color clr,double x,double y,double width,double height,drawing_options opts);", + "name": "draw_ellipse_on_bitmap", + "method_name": "draw_ellipse", + "unique_global_name": "draw_ellipse_on_bitmap_with_options", + "unique_method_name": "bitmap.draw_ellipse_with_options", "suffix_name": null, - "description": "Use this option to rotate a bitmap around its centre point.", + "description": "Draws an ellipse to the bitmap, using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", "brief": null, "return": { - "type": "drawing_options", - "description": "Options that will rotate bitmaps around its center point.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "angle": { + "destination": { + "type": "bitmap", + "description": "the bitmap to draw the ellipse on", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "clr": { + "type": "color", + "description": "The color of the ellipse", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x": { "type": "double", - "description": "The angle to rotate bitmaps.", + "description": "The distance from the left of the bitmap or bitmap to the\nleft edge of the ellipse", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The distance from the top of the bitmap or bitmap to the\ntop edge of the ellipse", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "width": { + "type": "double", + "description": "The width of the ellipse", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "height": { + "type": "double", + "description": "The height of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26346,7 +26226,7 @@ }, "opts": { "type": "drawing_options", - "description": "Values for the other options.", + "description": "The drawing options", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26359,45 +26239,49 @@ } }, "attributes": { + "class": "bitmap", + "method": "draw_ellipse", "suffix": "with_options", - "group": "graphics" + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def option_rotate_bmp_with_options(angle, opts):" - ], "cpp": [ - "drawing_options option_rotate_bmp(double angle, drawing_options opts)" + "void draw_ellipse_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height, drawing_options opts)" + ], + "python": [ + "def draw_ellipse_on_bitmap_with_options(destination, clr, x, y, width, height, opts):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionRotateBmp(double angle, DrawingOptions opts);" + "public void Bitmap.DrawEllipse(Color clr, double x, double y, double width, double height, DrawingOptions opts);", + "public static void SplashKit.DrawEllipseOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);" ], "pascal": [ - "function OptionRotateBmp(angle: Double; opts: DrawingOptions): DrawingOptions" + "procedure DrawEllipseOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)" ] } }, { - "signature": "drawing_options option_scale_bmp(double scale_x,double scale_y);", - "name": "option_scale_bmp", - "method_name": null, - "unique_global_name": "option_scale_bmp", - "unique_method_name": null, + "signature": "void draw_ellipse_on_window(window destination,color clr,const rectangle rect);", + "name": "draw_ellipse_on_window", + "method_name": "draw_ellipse", + "unique_global_name": "draw_ellipse_on_window_within_rectangle", + "unique_method_name": "window.draw_ellipse_within_rectangle", "suffix_name": null, - "description": "Use this option to scale the drawing of bitmaps. You can scale x and y separately.", + "description": "Draws an ellipse on the given window, using the provided location, and size.", "brief": null, "return": { - "type": "drawing_options", - "description": "Options that will scale bitmaps along the x,y axis.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "scale_x": { - "type": "double", - "description": "The amount to scale bitmaps aalong the x axis", + "destination": { + "type": "window", + "description": "the window to draw the ellipse on", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26408,59 +26292,77 @@ "is_vector": false, "type_parameter": null }, - "scale_y": { - "type": "double", - "description": "The amount to scale bitmaps aalong the y axis", + "clr": { + "type": "color", + "description": "The color of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "rect": { + "type": "rectangle", + "description": "Indicates the location and size of the ellipse", + "is_pointer": false, + "is_const": true, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { - "group": "graphics" + "class": "window", + "method": "draw_ellipse", + "suffix": "within_rectangle", + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def option_scale_bmp(scale_x, scale_y):" - ], "cpp": [ - "drawing_options option_scale_bmp(double scale_x, double scale_y)" + "void draw_ellipse_on_window(window destination, color clr, const rectangle rect)" + ], + "python": [ + "def draw_ellipse_on_window_within_rectangle(destination, clr, rect):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionScaleBmp(double scaleX, double scaleY);" + "public void Window.DrawEllipse(Color clr, Rectangle rect);", + "public static void SplashKit.DrawEllipseOnWindow(Window destination, Color clr, Rectangle rect);" ], "pascal": [ - "function OptionScaleBmp(scaleX: Double; scaleY: Double): DrawingOptions" + "procedure DrawEllipseOnWindow(destination: Window; clr: Color; rect: Rectangle)" ] } }, { - "signature": "drawing_options option_scale_bmp(double scale_x,double scale_y,drawing_options opts);", - "name": "option_scale_bmp", - "method_name": null, - "unique_global_name": "option_scale_bmp_with_options", - "unique_method_name": null, + "signature": "void draw_ellipse_on_window(window destination,color clr,const rectangle rect,drawing_options opts);", + "name": "draw_ellipse_on_window", + "method_name": "draw_ellipse", + "unique_global_name": "draw_ellipse_on_window_within_rectangle_with_options", + "unique_method_name": "window.draw_ellipse_within_rectangle_with_options", "suffix_name": null, - "description": "Use this option to scale the drawing of bitmaps. You can scale x and y separately.\nPass opts the other options you want use.", + "description": "Draws an ellipse on the given window, using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", "brief": null, "return": { - "type": "drawing_options", - "description": "Options that will scale bitmaps along the x,y axis.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "scale_x": { - "type": "double", - "description": "The amount to scale bitmaps aalong the x axis", + "destination": { + "type": "window", + "description": "the window to draw the ellipse on", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26471,9 +26373,9 @@ "is_vector": false, "type_parameter": null }, - "scale_y": { - "type": "double", - "description": "The amount to scale bitmaps aalong the y axis", + "clr": { + "type": "color", + "description": "The color of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26484,9 +26386,22 @@ "is_vector": false, "type_parameter": null }, + "rect": { + "type": "rectangle", + "description": "Indicates the location and size of the ellipse", + "is_pointer": false, + "is_const": true, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "opts": { "type": "drawing_options", - "description": "Values for the other options.", + "description": "The drawing options", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26499,82 +26414,114 @@ } }, "attributes": { - "suffix": "with_options", - "group": "graphics" + "class": "window", + "method": "draw_ellipse", + "suffix": "within_rectangle_with_options", + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def option_scale_bmp_with_options(scale_x, scale_y, opts):" - ], "cpp": [ - "drawing_options option_scale_bmp(double scale_x, double scale_y, drawing_options opts)" + "void draw_ellipse_on_window(window destination, color clr, const rectangle rect, drawing_options opts)" + ], + "python": [ + "def draw_ellipse_on_window_within_rectangle_with_options(destination, clr, rect, opts):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionScaleBmp(double scaleX, double scaleY, DrawingOptions opts);" + "public void Window.DrawEllipse(Color clr, Rectangle rect, DrawingOptions opts);", + "public static void SplashKit.DrawEllipseOnWindow(Window destination, Color clr, Rectangle rect, DrawingOptions opts);" ], "pascal": [ - "function OptionScaleBmp(scaleX: Double; scaleY: Double; opts: DrawingOptions): DrawingOptions" + "procedure DrawEllipseOnWindow(destination: Window; clr: Color; rect: Rectangle; opts: DrawingOptions)" ] } }, { - "signature": "drawing_options option_to_screen();", - "name": "option_to_screen", - "method_name": null, - "unique_global_name": "option_to_screen", - "unique_method_name": null, - "suffix_name": null, - "description": "Use this option to draw to the screen, ignoring the positon of the\ncamera.", - "brief": null, - "return": { - "type": "drawing_options", - "description": "Options that will draw to the surface without camera effects.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "graphics" - }, - "signatures": { - "python": [ - "def option_to_screen():" - ], - "cpp": [ - "drawing_options option_to_screen()" - ], - "csharp": [ - "public static DrawingOptions SplashKit.OptionToScreen();" - ], - "pascal": [ - "function OptionToScreen(): DrawingOptions" - ] - } - }, - { - "signature": "drawing_options option_to_screen(drawing_options opts);", - "name": "option_to_screen", - "method_name": null, - "unique_global_name": "option_to_screen_with_options", - "unique_method_name": null, + "signature": "void draw_ellipse_on_window(window destination,color clr,double x,double y,double width,double height);", + "name": "draw_ellipse_on_window", + "method_name": "draw_ellipse", + "unique_global_name": "draw_ellipse_on_window", + "unique_method_name": "window.draw_ellipse", "suffix_name": null, - "description": "Use this option to draw to the screen, ignoring the positon of the\ncamera.", + "description": "Draws an ellipse on the given window, using the provided location, and size.", "brief": null, "return": { - "type": "drawing_options", - "description": "Options that will draw to the surface without camera effects.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "opts": { - "type": "drawing_options", - "description": "Values for the other options.", + "destination": { + "type": "window", + "description": "the window to draw the ellipse on", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "clr": { + "type": "color", + "description": "The color of the ellipse", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x": { + "type": "double", + "description": "The distance from the left of the bitmap or window to the\nleft edge of the ellipse", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The distance from the top of the bitmap or window to the\ntop edge of the ellipse", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "width": { + "type": "double", + "description": "The width of the ellipse", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "height": { + "type": "double", + "description": "The height of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26587,82 +26534,48 @@ } }, "attributes": { - "suffix": "with_options", - "group": "graphics" + "class": "window", + "method": "draw_ellipse", + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def option_to_screen_with_options(opts):" - ], "cpp": [ - "drawing_options option_to_screen(drawing_options opts)" - ], - "csharp": [ - "public static DrawingOptions SplashKit.OptionToScreen(DrawingOptions opts);" + "void draw_ellipse_on_window(window destination, color clr, double x, double y, double width, double height)" ], - "pascal": [ - "function OptionToScreen(opts: DrawingOptions): DrawingOptions" - ] - } - }, - { - "signature": "drawing_options option_to_world();", - "name": "option_to_world", - "method_name": null, - "unique_global_name": "option_to_world", - "unique_method_name": null, - "suffix_name": null, - "description": "Use this option to draw in World coordinates -- these are affected by\nthe movement of the camera.", - "brief": null, - "return": { - "type": "drawing_options", - "description": "Options that will draw with camera effects.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "graphics" - }, - "signatures": { "python": [ - "def option_to_world():" - ], - "cpp": [ - "drawing_options option_to_world()" + "def draw_ellipse_on_window(destination, clr, x, y, width, height):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionToWorld();" + "public void Window.DrawEllipse(Color clr, double x, double y, double width, double height);", + "public static void SplashKit.DrawEllipseOnWindow(Window destination, Color clr, double x, double y, double width, double height);" ], "pascal": [ - "function OptionToWorld(): DrawingOptions" + "procedure DrawEllipseOnWindow(destination: Window; clr: Color; x: Double; y: Double; width: Double; height: Double)" ] } }, { - "signature": "drawing_options option_to_world(drawing_options opts);", - "name": "option_to_world", - "method_name": null, - "unique_global_name": "option_to_world_with_options", - "unique_method_name": null, + "signature": "void draw_ellipse_on_window(window destination,color clr,double x,double y,double width,double height,drawing_options opts);", + "name": "draw_ellipse_on_window", + "method_name": "draw_ellipse", + "unique_global_name": "draw_ellipse_on_window_with_options", + "unique_method_name": "window.draw_ellipse_with_options", "suffix_name": null, - "description": "Use this option to draw in World coordinates -- these are affected by\nthe movement of the camera.", + "description": "Draws an ellipse to the window, using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", "brief": null, "return": { - "type": "drawing_options", - "description": "Options that will draw with camera effects.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "opts": { - "type": "drawing_options", - "description": "Values for the other options.", + "destination": { + "type": "window", + "description": "the window to draw the ellipse on", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26672,48 +26585,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "suffix": "with_options", - "group": "graphics" - }, - "signatures": { - "python": [ - "def option_to_world_with_options(opts):" - ], - "cpp": [ - "drawing_options option_to_world(drawing_options opts)" - ], - "csharp": [ - "public static DrawingOptions SplashKit.OptionToWorld(DrawingOptions opts);" - ], - "pascal": [ - "function OptionToWorld(opts: DrawingOptions): DrawingOptions" - ] - } - }, - { - "signature": "drawing_options option_with_animation(animation anim);", - "name": "option_with_animation", - "method_name": null, - "unique_global_name": "option_with_animation", - "unique_method_name": null, - "suffix_name": null, - "description": "Use details from the animation to select an appropriate cell from the\nbitmaps being drawn.", - "brief": null, - "return": { - "type": "drawing_options", - "description": "A drawing option that will draw the current cell from the\nanimation.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "anim": { - "type": "animation", - "description": "The animation with the cell details to be used.", + }, + "clr": { + "type": "color", + "description": "The color of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26723,47 +26598,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "group": "graphics" - }, - "signatures": { - "python": [ - "def option_with_animation(anim):" - ], - "cpp": [ - "drawing_options option_with_animation(animation anim)" - ], - "csharp": [ - "public static DrawingOptions SplashKit.OptionWithAnimation(Animation anim);" - ], - "pascal": [ - "function OptionWithAnimation(anim: Animation): DrawingOptions" - ] - } - }, - { - "signature": "drawing_options option_with_animation(animation anim,drawing_options opts);", - "name": "option_with_animation", - "method_name": null, - "unique_global_name": "option_with_animation_with_options", - "unique_method_name": null, - "suffix_name": null, - "description": "Use details from the animation to select an appropriate cell from the\nbitmaps being drawn. This extends the passed in drawing options with\nthe animation details.", - "brief": null, - "return": { - "type": "drawing_options", - "description": "A drawing option that will draw the current cell from the\nanimation.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "anim": { - "type": "animation", - "description": "The animation with the cell details to be used.", + }, + "x": { + "type": "double", + "description": "The distance from the left of the bitmap or window to the\nleft edge of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26774,9 +26612,9 @@ "is_vector": false, "type_parameter": null }, - "opts": { - "type": "drawing_options", - "description": "The existing options to extend.", + "y": { + "type": "double", + "description": "The distance from the top of the bitmap or window to the\ntop edge of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26786,48 +26624,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "suffix": "with_options", - "group": "graphics" - }, - "signatures": { - "python": [ - "def option_with_animation_with_options(anim, opts):" - ], - "cpp": [ - "drawing_options option_with_animation(animation anim, drawing_options opts)" - ], - "csharp": [ - "public static DrawingOptions SplashKit.OptionWithAnimation(Animation anim, DrawingOptions opts);" - ], - "pascal": [ - "function OptionWithAnimation(anim: Animation; opts: DrawingOptions): DrawingOptions" - ] - } - }, - { - "signature": "drawing_options option_with_bitmap_cell(int cell);", - "name": "option_with_bitmap_cell", - "method_name": null, - "unique_global_name": "option_with_bitmap_cell", - "unique_method_name": null, - "suffix_name": null, - "description": "When drawing the bitmap this will only draw the cell. To use this the bitmap\nneeds to have been provided with its cell details (see `bitmap_set_cell_details`).\nThis option overrides the animation or part drawing options.", - "brief": null, - "return": { - "type": "drawing_options", - "description": "A drawing option that will draw the selected cell.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "cell": { - "type": "int", - "description": "The cell to draw from the bitmap (-1 for entire bitmap)", + }, + "width": { + "type": "double", + "description": "The width of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26837,47 +26637,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "group": "graphics" - }, - "signatures": { - "python": [ - "def option_with_bitmap_cell(cell):" - ], - "cpp": [ - "drawing_options option_with_bitmap_cell(int cell)" - ], - "csharp": [ - "public static DrawingOptions SplashKit.OptionWithBitmapCell(int cell);" - ], - "pascal": [ - "function OptionWithBitmapCell(cell: Integer): DrawingOptions" - ] - } - }, - { - "signature": "drawing_options option_with_bitmap_cell(int cell,drawing_options opts);", - "name": "option_with_bitmap_cell", - "method_name": null, - "unique_global_name": "option_with_bitmap_cell_with_options", - "unique_method_name": null, - "suffix_name": null, - "description": "When drawing the bitmap this will only draw the cell. To use this the bitmap\nneeds to have been provided with its cell details (see `bitmap_set_cell_details`).\nThis option overrides the animation or part drawing options. This extends\nthe passed in drawing options with the cell details.", - "brief": null, - "return": { - "type": "drawing_options", - "description": "A drawing option that will draw the selected cell.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "cell": { - "type": "int", - "description": "The cell to draw from the bitmap (-1 for entire bitmap)", + }, + "height": { + "type": "double", + "description": "The height of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26890,7 +26653,7 @@ }, "opts": { "type": "drawing_options", - "description": "The existing options to extend.", + "description": "The drawing options", "is_pointer": false, "is_const": false, "is_reference": false, @@ -26903,32 +26666,36 @@ } }, "attributes": { + "class": "window", + "method": "draw_ellipse", "suffix": "with_options", - "group": "graphics" + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def option_with_bitmap_cell_with_options(cell, opts):" - ], "cpp": [ - "drawing_options option_with_bitmap_cell(int cell, drawing_options opts)" + "void draw_ellipse_on_window(window destination, color clr, double x, double y, double width, double height, drawing_options opts)" + ], + "python": [ + "def draw_ellipse_on_window_with_options(destination, clr, x, y, width, height, opts):" ], "csharp": [ - "public static DrawingOptions SplashKit.OptionWithBitmapCell(int cell, DrawingOptions opts);" + "public void Window.DrawEllipse(Color clr, double x, double y, double width, double height, DrawingOptions opts);", + "public static void SplashKit.DrawEllipseOnWindow(Window destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);" ], "pascal": [ - "function OptionWithBitmapCell(cell: Integer; opts: DrawingOptions): DrawingOptions" + "procedure DrawEllipseOnWindow(destination: Window; clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)" ] } }, { - "signature": "void draw_ellipse(color clr,const rectangle rect);", - "name": "draw_ellipse", + "signature": "void fill_ellipse(color clr,const rectangle rect);", + "name": "fill_ellipse", "method_name": null, - "unique_global_name": "draw_ellipse_within_rectangle", + "unique_global_name": "fill_ellipse_within_rectangle", "unique_method_name": null, "suffix_name": null, - "description": "Draws an ellipse using the provided location, and size.", + "description": "Fill an ellipse using the provided location, and size.", "brief": null, "return": { "type": "void", @@ -26971,28 +26738,28 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_ellipse_within_rectangle(clr, rect):" - ], "cpp": [ - "void draw_ellipse(color clr, const rectangle rect)" + "void fill_ellipse(color clr, const rectangle rect)" + ], + "python": [ + "def fill_ellipse_within_rectangle(clr, rect):" ], "csharp": [ - "public static void SplashKit.DrawEllipse(Color clr, Rectangle rect);" + "public static void SplashKit.FillEllipse(Color clr, Rectangle rect);" ], "pascal": [ - "procedure DrawEllipse(clr: Color; rect: Rectangle)" + "procedure FillEllipse(clr: Color; rect: Rectangle)" ] } }, { - "signature": "void draw_ellipse(color clr,const rectangle rect,drawing_options opts);", - "name": "draw_ellipse", + "signature": "void fill_ellipse(color clr,const rectangle rect,drawing_options opts);", + "name": "fill_ellipse", "method_name": null, - "unique_global_name": "draw_ellipse_within_rectangle_with_options", + "unique_global_name": "fill_ellipse_within_rectangle_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Draws an ellipse using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", + "description": "Fills an ellipse using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", "brief": null, "return": { "type": "void", @@ -27048,28 +26815,28 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_ellipse_within_rectangle_with_options(clr, rect, opts):" - ], "cpp": [ - "void draw_ellipse(color clr, const rectangle rect, drawing_options opts)" + "void fill_ellipse(color clr, const rectangle rect, drawing_options opts)" + ], + "python": [ + "def fill_ellipse_within_rectangle_with_options(clr, rect, opts):" ], "csharp": [ - "public static void SplashKit.DrawEllipse(Color clr, Rectangle rect, DrawingOptions opts);" + "public static void SplashKit.FillEllipse(Color clr, Rectangle rect, DrawingOptions opts);" ], "pascal": [ - "procedure DrawEllipse(clr: Color; rect: Rectangle; opts: DrawingOptions)" + "procedure FillEllipse(clr: Color; rect: Rectangle; opts: DrawingOptions)" ] } }, { - "signature": "void draw_ellipse(color clr,double x,double y,double width,double height);", - "name": "draw_ellipse", + "signature": "void fill_ellipse(color clr,double x,double y,double width,double height);", + "name": "fill_ellipse", "method_name": null, - "unique_global_name": "draw_ellipse", + "unique_global_name": "fill_ellipse", "unique_method_name": null, "suffix_name": null, - "description": "Draws an ellipse using the provided location, and size.", + "description": "Fills an ellipse using the provided location, and size.", "brief": null, "return": { "type": "void", @@ -27150,28 +26917,28 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_ellipse(clr, x, y, width, height):" - ], "cpp": [ - "void draw_ellipse(color clr, double x, double y, double width, double height)" + "void fill_ellipse(color clr, double x, double y, double width, double height)" + ], + "python": [ + "def fill_ellipse(clr, x, y, width, height):" ], "csharp": [ - "public static void SplashKit.DrawEllipse(Color clr, double x, double y, double width, double height);" + "public static void SplashKit.FillEllipse(Color clr, double x, double y, double width, double height);" ], "pascal": [ - "procedure DrawEllipse(clr: Color; x: Double; y: Double; width: Double; height: Double)" + "procedure FillEllipse(clr: Color; x: Double; y: Double; width: Double; height: Double)" ] } }, { - "signature": "void draw_ellipse(color clr,double x,double y,double width,double height,drawing_options opts);", - "name": "draw_ellipse", + "signature": "void fill_ellipse(color clr,double x,double y,double width,double height,drawing_options opts);", + "name": "fill_ellipse", "method_name": null, - "unique_global_name": "draw_ellipse_with_options", + "unique_global_name": "fill_ellipse_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Draws an ellipse using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", + "description": "Fills an ellipse using the provided location, size, and drawing options.", "brief": null, "return": { "type": "void", @@ -27266,28 +27033,28 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_ellipse_with_options(clr, x, y, width, height, opts):" - ], "cpp": [ - "void draw_ellipse(color clr, double x, double y, double width, double height, drawing_options opts)" + "void fill_ellipse(color clr, double x, double y, double width, double height, drawing_options opts)" + ], + "python": [ + "def fill_ellipse_with_options(clr, x, y, width, height, opts):" ], "csharp": [ - "public static void SplashKit.DrawEllipse(Color clr, double x, double y, double width, double height, DrawingOptions opts);" + "public static void SplashKit.FillEllipse(Color clr, double x, double y, double width, double height, DrawingOptions opts);" ], "pascal": [ - "procedure DrawEllipse(clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)" + "procedure FillEllipse(clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)" ] } }, { - "signature": "void draw_ellipse_on_bitmap(bitmap destination,color clr,const rectangle rect);", - "name": "draw_ellipse_on_bitmap", - "method_name": "draw_ellipse", - "unique_global_name": "draw_ellipse_on_bitmap_within_rectangle", - "unique_method_name": "bitmap.draw_ellipse_within_rectangle", + "signature": "void fill_ellipse_on_bitmap(bitmap destination,color clr,const rectangle rect);", + "name": "fill_ellipse_on_bitmap", + "method_name": "fill_ellipse", + "unique_global_name": "fill_ellipse_on_bitmap_within_rectangle", + "unique_method_name": "bitmap.fill_ellipse_within_rectangle", "suffix_name": null, - "description": "Draws an ellipse on the given bitmap, using the provided location, and size.", + "description": "Fill an ellipse on the given bitmap, using the provided location, and size.", "brief": null, "return": { "type": "void", @@ -27340,35 +27107,35 @@ }, "attributes": { "class": "bitmap", - "method": "draw_ellipse", + "method": "fill_ellipse", "suffix": "within_rectangle", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_ellipse_on_bitmap_within_rectangle(destination, clr, rect):" - ], "cpp": [ - "void draw_ellipse_on_bitmap(bitmap destination, color clr, const rectangle rect)" + "void fill_ellipse_on_bitmap(bitmap destination, color clr, const rectangle rect)" + ], + "python": [ + "def fill_ellipse_on_bitmap_within_rectangle(destination, clr, rect):" ], "csharp": [ - "public void Bitmap.DrawEllipse(Color clr, Rectangle rect);", - "public static void SplashKit.DrawEllipseOnBitmap(Bitmap destination, Color clr, Rectangle rect);" + "public void Bitmap.FillEllipse(Color clr, Rectangle rect);", + "public static void SplashKit.FillEllipseOnBitmap(Bitmap destination, Color clr, Rectangle rect);" ], "pascal": [ - "procedure DrawEllipseOnBitmap(destination: Bitmap; clr: Color; rect: Rectangle)" + "procedure FillEllipseOnBitmap(destination: Bitmap; clr: Color; rect: Rectangle)" ] } }, { - "signature": "void draw_ellipse_on_bitmap(bitmap destination,color clr,const rectangle rect,drawing_options opts);", - "name": "draw_ellipse_on_bitmap", - "method_name": "draw_ellipse", - "unique_global_name": "draw_ellipse_on_bitmap_within_rectangle_with_options", - "unique_method_name": "bitmap.draw_ellipse_within_rectangle_with_options", - "suffix_name": null, - "description": "Draws an ellipse on the given bitmap, using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", + "signature": "void fill_ellipse_on_bitmap(bitmap destination,color clr,const rectangle rect,drawing_options opts);", + "name": "fill_ellipse_on_bitmap", + "method_name": "fill_ellipse", + "unique_global_name": "fill_ellipse_on_bitmap_within_rectangle_with_options", + "unique_method_name": "bitmap.fill_ellipse_within_rectangle_with_options", + "suffix_name": null, + "description": "Fills an ellipse on the given bitmap, using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", "brief": null, "return": { "type": "void", @@ -27434,35 +27201,35 @@ }, "attributes": { "class": "bitmap", - "method": "draw_ellipse", + "method": "fill_ellipse", "suffix": "within_rectangle_with_options", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_ellipse_on_bitmap_within_rectangle_with_options(destination, clr, rect, opts):" - ], "cpp": [ - "void draw_ellipse_on_bitmap(bitmap destination, color clr, const rectangle rect, drawing_options opts)" + "void fill_ellipse_on_bitmap(bitmap destination, color clr, const rectangle rect, drawing_options opts)" + ], + "python": [ + "def fill_ellipse_on_bitmap_within_rectangle_with_options(destination, clr, rect, opts):" ], "csharp": [ - "public void Bitmap.DrawEllipse(Color clr, Rectangle rect, DrawingOptions opts);", - "public static void SplashKit.DrawEllipseOnBitmap(Bitmap destination, Color clr, Rectangle rect, DrawingOptions opts);" + "public void Bitmap.FillEllipse(Color clr, Rectangle rect, DrawingOptions opts);", + "public static void SplashKit.FillEllipseOnBitmap(Bitmap destination, Color clr, Rectangle rect, DrawingOptions opts);" ], "pascal": [ - "procedure DrawEllipseOnBitmap(destination: Bitmap; clr: Color; rect: Rectangle; opts: DrawingOptions)" + "procedure FillEllipseOnBitmap(destination: Bitmap; clr: Color; rect: Rectangle; opts: DrawingOptions)" ] } }, { - "signature": "void draw_ellipse_on_bitmap(bitmap destination,color clr,double x,double y,double width,double height);", - "name": "draw_ellipse_on_bitmap", - "method_name": "draw_ellipse", - "unique_global_name": "draw_ellipse_on_bitmap", - "unique_method_name": "bitmap.draw_ellipse", + "signature": "void fill_ellipse_on_bitmap(bitmap destination,color clr,double x,double y,double width,double height);", + "name": "fill_ellipse_on_bitmap", + "method_name": "fill_ellipse", + "unique_global_name": "fill_ellipse_on_bitmap", + "unique_method_name": "bitmap.fill_ellipse", "suffix_name": null, - "description": "Draws an ellipse on the given bitmap, using the provided location, and size.", + "description": "Fills an ellipse on the given bitmap, using the provided location, and size.", "brief": null, "return": { "type": "void", @@ -27554,34 +27321,34 @@ }, "attributes": { "class": "bitmap", - "method": "draw_ellipse", + "method": "fill_ellipse", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_ellipse_on_bitmap(destination, clr, x, y, width, height):" - ], "cpp": [ - "void draw_ellipse_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height)" + "void fill_ellipse_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height)" + ], + "python": [ + "def fill_ellipse_on_bitmap(destination, clr, x, y, width, height):" ], "csharp": [ - "public void Bitmap.DrawEllipse(Color clr, double x, double y, double width, double height);", - "public static void SplashKit.DrawEllipseOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height);" + "public void Bitmap.FillEllipse(Color clr, double x, double y, double width, double height);", + "public static void SplashKit.FillEllipseOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height);" ], "pascal": [ - "procedure DrawEllipseOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; width: Double; height: Double)" + "procedure FillEllipseOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; width: Double; height: Double)" ] } }, { - "signature": "void draw_ellipse_on_bitmap(bitmap destination,color clr,double x,double y,double width,double height,drawing_options opts);", - "name": "draw_ellipse_on_bitmap", - "method_name": "draw_ellipse", - "unique_global_name": "draw_ellipse_on_bitmap_with_options", - "unique_method_name": "bitmap.draw_ellipse_with_options", + "signature": "void fill_ellipse_on_bitmap(bitmap destination,color clr,double x,double y,double width,double height,drawing_options opts);", + "name": "fill_ellipse_on_bitmap", + "method_name": "fill_ellipse", + "unique_global_name": "fill_ellipse_on_bitmap_with_options", + "unique_method_name": "bitmap.fill_ellipse_with_options", "suffix_name": null, - "description": "Draws an ellipse to the bitmap, using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", + "description": "Fills an ellipse on the given bitmap, using the provided location, size, and drawing options.", "brief": null, "return": { "type": "void", @@ -27686,35 +27453,35 @@ }, "attributes": { "class": "bitmap", - "method": "draw_ellipse", + "method": "fill_ellipse", "suffix": "with_options", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_ellipse_on_bitmap_with_options(destination, clr, x, y, width, height, opts):" - ], "cpp": [ - "void draw_ellipse_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height, drawing_options opts)" + "void fill_ellipse_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height, drawing_options opts)" + ], + "python": [ + "def fill_ellipse_on_bitmap_with_options(destination, clr, x, y, width, height, opts):" ], "csharp": [ - "public void Bitmap.DrawEllipse(Color clr, double x, double y, double width, double height, DrawingOptions opts);", - "public static void SplashKit.DrawEllipseOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);" + "public void Bitmap.FillEllipse(Color clr, double x, double y, double width, double height, DrawingOptions opts);", + "public static void SplashKit.FillEllipseOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);" ], "pascal": [ - "procedure DrawEllipseOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)" + "procedure FillEllipseOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)" ] } }, { - "signature": "void draw_ellipse_on_window(window destination,color clr,const rectangle rect);", - "name": "draw_ellipse_on_window", - "method_name": "draw_ellipse", - "unique_global_name": "draw_ellipse_on_window_within_rectangle", - "unique_method_name": "window.draw_ellipse_within_rectangle", + "signature": "void fill_ellipse_on_window(window destination,color clr,const rectangle rect);", + "name": "fill_ellipse_on_window", + "method_name": "fill_ellipse", + "unique_global_name": "fill_ellipse_on_window_within_rectangle", + "unique_method_name": "window.fill_ellipse_within_rectangle", "suffix_name": null, - "description": "Draws an ellipse on the given window, using the provided location, and size.", + "description": "Fill an ellipse on the given window, using the provided location, and size.", "brief": null, "return": { "type": "void", @@ -27767,35 +27534,35 @@ }, "attributes": { "class": "window", - "method": "draw_ellipse", + "method": "fill_ellipse", "suffix": "within_rectangle", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_ellipse_on_window_within_rectangle(destination, clr, rect):" - ], "cpp": [ - "void draw_ellipse_on_window(window destination, color clr, const rectangle rect)" + "void fill_ellipse_on_window(window destination, color clr, const rectangle rect)" + ], + "python": [ + "def fill_ellipse_on_window_within_rectangle(destination, clr, rect):" ], "csharp": [ - "public void Window.DrawEllipse(Color clr, Rectangle rect);", - "public static void SplashKit.DrawEllipseOnWindow(Window destination, Color clr, Rectangle rect);" + "public void Window.FillEllipse(Color clr, Rectangle rect);", + "public static void SplashKit.FillEllipseOnWindow(Window destination, Color clr, Rectangle rect);" ], "pascal": [ - "procedure DrawEllipseOnWindow(destination: Window; clr: Color; rect: Rectangle)" + "procedure FillEllipseOnWindow(destination: Window; clr: Color; rect: Rectangle)" ] } }, { - "signature": "void draw_ellipse_on_window(window destination,color clr,const rectangle rect,drawing_options opts);", - "name": "draw_ellipse_on_window", - "method_name": "draw_ellipse", - "unique_global_name": "draw_ellipse_on_window_within_rectangle_with_options", - "unique_method_name": "window.draw_ellipse_within_rectangle_with_options", + "signature": "void fill_ellipse_on_window(window destination,color clr,const rectangle rect,drawing_options opts);", + "name": "fill_ellipse_on_window", + "method_name": "fill_ellipse", + "unique_global_name": "fill_ellipse_on_window_within_rectangle_with_options", + "unique_method_name": "window.fill_ellipse_within_rectangle_with_options", "suffix_name": null, - "description": "Draws an ellipse on the given window, using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", + "description": "Fills an ellipse on the given window, using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", "brief": null, "return": { "type": "void", @@ -27861,154 +27628,35 @@ }, "attributes": { "class": "window", - "method": "draw_ellipse", + "method": "fill_ellipse", "suffix": "within_rectangle_with_options", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_ellipse_on_window_within_rectangle_with_options(destination, clr, rect, opts):" - ], "cpp": [ - "void draw_ellipse_on_window(window destination, color clr, const rectangle rect, drawing_options opts)" - ], - "csharp": [ - "public void Window.DrawEllipse(Color clr, Rectangle rect, DrawingOptions opts);", - "public static void SplashKit.DrawEllipseOnWindow(Window destination, Color clr, Rectangle rect, DrawingOptions opts);" + "void fill_ellipse_on_window(window destination, color clr, const rectangle rect, drawing_options opts)" ], - "pascal": [ - "procedure DrawEllipseOnWindow(destination: Window; clr: Color; rect: Rectangle; opts: DrawingOptions)" - ] - } - }, - { - "signature": "void draw_ellipse_on_window(window destination,color clr,double x,double y,double width,double height);", - "name": "draw_ellipse_on_window", - "method_name": "draw_ellipse", - "unique_global_name": "draw_ellipse_on_window", - "unique_method_name": "window.draw_ellipse", - "suffix_name": null, - "description": "Draws an ellipse on the given window, using the provided location, and size.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "destination": { - "type": "window", - "description": "the window to draw the ellipse on", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The distance from the left of the bitmap or window to the\nleft edge of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The distance from the top of the bitmap or window to the\ntop edge of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "width": { - "type": "double", - "description": "The width of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "height": { - "type": "double", - "description": "The height of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "class": "window", - "method": "draw_ellipse", - "group": "graphics", - "self": "destination" - }, - "signatures": { "python": [ - "def draw_ellipse_on_window(destination, clr, x, y, width, height):" - ], - "cpp": [ - "void draw_ellipse_on_window(window destination, color clr, double x, double y, double width, double height)" + "def fill_ellipse_on_window_within_rectangle_with_options(destination, clr, rect, opts):" ], "csharp": [ - "public void Window.DrawEllipse(Color clr, double x, double y, double width, double height);", - "public static void SplashKit.DrawEllipseOnWindow(Window destination, Color clr, double x, double y, double width, double height);" + "public void Window.FillEllipse(Color clr, Rectangle rect, DrawingOptions opts);", + "public static void SplashKit.FillEllipseOnWindow(Window destination, Color clr, Rectangle rect, DrawingOptions opts);" ], "pascal": [ - "procedure DrawEllipseOnWindow(destination: Window; clr: Color; x: Double; y: Double; width: Double; height: Double)" + "procedure FillEllipseOnWindow(destination: Window; clr: Color; rect: Rectangle; opts: DrawingOptions)" ] } }, { - "signature": "void draw_ellipse_on_window(window destination,color clr,double x,double y,double width,double height,drawing_options opts);", - "name": "draw_ellipse_on_window", - "method_name": "draw_ellipse", - "unique_global_name": "draw_ellipse_on_window_with_options", - "unique_method_name": "window.draw_ellipse_with_options", + "signature": "void fill_ellipse_on_window(window destination,color clr,double x,double y,double width,double height);", + "name": "fill_ellipse_on_window", + "method_name": "fill_ellipse", + "unique_global_name": "fill_ellipse_on_window", + "unique_method_name": "window.fill_ellipse", "suffix_name": null, - "description": "Draws an ellipse to the window, using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", + "description": "Fills an ellipse on the given window, using the provided location, and size.", "brief": null, "return": { "type": "void", @@ -28093,19 +27741,6 @@ "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "The drawing options", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null @@ -28113,35 +27748,34 @@ }, "attributes": { "class": "window", - "method": "draw_ellipse", - "suffix": "with_options", + "method": "fill_ellipse", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_ellipse_on_window_with_options(destination, clr, x, y, width, height, opts):" - ], "cpp": [ - "void draw_ellipse_on_window(window destination, color clr, double x, double y, double width, double height, drawing_options opts)" + "void fill_ellipse_on_window(window destination, color clr, double x, double y, double width, double height)" + ], + "python": [ + "def fill_ellipse_on_window(destination, clr, x, y, width, height):" ], "csharp": [ - "public void Window.DrawEllipse(Color clr, double x, double y, double width, double height, DrawingOptions opts);", - "public static void SplashKit.DrawEllipseOnWindow(Window destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);" + "public void Window.FillEllipse(Color clr, double x, double y, double width, double height);", + "public static void SplashKit.FillEllipseOnWindow(Window destination, Color clr, double x, double y, double width, double height);" ], "pascal": [ - "procedure DrawEllipseOnWindow(destination: Window; clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)" + "procedure FillEllipseOnWindow(destination: Window; clr: Color; x: Double; y: Double; width: Double; height: Double)" ] } }, { - "signature": "void fill_ellipse(color clr,const rectangle rect);", - "name": "fill_ellipse", - "method_name": null, - "unique_global_name": "fill_ellipse_within_rectangle", - "unique_method_name": null, + "signature": "void fill_ellipse_on_window(window destination,color clr,double x,double y,double width,double height,drawing_options opts);", + "name": "fill_ellipse_on_window", + "method_name": "fill_ellipse", + "unique_global_name": "fill_ellipse_on_window_with_options", + "unique_method_name": "window.fill_ellipse_with_options", "suffix_name": null, - "description": "Fill an ellipse using the provided location, and size.", + "description": "Fills an ellipse on the given window, using the provided location, size, and drawing options.", "brief": null, "return": { "type": "void", @@ -28152,6 +27786,19 @@ "type_parameter": null }, "parameters": { + "destination": { + "type": "window", + "description": "the window to draw the ellipse on", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "clr": { "type": "color", "description": "The color of the ellipse", @@ -28165,11 +27812,11 @@ "is_vector": false, "type_parameter": null }, - "rect": { - "type": "rectangle", - "description": "Indicates the location and size of the ellipse", + "x": { + "type": "double", + "description": "The distance from the left of the bitmap or window to the\nleft edge of the ellipse", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -28177,48 +27824,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "suffix": "within_rectangle", - "group": "graphics" - }, - "signatures": { - "python": [ - "def fill_ellipse_within_rectangle(clr, rect):" - ], - "cpp": [ - "void fill_ellipse(color clr, const rectangle rect)" - ], - "csharp": [ - "public static void SplashKit.FillEllipse(Color clr, Rectangle rect);" - ], - "pascal": [ - "procedure FillEllipse(clr: Color; rect: Rectangle)" - ] - } - }, - { - "signature": "void fill_ellipse(color clr,const rectangle rect,drawing_options opts);", - "name": "fill_ellipse", - "method_name": null, - "unique_global_name": "fill_ellipse_within_rectangle_with_options", - "unique_method_name": null, - "suffix_name": null, - "description": "Fills an ellipse using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "clr": { - "type": "color", - "description": "The color of the ellipse", + }, + "y": { + "type": "double", + "description": "The distance from the top of the bitmap or window to the\ntop edge of the ellipse", "is_pointer": false, "is_const": false, "is_reference": false, @@ -28229,11 +27838,24 @@ "is_vector": false, "type_parameter": null }, - "rect": { - "type": "rectangle", - "description": "Indicates the location and size of the ellipse", + "width": { + "type": "double", + "description": "The width of the ellipse", "is_pointer": false, - "is_const": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "height": { + "type": "double", + "description": "The height of the ellipse", + "is_pointer": false, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -28257,32 +27879,36 @@ } }, "attributes": { - "suffix": "within_rectangle_with_options", - "group": "graphics" + "class": "window", + "method": "fill_ellipse", + "suffix": "with_options", + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def fill_ellipse_within_rectangle_with_options(clr, rect, opts):" - ], "cpp": [ - "void fill_ellipse(color clr, const rectangle rect, drawing_options opts)" + "void fill_ellipse_on_window(window destination, color clr, double x, double y, double width, double height, drawing_options opts)" + ], + "python": [ + "def fill_ellipse_on_window_with_options(destination, clr, x, y, width, height, opts):" ], "csharp": [ - "public static void SplashKit.FillEllipse(Color clr, Rectangle rect, DrawingOptions opts);" + "public void Window.FillEllipse(Color clr, double x, double y, double width, double height, DrawingOptions opts);", + "public static void SplashKit.FillEllipseOnWindow(Window destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);" ], "pascal": [ - "procedure FillEllipse(clr: Color; rect: Rectangle; opts: DrawingOptions)" + "procedure FillEllipseOnWindow(destination: Window; clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)" ] } }, { - "signature": "void fill_ellipse(color clr,double x,double y,double width,double height);", - "name": "fill_ellipse", + "signature": "void clear_screen();", + "name": "clear_screen", "method_name": null, - "unique_global_name": "fill_ellipse", + "unique_global_name": "clear_screen_to_white", "unique_method_name": null, "suffix_name": null, - "description": "Fills an ellipse using the provided location, and size.", + "description": "Clears the current screen to color white.", "brief": null, "return": { "type": "void", @@ -28293,99 +27919,35 @@ "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The distance from the left of the bitmap or window to the\nleft edge of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The distance from the top of the bitmap or window to the\ntop edge of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "width": { - "type": "double", - "description": "The width of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "height": { - "type": "double", - "description": "The height of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { + "suffix": "to_white", "group": "graphics" }, "signatures": { - "python": [ - "def fill_ellipse(clr, x, y, width, height):" - ], "cpp": [ - "void fill_ellipse(color clr, double x, double y, double width, double height)" + "void clear_screen()" + ], + "python": [ + "def clear_screen_to_white():" ], "csharp": [ - "public static void SplashKit.FillEllipse(Color clr, double x, double y, double width, double height);" + "public static void SplashKit.ClearScreen();" ], "pascal": [ - "procedure FillEllipse(clr: Color; x: Double; y: Double; width: Double; height: Double)" + "procedure ClearScreen()" ] } }, { - "signature": "void fill_ellipse(color clr,double x,double y,double width,double height,drawing_options opts);", - "name": "fill_ellipse", + "signature": "void clear_screen(color clr);", + "name": "clear_screen", "method_name": null, - "unique_global_name": "fill_ellipse_with_options", + "unique_global_name": "clear_screen", "unique_method_name": null, "suffix_name": null, - "description": "Fills an ellipse using the provided location, size, and drawing options.", - "brief": null, + "description": null, + "brief": "Clears all open windows to the `clr` provided.", "return": { "type": "void", "description": null, @@ -28397,72 +27959,7 @@ "parameters": { "clr": { "type": "color", - "description": "The color of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The distance from the left of the bitmap or window to the\nleft edge of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The distance from the top of the bitmap or window to the\ntop edge of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "width": { - "type": "double", - "description": "The width of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "height": { - "type": "double", - "description": "The height of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "The drawing options", + "description": "The color to clear the screen's background color to.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -28475,165 +27972,94 @@ } }, "attributes": { - "suffix": "with_options", "group": "graphics" }, "signatures": { - "python": [ - "def fill_ellipse_with_options(clr, x, y, width, height, opts):" - ], "cpp": [ - "void fill_ellipse(color clr, double x, double y, double width, double height, drawing_options opts)" + "void clear_screen(color clr)" + ], + "python": [ + "def clear_screen(clr):" ], "csharp": [ - "public static void SplashKit.FillEllipse(Color clr, double x, double y, double width, double height, DrawingOptions opts);" + "public static void SplashKit.ClearScreen(Color clr);" ], "pascal": [ - "procedure FillEllipse(clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)" + "procedure ClearScreen(clr: Color)" ] } }, { - "signature": "void fill_ellipse_on_bitmap(bitmap destination,color clr,const rectangle rect);", - "name": "fill_ellipse_on_bitmap", - "method_name": "fill_ellipse", - "unique_global_name": "fill_ellipse_on_bitmap_within_rectangle", - "unique_method_name": "bitmap.fill_ellipse_within_rectangle", + "signature": "display display_details(unsigned int index);", + "name": "display_details", + "method_name": null, + "unique_global_name": "display_details", + "unique_method_name": null, "suffix_name": null, - "description": "Fill an ellipse on the given bitmap, using the provided location, and size.", + "description": "Returns the details about one of the displays attached to the computer.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "display", + "description": "The details of this display", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "bitmap", - "description": "the bitmap to draw the ellipse on", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the ellipse", + "index": { + "type": "unsigned int", + "description": "The display number (from 0 to `number_of_displays` - 1)", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "Indicates the location and size of the ellipse", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "bitmap", - "method": "fill_ellipse", - "suffix": "within_rectangle", - "group": "graphics", - "self": "destination" + "group": "graphics" }, "signatures": { - "python": [ - "def fill_ellipse_on_bitmap_within_rectangle(destination, clr, rect):" - ], "cpp": [ - "void fill_ellipse_on_bitmap(bitmap destination, color clr, const rectangle rect)" + "display display_details(unsigned int index)" + ], + "python": [ + "def display_details(index):" ], "csharp": [ - "public void Bitmap.FillEllipse(Color clr, Rectangle rect);", - "public static void SplashKit.FillEllipseOnBitmap(Bitmap destination, Color clr, Rectangle rect);" + "public static Display SplashKit.DisplayDetails(uint index);" ], "pascal": [ - "procedure FillEllipseOnBitmap(destination: Bitmap; clr: Color; rect: Rectangle)" + "function DisplayDetails(index: Cardinal): Display" ] } }, { - "signature": "void fill_ellipse_on_bitmap(bitmap destination,color clr,const rectangle rect,drawing_options opts);", - "name": "fill_ellipse_on_bitmap", - "method_name": "fill_ellipse", - "unique_global_name": "fill_ellipse_on_bitmap_within_rectangle_with_options", - "unique_method_name": "bitmap.fill_ellipse_within_rectangle_with_options", + "signature": "int display_height(display disp);", + "name": "display_height", + "method_name": null, + "unique_global_name": "display_height", + "unique_method_name": null, "suffix_name": null, - "description": "Fills an ellipse on the given bitmap, using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", + "description": "Return the height of the display in pixels, read from the system details.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "int", + "description": "The height of the display", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "bitmap", - "description": "the bitmap to draw the ellipse on", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "Indicates the location and size of the ellipse", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "The drawing options", + "disp": { + "type": "display", + "description": "The display details", "is_pointer": false, "is_const": false, "is_reference": false, @@ -28646,114 +28072,48 @@ } }, "attributes": { - "class": "bitmap", - "method": "fill_ellipse", - "suffix": "within_rectangle_with_options", + "class": "display", + "getter": "height", "group": "graphics", - "self": "destination" + "self": "disp" }, "signatures": { - "python": [ - "def fill_ellipse_on_bitmap_within_rectangle_with_options(destination, clr, rect, opts):" - ], "cpp": [ - "void fill_ellipse_on_bitmap(bitmap destination, color clr, const rectangle rect, drawing_options opts)" + "int display_height(display disp)" + ], + "python": [ + "def display_height(disp):" ], "csharp": [ - "public void Bitmap.FillEllipse(Color clr, Rectangle rect, DrawingOptions opts);", - "public static void SplashKit.FillEllipseOnBitmap(Bitmap destination, Color clr, Rectangle rect, DrawingOptions opts);" + "public int Display.Height { get }", + "public static int SplashKit.DisplayHeight(Display disp);" ], "pascal": [ - "procedure FillEllipseOnBitmap(destination: Bitmap; clr: Color; rect: Rectangle; opts: DrawingOptions)" + "function DisplayHeight(disp: Display): Integer" ] } }, { - "signature": "void fill_ellipse_on_bitmap(bitmap destination,color clr,double x,double y,double width,double height);", - "name": "fill_ellipse_on_bitmap", - "method_name": "fill_ellipse", - "unique_global_name": "fill_ellipse_on_bitmap", - "unique_method_name": "bitmap.fill_ellipse", + "signature": "string display_name(display disp);", + "name": "display_name", + "method_name": null, + "unique_global_name": "display_name", + "unique_method_name": null, "suffix_name": null, - "description": "Fills an ellipse on the given bitmap, using the provided location, and size.", + "description": "Return the name of the display, read from the system details.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "string", + "description": "The name of the display", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "bitmap", - "description": "the bitmap to draw the ellipse on", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The distance from the left of the bitmap or bitmap to the\nleft edge of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The distance from the top of the bitmap or bitmap to the\ntop edge of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "width": { - "type": "double", - "description": "The width of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "height": { - "type": "double", - "description": "The height of the ellipse", + "disp": { + "type": "display", + "description": "The display details", "is_pointer": false, "is_const": false, "is_reference": false, @@ -28766,126 +28126,48 @@ } }, "attributes": { - "class": "bitmap", - "method": "fill_ellipse", + "class": "display", + "getter": "name", "group": "graphics", - "self": "destination" + "self": "disp" }, "signatures": { - "python": [ - "def fill_ellipse_on_bitmap(destination, clr, x, y, width, height):" - ], "cpp": [ - "void fill_ellipse_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height)" + "string display_name(display disp)" + ], + "python": [ + "def display_name(disp):" ], "csharp": [ - "public void Bitmap.FillEllipse(Color clr, double x, double y, double width, double height);", - "public static void SplashKit.FillEllipseOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height);" + "public string Display.Name { get }", + "public static string SplashKit.DisplayName(Display disp);" ], "pascal": [ - "procedure FillEllipseOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; width: Double; height: Double)" + "function DisplayName(disp: Display): String" ] } }, { - "signature": "void fill_ellipse_on_bitmap(bitmap destination,color clr,double x,double y,double width,double height,drawing_options opts);", - "name": "fill_ellipse_on_bitmap", - "method_name": "fill_ellipse", - "unique_global_name": "fill_ellipse_on_bitmap_with_options", - "unique_method_name": "bitmap.fill_ellipse_with_options", + "signature": "int display_width(display disp);", + "name": "display_width", + "method_name": null, + "unique_global_name": "display_width", + "unique_method_name": null, "suffix_name": null, - "description": "Fills an ellipse on the given bitmap, using the provided location, size, and drawing options.", + "description": "Return the width of the display in pixels, read from the system details.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "int", + "description": "The width of the display", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "bitmap", - "description": "the bitmap to draw the ellipse on", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The distance from the left of the bitmap or bitmap to the\nleft edge of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The distance from the top of the bitmap or bitmap to the\ntop edge of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "width": { - "type": "double", - "description": "The width of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "height": { - "type": "double", - "description": "The height of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "The drawing options", + "disp": { + "type": "display", + "description": "The display details", "is_pointer": false, "is_const": false, "is_reference": false, @@ -28898,169 +28180,102 @@ } }, "attributes": { - "class": "bitmap", - "method": "fill_ellipse", - "suffix": "with_options", + "class": "display", + "getter": "width", "group": "graphics", - "self": "destination" + "self": "disp" }, "signatures": { - "python": [ - "def fill_ellipse_on_bitmap_with_options(destination, clr, x, y, width, height, opts):" - ], "cpp": [ - "void fill_ellipse_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height, drawing_options opts)" + "int display_width(display disp)" + ], + "python": [ + "def display_width(disp):" ], "csharp": [ - "public void Bitmap.FillEllipse(Color clr, double x, double y, double width, double height, DrawingOptions opts);", - "public static void SplashKit.FillEllipseOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);" + "public int Display.Width { get }", + "public static int SplashKit.DisplayWidth(Display disp);" ], "pascal": [ - "procedure FillEllipseOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)" + "function DisplayWidth(disp: Display): Integer" ] } }, { - "signature": "void fill_ellipse_on_window(window destination,color clr,const rectangle rect);", - "name": "fill_ellipse_on_window", - "method_name": "fill_ellipse", - "unique_global_name": "fill_ellipse_on_window_within_rectangle", - "unique_method_name": "window.fill_ellipse_within_rectangle", + "signature": "int display_x(display disp);", + "name": "display_x", + "method_name": null, + "unique_global_name": "display_x", + "unique_method_name": null, "suffix_name": null, - "description": "Fill an ellipse on the given window, using the provided location, and size.", + "description": "Return a relative x location for the display in pixels, read from the\nsystem details. This can be used to work out the arrangement of displays.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "int", + "description": "The x location of the display", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "the window to draw the ellipse on", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the ellipse", + "disp": { + "type": "display", + "description": "The display details", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "Indicates the location and size of the ellipse", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "window", - "method": "fill_ellipse", - "suffix": "within_rectangle", + "class": "display", + "getter": "x", "group": "graphics", - "self": "destination" + "self": "disp" }, "signatures": { - "python": [ - "def fill_ellipse_on_window_within_rectangle(destination, clr, rect):" - ], "cpp": [ - "void fill_ellipse_on_window(window destination, color clr, const rectangle rect)" + "int display_x(display disp)" + ], + "python": [ + "def display_x(disp):" ], "csharp": [ - "public void Window.FillEllipse(Color clr, Rectangle rect);", - "public static void SplashKit.FillEllipseOnWindow(Window destination, Color clr, Rectangle rect);" + "public int Display.X { get }", + "public static int SplashKit.DisplayX(Display disp);" ], "pascal": [ - "procedure FillEllipseOnWindow(destination: Window; clr: Color; rect: Rectangle)" + "function DisplayX(disp: Display): Integer" ] } }, { - "signature": "void fill_ellipse_on_window(window destination,color clr,const rectangle rect,drawing_options opts);", - "name": "fill_ellipse_on_window", - "method_name": "fill_ellipse", - "unique_global_name": "fill_ellipse_on_window_within_rectangle_with_options", - "unique_method_name": "window.fill_ellipse_within_rectangle_with_options", + "signature": "int display_y(display disp);", + "name": "display_y", + "method_name": null, + "unique_global_name": "display_y", + "unique_method_name": null, "suffix_name": null, - "description": "Fills an ellipse on the given window, using the provided location, size, and drawing options.\n\nAt this stage ellipse drawing is not affected by line width from the\ndrawing options.", + "description": "Return a relative y location for the display in pixels, read from the\nsystem details. This can be used to work out the arrangement of displays.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "int", + "description": "The y location of the display", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "the window to draw the ellipse on", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "Indicates the location and size of the ellipse", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "The drawing options", + "disp": { + "type": "display", + "description": "The display details", "is_pointer": false, "is_const": false, "is_reference": false, @@ -29073,37 +28288,73 @@ } }, "attributes": { - "class": "window", - "method": "fill_ellipse", - "suffix": "within_rectangle_with_options", + "class": "display", + "getter": "y", "group": "graphics", - "self": "destination" + "self": "disp" }, "signatures": { + "cpp": [ + "int display_y(display disp)" + ], "python": [ - "def fill_ellipse_on_window_within_rectangle_with_options(destination, clr, rect, opts):" + "def display_y(disp):" + ], + "csharp": [ + "public int Display.Y { get }", + "public static int SplashKit.DisplayY(Display disp);" ], + "pascal": [ + "function DisplayY(disp: Display): Integer" + ] + } + }, + { + "signature": "int number_of_displays();", + "name": "number_of_displays", + "method_name": null, + "unique_global_name": "number_of_displays", + "unique_method_name": null, + "suffix_name": null, + "description": "Returns the number of physical displays attached to the computer.", + "brief": null, + "return": { + "type": "int", + "description": "The number of displays attached to the computer", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + }, + "attributes": { + "group": "graphics" + }, + "signatures": { "cpp": [ - "void fill_ellipse_on_window(window destination, color clr, const rectangle rect, drawing_options opts)" + "int number_of_displays()" + ], + "python": [ + "def number_of_displays():" ], "csharp": [ - "public void Window.FillEllipse(Color clr, Rectangle rect, DrawingOptions opts);", - "public static void SplashKit.FillEllipseOnWindow(Window destination, Color clr, Rectangle rect, DrawingOptions opts);" + "public static int SplashKit.NumberOfDisplays();" ], "pascal": [ - "procedure FillEllipseOnWindow(destination: Window; clr: Color; rect: Rectangle; opts: DrawingOptions)" + "function NumberOfDisplays(): Integer" ] } }, { - "signature": "void fill_ellipse_on_window(window destination,color clr,double x,double y,double width,double height);", - "name": "fill_ellipse_on_window", - "method_name": "fill_ellipse", - "unique_global_name": "fill_ellipse_on_window", - "unique_method_name": "window.fill_ellipse", + "signature": "void refresh_screen();", + "name": "refresh_screen", + "method_name": null, + "unique_global_name": "refresh_screen", + "unique_method_name": null, "suffix_name": null, - "description": "Fills an ellipse on the given window, using the provided location, and size.", - "brief": null, + "description": null, + "brief": "Refreshes the current drawing on all open windows.", "return": { "type": "void", "description": null, @@ -29113,115 +28364,33 @@ "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "the window to draw the ellipse on", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The distance from the left of the bitmap or window to the\nleft edge of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The distance from the top of the bitmap or window to the\ntop edge of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "width": { - "type": "double", - "description": "The width of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "height": { - "type": "double", - "description": "The height of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { - "class": "window", - "method": "fill_ellipse", - "group": "graphics", - "self": "destination" + "group": "graphics" }, "signatures": { - "python": [ - "def fill_ellipse_on_window(destination, clr, x, y, width, height):" - ], "cpp": [ - "void fill_ellipse_on_window(window destination, color clr, double x, double y, double width, double height)" + "void refresh_screen()" + ], + "python": [ + "def refresh_screen():" ], "csharp": [ - "public void Window.FillEllipse(Color clr, double x, double y, double width, double height);", - "public static void SplashKit.FillEllipseOnWindow(Window destination, Color clr, double x, double y, double width, double height);" + "public static void SplashKit.RefreshScreen();" ], "pascal": [ - "procedure FillEllipseOnWindow(destination: Window; clr: Color; x: Double; y: Double; width: Double; height: Double)" + "procedure RefreshScreen()" ] } }, { - "signature": "void fill_ellipse_on_window(window destination,color clr,double x,double y,double width,double height,drawing_options opts);", - "name": "fill_ellipse_on_window", - "method_name": "fill_ellipse", - "unique_global_name": "fill_ellipse_on_window_with_options", - "unique_method_name": "window.fill_ellipse_with_options", + "signature": "void refresh_screen(unsigned int target_fps);", + "name": "refresh_screen", + "method_name": null, + "unique_global_name": "refresh_screen_with_target_fps", + "unique_method_name": null, "suffix_name": null, - "description": "Fills an ellipse on the given window, using the provided location, size, and drawing options.", + "description": "Refreshes all open windows with a target FPS (frames per second). This will\ndelay a period of time that will approximately meet the targeted frames per\nsecond.", "brief": null, "return": { "type": "void", @@ -29232,9 +28401,9 @@ "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "the window to draw the ellipse on", + "target_fps": { + "type": "unsigned int", + "description": "The targeted frames per second to refresh the screen at.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -29244,62 +28413,48 @@ ], "is_vector": false, "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The distance from the left of the bitmap or window to the\nleft edge of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The distance from the top of the bitmap or window to the\ntop edge of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "width": { - "type": "double", - "description": "The width of the ellipse", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "height": { - "type": "double", - "description": "The height of the ellipse", + } + }, + "attributes": { + "suffix": "with_target_fps", + "group": "graphics" + }, + "signatures": { + "cpp": [ + "void refresh_screen(unsigned int target_fps)" + ], + "python": [ + "def refresh_screen_with_target_fps(target_fps):" + ], + "csharp": [ + "public static void SplashKit.RefreshScreen(uint targetFps);" + ], + "pascal": [ + "procedure RefreshScreen(targetFps: Cardinal)" + ] + } + }, + { + "signature": "void save_bitmap(bitmap bmp,const string &basename);", + "name": "save_bitmap", + "method_name": null, + "unique_global_name": "save_bitmap", + "unique_method_name": null, + "suffix_name": null, + "description": "Save the bitmap to the user's desktop.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "bmp": { + "type": "bitmap", + "description": "The bitmap to save", "is_pointer": false, "is_const": false, "is_reference": false, @@ -29310,12 +28465,12 @@ "is_vector": false, "type_parameter": null }, - "opts": { - "type": "drawing_options", - "description": "The drawing options", + "basename": { + "type": "string", + "description": "The base of the filename. If there is a file of this name\nalready, then the name will be changed to generate a\nunique filename.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -29325,40 +28480,35 @@ } }, "attributes": { - "class": "window", - "method": "fill_ellipse", - "suffix": "with_options", - "group": "graphics", - "self": "destination" + "group": "graphics" }, "signatures": { - "python": [ - "def fill_ellipse_on_window_with_options(destination, clr, x, y, width, height, opts):" - ], "cpp": [ - "void fill_ellipse_on_window(window destination, color clr, double x, double y, double width, double height, drawing_options opts)" + "void save_bitmap(bitmap bmp, const string &basename)" + ], + "python": [ + "def save_bitmap(bmp, basename):" ], "csharp": [ - "public void Window.FillEllipse(Color clr, double x, double y, double width, double height, DrawingOptions opts);", - "public static void SplashKit.FillEllipseOnWindow(Window destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);" + "public static void SplashKit.SaveBitmap(Bitmap bmp, string basename);" ], "pascal": [ - "procedure FillEllipseOnWindow(destination: Window; clr: Color; x: Double; y: Double; width: Double; height: Double; opts: DrawingOptions)" + "procedure SaveBitmap(bmp: Bitmap; const basename: String)" ] } }, { - "signature": "void clear_screen();", - "name": "clear_screen", + "signature": "int screen_height();", + "name": "screen_height", "method_name": null, - "unique_global_name": "clear_screen_to_white", + "unique_global_name": "screen_height", "unique_method_name": null, "suffix_name": null, - "description": "Clears the current screen to color white.", + "description": "Returns the height of the current window.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "int", + "description": "The height of the current window.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -29367,98 +28517,84 @@ "parameters": { }, "attributes": { - "suffix": "to_white", "group": "graphics" }, "signatures": { - "python": [ - "def clear_screen_to_white():" - ], "cpp": [ - "void clear_screen()" + "int screen_height()" + ], + "python": [ + "def screen_height():" ], "csharp": [ - "public static void SplashKit.ClearScreen();" + "public static int SplashKit.ScreenHeight();" ], "pascal": [ - "procedure ClearScreen()" + "function ScreenHeight(): Integer" ] } }, { - "signature": "void clear_screen(color clr);", - "name": "clear_screen", + "signature": "int screen_width();", + "name": "screen_width", "method_name": null, - "unique_global_name": "clear_screen", + "unique_global_name": "screen_width", "unique_method_name": null, "suffix_name": null, - "description": null, - "brief": "Clears all open windows to the `clr` provided.", + "description": "Returns the width of the current window.", + "brief": null, "return": { - "type": "void", - "description": null, + "type": "int", + "description": "The width of the current window.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color to clear the screen's background color to.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { "group": "graphics" }, "signatures": { - "python": [ - "def clear_screen(clr):" - ], "cpp": [ - "void clear_screen(color clr)" + "int screen_width()" + ], + "python": [ + "def screen_width():" ], "csharp": [ - "public static void SplashKit.ClearScreen(Color clr);" + "public static int SplashKit.ScreenWidth();" ], "pascal": [ - "procedure ClearScreen(clr: Color)" + "function ScreenWidth(): Integer" ] } }, { - "signature": "display display_details(unsigned int index);", - "name": "display_details", + "signature": "void take_screenshot(const string &basename);", + "name": "take_screenshot", "method_name": null, - "unique_global_name": "display_details", + "unique_global_name": "take_screenshot", "unique_method_name": null, "suffix_name": null, - "description": "Returns the details about one of the displays attached to the computer.", + "description": "Saves a screenshot of the current window to a bitmap file. The file will\nbe saved onto the user's desktop.", "brief": null, "return": { - "type": "display", - "description": "The details of this display", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "index": { - "type": "unsigned int", - "description": "The display number (from 0 to `number_of_displays` - 1)", + "basename": { + "type": "string", + "description": "The base of the filename. If there is a file of this name\nalready, then the name will be changed to generate a\nunique filename.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -29471,149 +28607,173 @@ "group": "graphics" }, "signatures": { - "python": [ - "def display_details(index):" - ], "cpp": [ - "display display_details(unsigned int index)" + "void take_screenshot(const string &basename)" + ], + "python": [ + "def take_screenshot(basename):" ], "csharp": [ - "public static Display SplashKit.DisplayDetails(uint index);" + "public static void SplashKit.TakeScreenshot(string basename);" ], "pascal": [ - "function DisplayDetails(index: Cardinal): Display" + "procedure TakeScreenshot(const basename: String)" ] } }, { - "signature": "int display_height(display disp);", - "name": "display_height", + "signature": "void take_screenshot(window wind,const string &basename);", + "name": "take_screenshot", "method_name": null, - "unique_global_name": "display_height", + "unique_global_name": "take_screenshot_of_window", "unique_method_name": null, "suffix_name": null, - "description": "Return the height of the display in pixels, read from the system details.", + "description": "Saves a screenshot of the current window to a bitmap file. The file will\nbe saved onto the user's desktop.", "brief": null, "return": { - "type": "int", - "description": "The height of the display", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "disp": { - "type": "display", - "description": "The display details", + "wind": { + "type": "window", + "description": "The window to capture in the screenshot", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "basename": { + "type": "string", + "description": "The base of the filename. If there is a file of this name\nalready, then the name will be changed to generate a\nunique filename.", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "display", - "getter": "height", - "group": "graphics", - "self": "disp" + "suffix": "of_window", + "group": "graphics" }, "signatures": { - "python": [ - "def display_height(disp):" - ], "cpp": [ - "int display_height(display disp)" + "void take_screenshot(window wind, const string &basename)" + ], + "python": [ + "def take_screenshot_of_window(wind, basename):" ], "csharp": [ - "public int Display.Height { get }", - "public static int SplashKit.DisplayHeight(Display disp);" + "public static void SplashKit.TakeScreenshot(Window wind, string basename);" ], "pascal": [ - "function DisplayHeight(disp: Display): Integer" + "procedure TakeScreenshot(wind: Window; const basename: String)" ] } }, { - "signature": "string display_name(display disp);", - "name": "display_name", - "method_name": null, - "unique_global_name": "display_name", - "unique_method_name": null, + "signature": "circle bitmap_bounding_circle(bitmap bmp,const point_2d &pt);", + "name": "bitmap_bounding_circle", + "method_name": "bounding_circle", + "unique_global_name": "bitmap_bounding_circle", + "unique_method_name": "bitmap.bounding_circle", "suffix_name": null, - "description": "Return the name of the display, read from the system details.", + "description": "Returns a circle that will encompass the entire bitamp.", "brief": null, "return": { - "type": "string", - "description": "The name of the display", + "type": "circle", + "description": "A circle that surrounds the bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "disp": { - "type": "display", - "description": "The display details", + "bmp": { + "type": "bitmap", + "description": "The bitmap to encompass.", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "pt": { + "type": "point_2d", + "description": "The point where the bitmap is located.", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "display", - "getter": "name", + "class": "bitmap", + "method": "bounding_circle", "group": "graphics", - "self": "disp" + "static": "images", + "self": "bmp" }, "signatures": { - "python": [ - "def display_name(disp):" - ], "cpp": [ - "string display_name(display disp)" + "circle bitmap_bounding_circle(bitmap bmp, const point_2d &pt)" + ], + "python": [ + "def bitmap_bounding_circle(bmp, pt):" ], "csharp": [ - "public string Display.Name { get }", - "public static string SplashKit.DisplayName(Display disp);" + "public Circle Bitmap.BoundingCircle(Point2D pt);", + "public static Circle SplashKit.BitmapBoundingCircle(Bitmap bmp, Point2D pt);" ], "pascal": [ - "function DisplayName(disp: Display): String" + "function BitmapBoundingCircle(bmp: Bitmap; const pt: Point2D): Circle" ] } }, { - "signature": "int display_width(display disp);", - "name": "display_width", - "method_name": null, - "unique_global_name": "display_width", - "unique_method_name": null, + "signature": "rectangle bitmap_bounding_rectangle(bitmap bmp);", + "name": "bitmap_bounding_rectangle", + "method_name": "bounding_rectangle", + "unique_global_name": "bitmap_bounding_rectangle", + "unique_method_name": "bitmap.bounding_rectangle", "suffix_name": null, - "description": "Return the width of the display in pixels, read from the system details.", + "description": "Returns a rectangle that is the same size as a bitmap (the whole bitmap).", "brief": null, "return": { - "type": "int", - "description": "The width of the display", + "type": "rectangle", + "description": "A rectangle with the same size as the bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "disp": { - "type": "display", - "description": "The display details", + "bmp": { + "type": "bitmap", + "description": "The bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -29626,48 +28786,75 @@ } }, "attributes": { - "class": "display", - "getter": "width", + "class": "bitmap", + "method": "bounding_rectangle", "group": "graphics", - "self": "disp" + "static": "images", + "self": "bmp" }, "signatures": { - "python": [ - "def display_width(disp):" - ], "cpp": [ - "int display_width(display disp)" + "rectangle bitmap_bounding_rectangle(bitmap bmp)" + ], + "python": [ + "def bitmap_bounding_rectangle(bmp):" ], "csharp": [ - "public int Display.Width { get }", - "public static int SplashKit.DisplayWidth(Display disp);" + "public Rectangle Bitmap.BoundingRectangle();", + "public static Rectangle SplashKit.BitmapBoundingRectangle(Bitmap bmp);" ], "pascal": [ - "function DisplayWidth(disp: Display): Integer" + "function BitmapBoundingRectangle(bmp: Bitmap): Rectangle" ] } }, { - "signature": "int display_x(display disp);", - "name": "display_x", - "method_name": null, - "unique_global_name": "display_x", - "unique_method_name": null, + "signature": "rectangle bitmap_bounding_rectangle(bitmap bmp,double x,double y);", + "name": "bitmap_bounding_rectangle", + "method_name": "bounding_rectangle", + "unique_global_name": "bitmap_bounding_rectangle_at_location", + "unique_method_name": "bitmap.bounding_rectangle_at_location", "suffix_name": null, - "description": "Return a relative x location for the display in pixels, read from the\nsystem details. This can be used to work out the arrangement of displays.", + "description": "Returns a rectangle that is the same size as the bitmap and is located at\nthe indicated position.", "brief": null, "return": { - "type": "int", - "description": "The x location of the display", + "type": "rectangle", + "description": "A rectangle with the same size as the bitmap, at the\nindicated location.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "disp": { - "type": "display", - "description": "The display details", + "bmp": { + "type": "bitmap", + "description": "The bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x": { + "type": "double", + "description": "The x location of the rectangle", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y location of the rectangle", "is_pointer": false, "is_const": false, "is_reference": false, @@ -29680,48 +28867,50 @@ } }, "attributes": { - "class": "display", - "getter": "x", + "class": "bitmap", + "method": "bounding_rectangle", + "suffix": "at_location", "group": "graphics", - "self": "disp" + "static": "images", + "self": "bmp" }, "signatures": { - "python": [ - "def display_x(disp):" - ], "cpp": [ - "int display_x(display disp)" + "rectangle bitmap_bounding_rectangle(bitmap bmp, double x, double y)" + ], + "python": [ + "def bitmap_bounding_rectangle_at_location(bmp, x, y):" ], "csharp": [ - "public int Display.X { get }", - "public static int SplashKit.DisplayX(Display disp);" + "public Rectangle Bitmap.BoundingRectangle(double x, double y);", + "public static Rectangle SplashKit.BitmapBoundingRectangle(Bitmap bmp, double x, double y);" ], "pascal": [ - "function DisplayX(disp: Display): Integer" + "function BitmapBoundingRectangle(bmp: Bitmap; x: Double; y: Double): Rectangle" ] } }, { - "signature": "int display_y(display disp);", - "name": "display_y", + "signature": "point_2d bitmap_cell_center(bitmap bmp);", + "name": "bitmap_cell_center", "method_name": null, - "unique_global_name": "display_y", + "unique_global_name": "bitmap_cell_center", "unique_method_name": null, "suffix_name": null, - "description": "Return a relative y location for the display in pixels, read from the\nsystem details. This can be used to work out the arrangement of displays.", + "description": "This returns a point that represents the center of a cell from this\nbitmap in local space.", "brief": null, "return": { - "type": "int", - "description": "The y location of the display", + "type": "point_2d", + "description": "A point in the center of a cell for this bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "disp": { - "type": "display", - "description": "The display details", + "bmp": { + "type": "bitmap", + "description": "The bitmap to get the center of.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -29734,164 +28923,190 @@ } }, "attributes": { - "class": "display", - "getter": "y", + "class": "bitmap", + "getter": "cell_center", "group": "graphics", - "self": "disp" + "static": "images", + "self": "bmp" }, "signatures": { - "python": [ - "def display_y(disp):" - ], "cpp": [ - "int display_y(display disp)" + "point_2d bitmap_cell_center(bitmap bmp)" + ], + "python": [ + "def bitmap_cell_center(bmp):" ], "csharp": [ - "public int Display.Y { get }", - "public static int SplashKit.DisplayY(Display disp);" + "public Point2D Bitmap.CellCenter { get }", + "public static Point2D SplashKit.BitmapCellCenter(Bitmap bmp);" ], "pascal": [ - "function DisplayY(disp: Display): Integer" + "function BitmapCellCenter(bmp: Bitmap): Point2D" ] } }, { - "signature": "int number_of_displays();", - "name": "number_of_displays", - "method_name": null, - "unique_global_name": "number_of_displays", - "unique_method_name": null, + "signature": "circle bitmap_cell_circle(bitmap bmp,double x,double y);", + "name": "bitmap_cell_circle", + "method_name": "cell_circle", + "unique_global_name": "bitmap_cell_circle", + "unique_method_name": "bitmap.cell_circle", "suffix_name": null, - "description": "Returns the number of physical displays attached to the computer.", + "description": "Returns a circle that will encompass the bitmap cell if it were drawn\nat the indicated point.", "brief": null, "return": { - "type": "int", - "description": "The number of displays attached to the computer", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "graphics" - }, - "signatures": { - "python": [ - "def number_of_displays():" - ], - "cpp": [ - "int number_of_displays()" - ], - "csharp": [ - "public static int SplashKit.NumberOfDisplays();" - ], - "pascal": [ - "function NumberOfDisplays(): Integer" - ] - } - }, - { - "signature": "void refresh_screen();", - "name": "refresh_screen", - "method_name": null, - "unique_global_name": "refresh_screen", - "unique_method_name": null, - "suffix_name": null, - "description": null, - "brief": "Refreshes the current drawing on all open windows.", - "return": { - "type": "void", - "description": null, + "type": "circle", + "description": "A circle that will encompass the bitmap cell.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "bmp": { + "type": "bitmap", + "description": "The bitmap to get the details from.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x": { + "type": "double", + "description": "The the x location of the bitmap.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The the y location of the bitmap.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { - "group": "graphics" + "class": "bitmap", + "method": "cell_circle", + "group": "graphics", + "static": "images", + "self": "bmp" }, "signatures": { - "python": [ - "def refresh_screen():" - ], "cpp": [ - "void refresh_screen()" + "circle bitmap_cell_circle(bitmap bmp, double x, double y)" + ], + "python": [ + "def bitmap_cell_circle(bmp, x, y):" ], "csharp": [ - "public static void SplashKit.RefreshScreen();" + "public Circle Bitmap.CellCircle(double x, double y);", + "public static Circle SplashKit.BitmapCellCircle(Bitmap bmp, double x, double y);" ], "pascal": [ - "procedure RefreshScreen()" + "function BitmapCellCircle(bmp: Bitmap; x: Double; y: Double): Circle" ] } }, { - "signature": "void refresh_screen(unsigned int target_fps);", - "name": "refresh_screen", - "method_name": null, - "unique_global_name": "refresh_screen_with_target_fps", - "unique_method_name": null, + "signature": "circle bitmap_cell_circle(bitmap bmp,const point_2d pt);", + "name": "bitmap_cell_circle", + "method_name": "cell_circle", + "unique_global_name": "bitmap_cell_circle_at_point", + "unique_method_name": "bitmap.cell_circle_at_point", "suffix_name": null, - "description": "Refreshes all open windows with a target FPS (frames per second). This will\ndelay a period of time that will approximately meet the targeted frames per\nsecond.", + "description": "Returns a circle that will encompass the bitmap cell if it were drawn\nat the indicated point.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "circle", + "description": "A circle that will encompass the bitmap cell.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "target_fps": { - "type": "unsigned int", - "description": "The targeted frames per second to refresh the screen at.", + "bmp": { + "type": "bitmap", + "description": "The bitmap to get the details from.", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "pt": { + "type": "point_2d", + "description": "The point indicating the location of the bitmap.", + "is_pointer": false, + "is_const": true, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { - "suffix": "with_target_fps", - "group": "graphics" + "class": "bitmap", + "method": "cell_circle", + "suffix": "at_point", + "group": "graphics", + "static": "images", + "self": "bmp" }, "signatures": { - "python": [ - "def refresh_screen_with_target_fps(target_fps):" - ], "cpp": [ - "void refresh_screen(unsigned int target_fps)" + "circle bitmap_cell_circle(bitmap bmp, const point_2d pt)" + ], + "python": [ + "def bitmap_cell_circle_at_point(bmp, pt):" ], "csharp": [ - "public static void SplashKit.RefreshScreen(uint targetFps);" + "public Circle Bitmap.CellCircle(Point2D pt);", + "public static Circle SplashKit.BitmapCellCircle(Bitmap bmp, Point2D pt);" ], "pascal": [ - "procedure RefreshScreen(targetFps: Cardinal)" + "function BitmapCellCircle(bmp: Bitmap; pt: Point2D): Circle" ] } }, { - "signature": "void save_bitmap(bitmap bmp,const string &basename);", - "name": "save_bitmap", - "method_name": null, - "unique_global_name": "save_bitmap", - "unique_method_name": null, + "signature": "circle bitmap_cell_circle(bitmap bmp,const point_2d pt,double scale);", + "name": "bitmap_cell_circle", + "method_name": "cell_circle", + "unique_global_name": "bitmap_cell_circle_at_point_with_scale", + "unique_method_name": "bitmap.cell_circle_at_point_with_scale", "suffix_name": null, - "description": "Save the bitmap to the user's desktop.", + "description": "Returns a circle that will encompass the bitmap cell if it were drawn\nat the indicated point, with the provided scale.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "circle", + "description": "A circle that will encompass the bitmap cell.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -29900,7 +29115,7 @@ "parameters": { "bmp": { "type": "bitmap", - "description": "The bitmap to save", + "description": "The bitmap to get the details from.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -29911,12 +29126,25 @@ "is_vector": false, "type_parameter": null }, - "basename": { - "type": "string", - "description": "The base of the filename. If there is a file of this name\nalready, then the name will be changed to generate a\nunique filename.", + "pt": { + "type": "point_2d", + "description": "The point indicating the location of the bitmap.", "is_pointer": false, "is_const": true, - "is_reference": true, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "scale": { + "type": "double", + "description": "The scaling factor for the bitmap drawing.", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -29926,121 +29154,163 @@ } }, "attributes": { - "group": "graphics" + "class": "bitmap", + "method": "cell_circle", + "suffix": "at_point_with_scale", + "group": "graphics", + "static": "images", + "self": "bmp" }, "signatures": { - "python": [ - "def save_bitmap(bmp, basename):" - ], "cpp": [ - "void save_bitmap(bitmap bmp, const string &basename)" + "circle bitmap_cell_circle(bitmap bmp, const point_2d pt, double scale)" + ], + "python": [ + "def bitmap_cell_circle_at_point_with_scale(bmp, pt, scale):" ], "csharp": [ - "public static void SplashKit.SaveBitmap(Bitmap bmp, string basename);" + "public Circle Bitmap.CellCircle(Point2D pt, double scale);", + "public static Circle SplashKit.BitmapCellCircle(Bitmap bmp, Point2D pt, double scale);" ], "pascal": [ - "procedure SaveBitmap(bmp: Bitmap; const basename: String)" + "function BitmapCellCircle(bmp: Bitmap; pt: Point2D; scale: Double): Circle" ] } }, { - "signature": "int screen_height();", - "name": "screen_height", + "signature": "int bitmap_cell_columns(bitmap bmp);", + "name": "bitmap_cell_columns", "method_name": null, - "unique_global_name": "screen_height", + "unique_global_name": "bitmap_cell_columns", "unique_method_name": null, "suffix_name": null, - "description": "Returns the height of the current window.", + "description": "Returns the number of cell columns in the bitmap.\nThis is setup using `bitmap_set_cell_details`", "brief": null, "return": { "type": "int", - "description": "The height of the current window.", + "description": "The number of cell columns", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "bmp": { + "type": "bitmap", + "description": "The bitmap to check", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { - "group": "graphics" + "class": "bitmap", + "getter": "cell_columns", + "group": "graphics", + "static": "images", + "self": "bmp" }, "signatures": { - "python": [ - "def screen_height():" - ], "cpp": [ - "int screen_height()" + "int bitmap_cell_columns(bitmap bmp)" + ], + "python": [ + "def bitmap_cell_columns(bmp):" ], "csharp": [ - "public static int SplashKit.ScreenHeight();" + "public int Bitmap.CellColumns { get }", + "public static int SplashKit.BitmapCellColumns(Bitmap bmp);" ], "pascal": [ - "function ScreenHeight(): Integer" + "function BitmapCellColumns(bmp: Bitmap): Integer" ] } }, { - "signature": "int screen_width();", - "name": "screen_width", + "signature": "int bitmap_cell_count(bitmap bmp);", + "name": "bitmap_cell_count", "method_name": null, - "unique_global_name": "screen_width", + "unique_global_name": "bitmap_cell_count", "unique_method_name": null, "suffix_name": null, - "description": "Returns the width of the current window.", + "description": "Returns the number of cells within the bitmap.", "brief": null, "return": { "type": "int", - "description": "The width of the current window.", + "description": "The number of individual cells within the bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "bmp": { + "type": "bitmap", + "description": "The bitmap to check.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { - "group": "graphics" + "class": "bitmap", + "getter": "cell_count", + "group": "graphics", + "static": "images", + "self": "bmp" }, "signatures": { - "python": [ - "def screen_width():" - ], "cpp": [ - "int screen_width()" + "int bitmap_cell_count(bitmap bmp)" + ], + "python": [ + "def bitmap_cell_count(bmp):" ], "csharp": [ - "public static int SplashKit.ScreenWidth();" + "public int Bitmap.CellCount { get }", + "public static int SplashKit.BitmapCellCount(Bitmap bmp);" ], "pascal": [ - "function ScreenWidth(): Integer" + "function BitmapCellCount(bmp: Bitmap): Integer" ] } }, { - "signature": "void take_screenshot(const string &basename);", - "name": "take_screenshot", + "signature": "int bitmap_cell_height(bitmap bmp);", + "name": "bitmap_cell_height", "method_name": null, - "unique_global_name": "take_screenshot", + "unique_global_name": "bitmap_cell_height", "unique_method_name": null, "suffix_name": null, - "description": "Saves a screenshot of the current window to a bitmap file. The file will\nbe saved onto the user's desktop.", + "description": "Returns the height of each cell in this bitmap.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "int", + "description": "The height of each cells in bmp", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "basename": { - "type": "string", - "description": "The base of the filename. If there is a file of this name\nalready, then the name will be changed to generate a\nunique filename.", + "bmp": { + "type": "bitmap", + "description": "The bitmap to get the details from.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -30050,44 +29320,49 @@ } }, "attributes": { - "group": "graphics" + "class": "bitmap", + "getter": "cell_height", + "group": "graphics", + "static": "images", + "self": "bmp" }, "signatures": { - "python": [ - "def take_screenshot(basename):" - ], "cpp": [ - "void take_screenshot(const string &basename)" + "int bitmap_cell_height(bitmap bmp)" + ], + "python": [ + "def bitmap_cell_height(bmp):" ], "csharp": [ - "public static void SplashKit.TakeScreenshot(string basename);" + "public int Bitmap.CellHeight { get }", + "public static int SplashKit.BitmapCellHeight(Bitmap bmp);" ], "pascal": [ - "procedure TakeScreenshot(const basename: String)" + "function BitmapCellHeight(bmp: Bitmap): Integer" ] } }, { - "signature": "void take_screenshot(window wind,const string &basename);", - "name": "take_screenshot", - "method_name": "take_screenshot", - "unique_global_name": "take_screenshot_of_window", - "unique_method_name": "window.take_screenshot_of_window", + "signature": "vector_2d bitmap_cell_offset(bitmap src,int cell);", + "name": "bitmap_cell_offset", + "method_name": "cell_offset", + "unique_global_name": "bitmap_cell_offset", + "unique_method_name": "bitmap.cell_offset", "suffix_name": null, - "description": "Saves a screenshot of the current window to a bitmap file. The file will\nbe saved onto the user's desktop.", + "description": "Returns a vector that represents the movement needed to get to a given\ncell within a bitmap.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "vector_2d", + "description": "The offset needed to get to the cell from the top left of the bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "wind": { - "type": "window", - "description": "The window to capture in the screenshot", + "src": { + "type": "bitmap", + "description": "The bitmap with the cell details.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -30098,12 +29373,12 @@ "is_vector": false, "type_parameter": null }, - "basename": { - "type": "string", - "description": "The base of the filename. If there is a file of this name\nalready, then the name will be changed to generate a\nunique filename.", + "cell": { + "type": "int", + "description": "The index of the cell", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -30113,49 +29388,104 @@ } }, "attributes": { - "class": "window", - "method": "take_screenshot", - "self": "wind", - "suffix": "of_window", - "group": "graphics" + "class": "bitmap", + "method": "cell_offset", + "group": "graphics", + "static": "images", + "self": "src" }, "signatures": { + "cpp": [ + "vector_2d bitmap_cell_offset(bitmap src, int cell)" + ], "python": [ - "def take_screenshot_of_window(wind, basename):" + "def bitmap_cell_offset(src, cell):" + ], + "csharp": [ + "public Vector2D Bitmap.CellOffset(int cell);", + "public static Vector2D SplashKit.BitmapCellOffset(Bitmap src, int cell);" ], + "pascal": [ + "function BitmapCellOffset(src: Bitmap; cell: Integer): Vector2D" + ] + } + }, + { + "signature": "rectangle bitmap_cell_rectangle(bitmap src);", + "name": "bitmap_cell_rectangle", + "method_name": "cell_rectangle", + "unique_global_name": "bitmap_cell_rectangle", + "unique_method_name": "bitmap.cell_rectangle", + "suffix_name": null, + "description": "Returns a rectangle that will encompass a cell of the bitmap.", + "brief": null, + "return": { + "type": "rectangle", + "description": "A rectangle with width and height from the bitmap's cell details.", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "src": { + "type": "bitmap", + "description": "The bitmap to get the details from", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } + }, + "attributes": { + "class": "bitmap", + "method": "cell_rectangle", + "group": "graphics", + "static": "images", + "self": "src" + }, + "signatures": { "cpp": [ - "void take_screenshot(window wind, const string &basename)" + "rectangle bitmap_cell_rectangle(bitmap src)" + ], + "python": [ + "def bitmap_cell_rectangle(src):" ], "csharp": [ - "public void Window.TakeScreenshot(string basename);", - "public static void SplashKit.TakeScreenshot(Window wind, string basename);" + "public Rectangle Bitmap.CellRectangle();", + "public static Rectangle SplashKit.BitmapCellRectangle(Bitmap src);" ], "pascal": [ - "procedure TakeScreenshot(wind: Window; const basename: String)" + "function BitmapCellRectangle(src: Bitmap): Rectangle" ] } }, { - "signature": "circle bitmap_bounding_circle(bitmap bmp,const point_2d &pt);", - "name": "bitmap_bounding_circle", - "method_name": "bounding_circle", - "unique_global_name": "bitmap_bounding_circle", - "unique_method_name": "bitmap.bounding_circle", + "signature": "rectangle bitmap_cell_rectangle(bitmap src,const point_2d &pt);", + "name": "bitmap_cell_rectangle", + "method_name": "cell_rectangle", + "unique_global_name": "bitmap_cell_rectangle_at_point", + "unique_method_name": "bitmap.cell_rectangle_at_point", "suffix_name": null, - "description": "Returns a circle that will encompass the entire bitamp.", + "description": "Returns a rectangle that will encompass the bitmap cell if it were drawn\nat the indicated point.", "brief": null, "return": { - "type": "circle", - "description": "A circle that surrounds the bitmap.", + "type": "rectangle", + "description": "A rectangle at pt, with width and height from the bitmap's cell details.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { + "src": { "type": "bitmap", - "description": "The bitmap to encompass.", + "description": "The bitmap to get the details from", "is_pointer": false, "is_const": false, "is_reference": false, @@ -30168,7 +29498,7 @@ }, "pt": { "type": "point_2d", - "description": "The point where the bitmap is located.", + "description": "The point details for the rectangle.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -30182,39 +29512,40 @@ }, "attributes": { "class": "bitmap", - "method": "bounding_circle", + "method": "cell_rectangle", + "suffix": "at_point", "group": "graphics", "static": "images", - "self": "bmp" + "self": "src" }, "signatures": { - "python": [ - "def bitmap_bounding_circle(bmp, pt):" - ], "cpp": [ - "circle bitmap_bounding_circle(bitmap bmp, const point_2d &pt)" + "rectangle bitmap_cell_rectangle(bitmap src, const point_2d &pt)" + ], + "python": [ + "def bitmap_cell_rectangle_at_point(src, pt):" ], "csharp": [ - "public Circle Bitmap.BoundingCircle(Point2D pt);", - "public static Circle SplashKit.BitmapBoundingCircle(Bitmap bmp, Point2D pt);" + "public Rectangle Bitmap.CellRectangle(Point2D pt);", + "public static Rectangle SplashKit.BitmapCellRectangle(Bitmap src, Point2D pt);" ], "pascal": [ - "function BitmapBoundingCircle(bmp: Bitmap; const pt: Point2D): Circle" + "function BitmapCellRectangle(src: Bitmap; const pt: Point2D): Rectangle" ] } }, { - "signature": "rectangle bitmap_bounding_rectangle(bitmap bmp);", - "name": "bitmap_bounding_rectangle", - "method_name": "bounding_rectangle", - "unique_global_name": "bitmap_bounding_rectangle", - "unique_method_name": "bitmap.bounding_rectangle", + "signature": "int bitmap_cell_rows(bitmap bmp);", + "name": "bitmap_cell_rows", + "method_name": null, + "unique_global_name": "bitmap_cell_rows", + "unique_method_name": null, "suffix_name": null, - "description": "Returns a rectangle that is the same size as a bitmap (the whole bitmap).", + "description": "Returns the number of rows of cells in the bitmap. These details are set in\n`bitmap_set_cell_details`.", "brief": null, "return": { - "type": "rectangle", - "description": "A rectangle with the same size as the bitmap.", + "type": "int", + "description": "The number of rows of cells in the bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -30223,7 +29554,7 @@ "parameters": { "bmp": { "type": "bitmap", - "description": "The bitmap", + "description": "The bitmap to get the details from.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -30237,39 +29568,39 @@ }, "attributes": { "class": "bitmap", - "method": "bounding_rectangle", + "getter": "cell_rows", "group": "graphics", "static": "images", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_bounding_rectangle(bmp):" - ], "cpp": [ - "rectangle bitmap_bounding_rectangle(bitmap bmp)" + "int bitmap_cell_rows(bitmap bmp)" + ], + "python": [ + "def bitmap_cell_rows(bmp):" ], "csharp": [ - "public Rectangle Bitmap.BoundingRectangle();", - "public static Rectangle SplashKit.BitmapBoundingRectangle(Bitmap bmp);" + "public int Bitmap.CellRows { get }", + "public static int SplashKit.BitmapCellRows(Bitmap bmp);" ], "pascal": [ - "function BitmapBoundingRectangle(bmp: Bitmap): Rectangle" + "function BitmapCellRows(bmp: Bitmap): Integer" ] } }, { - "signature": "rectangle bitmap_bounding_rectangle(bitmap bmp,double x,double y);", - "name": "bitmap_bounding_rectangle", - "method_name": "bounding_rectangle", - "unique_global_name": "bitmap_bounding_rectangle_at_location", - "unique_method_name": "bitmap.bounding_rectangle_at_location", + "signature": "int bitmap_cell_width(bitmap bmp);", + "name": "bitmap_cell_width", + "method_name": null, + "unique_global_name": "bitmap_cell_width", + "unique_method_name": null, "suffix_name": null, - "description": "Returns a rectangle that is the same size as the bitmap and is located at\nthe indicated position.", + "description": "Returns the width of each cell in this bitmap.", "brief": null, "return": { - "type": "rectangle", - "description": "A rectangle with the same size as the bitmap, at the\nindicated location.", + "type": "int", + "description": "The width of each cells in bmp", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -30278,33 +29609,7 @@ "parameters": { "bmp": { "type": "bitmap", - "description": "The bitmap", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The x location of the rectangle", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location of the rectangle", + "description": "The bitmap to get the details from.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -30318,40 +29623,39 @@ }, "attributes": { "class": "bitmap", - "method": "bounding_rectangle", - "suffix": "at_location", + "getter": "cell_width", "group": "graphics", "static": "images", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_bounding_rectangle_at_location(bmp, x, y):" - ], "cpp": [ - "rectangle bitmap_bounding_rectangle(bitmap bmp, double x, double y)" + "int bitmap_cell_width(bitmap bmp)" + ], + "python": [ + "def bitmap_cell_width(bmp):" ], "csharp": [ - "public Rectangle Bitmap.BoundingRectangle(double x, double y);", - "public static Rectangle SplashKit.BitmapBoundingRectangle(Bitmap bmp, double x, double y);" + "public int Bitmap.CellWidth { get }", + "public static int SplashKit.BitmapCellWidth(Bitmap bmp);" ], "pascal": [ - "function BitmapBoundingRectangle(bmp: Bitmap; x: Double; y: Double): Rectangle" + "function BitmapCellWidth(bmp: Bitmap): Integer" ] } }, { - "signature": "point_2d bitmap_cell_center(bitmap bmp);", - "name": "bitmap_cell_center", + "signature": "point_2d bitmap_center(bitmap bmp);", + "name": "bitmap_center", "method_name": null, - "unique_global_name": "bitmap_cell_center", + "unique_global_name": "bitmap_center", "unique_method_name": null, "suffix_name": null, - "description": "This returns a point that represents the center of a cell from this\nbitmap in local space.", + "description": "This returns a point that represents the center of the bitmap in local\nspace.", "brief": null, "return": { "type": "point_2d", - "description": "A point in the center of a cell for this bitmap.", + "description": "A point in the center of the bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -30374,39 +29678,39 @@ }, "attributes": { "class": "bitmap", - "getter": "cell_center", + "getter": "center", "group": "graphics", "static": "images", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_cell_center(bmp):" - ], "cpp": [ - "point_2d bitmap_cell_center(bitmap bmp)" + "point_2d bitmap_center(bitmap bmp)" + ], + "python": [ + "def bitmap_center(bmp):" ], "csharp": [ - "public Point2D Bitmap.CellCenter { get }", - "public static Point2D SplashKit.BitmapCellCenter(Bitmap bmp);" + "public Point2D Bitmap.Center { get }", + "public static Point2D SplashKit.BitmapCenter(Bitmap bmp);" ], "pascal": [ - "function BitmapCellCenter(bmp: Bitmap): Point2D" + "function BitmapCenter(bmp: Bitmap): Point2D" ] } }, { - "signature": "circle bitmap_cell_circle(bitmap bmp,double x,double y);", - "name": "bitmap_cell_circle", - "method_name": "cell_circle", - "unique_global_name": "bitmap_cell_circle", - "unique_method_name": "bitmap.cell_circle", + "signature": "string bitmap_filename(bitmap bmp);", + "name": "bitmap_filename", + "method_name": null, + "unique_global_name": "bitmap_filename", + "unique_method_name": null, "suffix_name": null, - "description": "Returns a circle that will encompass the bitmap cell if it were drawn\nat the indicated point.", + "description": "Returns the filename from which the bitmap was loaded. This will be an empty\nstring for created bitmaps.", "brief": null, "return": { - "type": "circle", - "description": "A circle that will encompass the bitmap cell.", + "type": "string", + "description": "The file name of the bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -30415,33 +29719,7 @@ "parameters": { "bmp": { "type": "bitmap", - "description": "The bitmap to get the details from.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The the x location of the bitmap.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The the y location of the bitmap.", + "description": "The bitmap to get the filename from.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -30455,39 +29733,39 @@ }, "attributes": { "class": "bitmap", - "method": "cell_circle", + "getter": "filename", "group": "graphics", "static": "images", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_cell_circle(bmp, x, y):" - ], "cpp": [ - "circle bitmap_cell_circle(bitmap bmp, double x, double y)" + "string bitmap_filename(bitmap bmp)" + ], + "python": [ + "def bitmap_filename(bmp):" ], "csharp": [ - "public Circle Bitmap.CellCircle(double x, double y);", - "public static Circle SplashKit.BitmapCellCircle(Bitmap bmp, double x, double y);" + "public string Bitmap.Filename { get }", + "public static string SplashKit.BitmapFilename(Bitmap bmp);" ], "pascal": [ - "function BitmapCellCircle(bmp: Bitmap; x: Double; y: Double): Circle" + "function BitmapFilename(bmp: Bitmap): String" ] } }, { - "signature": "circle bitmap_cell_circle(bitmap bmp,const point_2d pt);", - "name": "bitmap_cell_circle", - "method_name": "cell_circle", - "unique_global_name": "bitmap_cell_circle_at_point", - "unique_method_name": "bitmap.cell_circle_at_point", + "signature": "int bitmap_height(bitmap bmp);", + "name": "bitmap_height", + "method_name": null, + "unique_global_name": "bitmap_height", + "unique_method_name": null, "suffix_name": null, - "description": "Returns a circle that will encompass the bitmap cell if it were drawn\nat the indicated point.", + "description": "Returns the total height of the bitmap. If the bitmap contains cells, you ca\nget the height of a cell using `bitmap_cell_height`.", "brief": null, "return": { - "type": "circle", - "description": "A circle that will encompass the bitmap cell.", + "type": "int", + "description": "The height of the bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -30503,19 +29781,6 @@ "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "pt": { - "type": "point_2d", - "description": "The point indicating the location of the bitmap.", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null @@ -30523,75 +29788,48 @@ }, "attributes": { "class": "bitmap", - "method": "cell_circle", - "suffix": "at_point", + "getter": "height", "group": "graphics", "static": "images", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_cell_circle_at_point(bmp, pt):" - ], "cpp": [ - "circle bitmap_cell_circle(bitmap bmp, const point_2d pt)" + "int bitmap_height(bitmap bmp)" + ], + "python": [ + "def bitmap_height(bmp):" ], "csharp": [ - "public Circle Bitmap.CellCircle(Point2D pt);", - "public static Circle SplashKit.BitmapCellCircle(Bitmap bmp, Point2D pt);" + "public int Bitmap.Height { get }", + "public static int SplashKit.BitmapHeight(Bitmap bmp);" ], "pascal": [ - "function BitmapCellCircle(bmp: Bitmap; pt: Point2D): Circle" + "function BitmapHeight(bmp: Bitmap): Integer" ] } }, { - "signature": "circle bitmap_cell_circle(bitmap bmp,const point_2d pt,double scale);", - "name": "bitmap_cell_circle", - "method_name": "cell_circle", - "unique_global_name": "bitmap_cell_circle_at_point_with_scale", - "unique_method_name": "bitmap.cell_circle_at_point_with_scale", + "signature": "int bitmap_height(string name);", + "name": "bitmap_height", + "method_name": null, + "unique_global_name": "bitmap_height_of_bitmap_named", + "unique_method_name": null, "suffix_name": null, - "description": "Returns a circle that will encompass the bitmap cell if it were drawn\nat the indicated point, with the provided scale.", + "description": "Returns the total height of the bitmap. If the bitmap contains cells, you ca\nget the height of a cell using `bitmap_cell_height`.", "brief": null, "return": { - "type": "circle", - "description": "A circle that will encompass the bitmap cell.", + "type": "int", + "description": "The height of the bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to get the details from.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "pt": { - "type": "point_2d", - "description": "The point indicating the location of the bitmap.", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "scale": { - "type": "double", - "description": "The scaling factor for the bitmap drawing.", + "name": { + "type": "string", + "description": "The name of the bitmap to get the details from.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -30604,41 +29842,37 @@ } }, "attributes": { - "class": "bitmap", - "method": "cell_circle", - "suffix": "at_point_with_scale", + "suffix": "of_bitmap_named", "group": "graphics", - "static": "images", - "self": "bmp" + "static": "images" }, "signatures": { - "python": [ - "def bitmap_cell_circle_at_point_with_scale(bmp, pt, scale):" - ], "cpp": [ - "circle bitmap_cell_circle(bitmap bmp, const point_2d pt, double scale)" + "int bitmap_height(string name)" + ], + "python": [ + "def bitmap_height_of_bitmap_named(name):" ], "csharp": [ - "public Circle Bitmap.CellCircle(Point2D pt, double scale);", - "public static Circle SplashKit.BitmapCellCircle(Bitmap bmp, Point2D pt, double scale);" + "public static int SplashKit.BitmapHeight(string name);" ], "pascal": [ - "function BitmapCellCircle(bmp: Bitmap; pt: Point2D; scale: Double): Circle" + "function BitmapHeight(name: String): Integer" ] } }, { - "signature": "int bitmap_cell_columns(bitmap bmp);", - "name": "bitmap_cell_columns", + "signature": "string bitmap_name(bitmap bmp);", + "name": "bitmap_name", "method_name": null, - "unique_global_name": "bitmap_cell_columns", + "unique_global_name": "bitmap_name", "unique_method_name": null, "suffix_name": null, - "description": "Returns the number of cell columns in the bitmap.\nThis is setup using `bitmap_set_cell_details`", + "description": "Returns the name of the bitmap was loaded. This is the name you can use to\naccess this bitmap.", "brief": null, "return": { - "type": "int", - "description": "The number of cell columns", + "type": "string", + "description": "The name of the bitmap.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -30647,7 +29881,7 @@ "parameters": { "bmp": { "type": "bitmap", - "description": "The bitmap to check", + "description": "The bitmap to get the name from.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -30661,48 +29895,48 @@ }, "attributes": { "class": "bitmap", - "getter": "cell_columns", + "getter": "name", "group": "graphics", "static": "images", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_cell_columns(bmp):" - ], "cpp": [ - "int bitmap_cell_columns(bitmap bmp)" + "string bitmap_name(bitmap bmp)" + ], + "python": [ + "def bitmap_name(bmp):" ], "csharp": [ - "public int Bitmap.CellColumns { get }", - "public static int SplashKit.BitmapCellColumns(Bitmap bmp);" + "public string Bitmap.Name { get }", + "public static string SplashKit.BitmapName(Bitmap bmp);" ], "pascal": [ - "function BitmapCellColumns(bmp: Bitmap): Integer" + "function BitmapName(bmp: Bitmap): String" ] } }, { - "signature": "int bitmap_cell_count(bitmap bmp);", - "name": "bitmap_cell_count", + "signature": "bitmap bitmap_named(string name);", + "name": "bitmap_named", "method_name": null, - "unique_global_name": "bitmap_cell_count", + "unique_global_name": "bitmap_named", "unique_method_name": null, "suffix_name": null, - "description": "Returns the number of cells within the bitmap.", + "description": "Returns the `bitmap` that has been loaded with the specified name,\nsee `load_bitmap`. This will attempt to load the bitmap if it has not\nbeen loaded.", "brief": null, "return": { - "type": "int", - "description": "The number of individual cells within the bitmap.", + "type": "bitmap", + "description": "The bitmap with the name specified, which may refer to nothing\nif the bitmap has not been loaded.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to check.", + "name": { + "type": "string", + "description": "The name of the bitmap to check.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -30715,49 +29949,58 @@ } }, "attributes": { - "class": "bitmap", - "getter": "cell_count", "group": "graphics", - "static": "images", - "self": "bmp" + "static": "images" }, "signatures": { - "python": [ - "def bitmap_cell_count(bmp):" - ], "cpp": [ - "int bitmap_cell_count(bitmap bmp)" + "bitmap bitmap_named(string name)" + ], + "python": [ + "def bitmap_named(name):" ], "csharp": [ - "public int Bitmap.CellCount { get }", - "public static int SplashKit.BitmapCellCount(Bitmap bmp);" + "public static Bitmap SplashKit.BitmapNamed(string name);" ], "pascal": [ - "function BitmapCellCount(bmp: Bitmap): Integer" + "function BitmapNamed(name: String): Bitmap" ] } }, { - "signature": "int bitmap_cell_height(bitmap bmp);", - "name": "bitmap_cell_height", - "method_name": null, - "unique_global_name": "bitmap_cell_height", - "unique_method_name": null, + "signature": "rectangle bitmap_rectangle_of_cell(bitmap src,int cell);", + "name": "bitmap_rectangle_of_cell", + "method_name": "rectangle_of_cell", + "unique_global_name": "bitmap_rectangle_of_cell", + "unique_method_name": "bitmap.rectangle_of_cell", "suffix_name": null, - "description": "Returns the height of each cell in this bitmap.", + "description": "Returns a rectangle that can be used to access the part of a bitmap\nrelated to an individual cell.", "brief": null, "return": { - "type": "int", - "description": "The height of each cells in bmp", + "type": "rectangle", + "description": "The area of the cell within the bitmap", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { + "src": { "type": "bitmap", - "description": "The bitmap to get the details from.", + "description": "The bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "cell": { + "type": "int", + "description": "The cell", "is_pointer": false, "is_const": false, "is_reference": false, @@ -30771,48 +30014,48 @@ }, "attributes": { "class": "bitmap", - "getter": "cell_height", + "method": "rectangle_of_cell", "group": "graphics", "static": "images", - "self": "bmp" + "self": "src" }, "signatures": { - "python": [ - "def bitmap_cell_height(bmp):" - ], "cpp": [ - "int bitmap_cell_height(bitmap bmp)" + "rectangle bitmap_rectangle_of_cell(bitmap src, int cell)" + ], + "python": [ + "def bitmap_rectangle_of_cell(src, cell):" ], "csharp": [ - "public int Bitmap.CellHeight { get }", - "public static int SplashKit.BitmapCellHeight(Bitmap bmp);" + "public Rectangle Bitmap.RectangleOfCell(int cell);", + "public static Rectangle SplashKit.BitmapRectangleOfCell(Bitmap src, int cell);" ], "pascal": [ - "function BitmapCellHeight(bmp: Bitmap): Integer" + "function BitmapRectangleOfCell(src: Bitmap; cell: Integer): Rectangle" ] } }, { - "signature": "vector_2d bitmap_cell_offset(bitmap src,int cell);", - "name": "bitmap_cell_offset", - "method_name": "cell_offset", - "unique_global_name": "bitmap_cell_offset", - "unique_method_name": "bitmap.cell_offset", + "signature": "void bitmap_set_cell_details(bitmap bmp,int width,int height,int columns,int rows,int count);", + "name": "bitmap_set_cell_details", + "method_name": "set_cell_details", + "unique_global_name": "bitmap_set_cell_details", + "unique_method_name": "bitmap.set_cell_details", "suffix_name": null, - "description": "Returns a vector that represents the movement needed to get to a given\ncell within a bitmap.", + "description": "Initialise the bitmap cell details. This allows parts of the bitmap to be\ndrawn as individual cells.", "brief": null, "return": { - "type": "vector_2d", - "description": "The offset needed to get to the cell from the top left of the bitmap.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "src": { + "bmp": { "type": "bitmap", - "description": "The bitmap with the cell details.", + "description": "The bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -30823,9 +30066,61 @@ "is_vector": false, "type_parameter": null }, - "cell": { + "width": { "type": "int", - "description": "The index of the cell", + "description": "The width of each cell", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "height": { + "type": "int", + "description": "The height of each cell", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "columns": { + "type": "int", + "description": "The number of cell columns within the bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rows": { + "type": "int", + "description": "The number of cell rows within the bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "count": { + "type": "int", + "description": "The total number of cells, may be fewer than columns *\nrows", "is_pointer": false, "is_const": false, "is_reference": false, @@ -30839,48 +30134,48 @@ }, "attributes": { "class": "bitmap", - "method": "cell_offset", + "method": "set_cell_details", "group": "graphics", "static": "images", - "self": "src" + "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_cell_offset(src, cell):" - ], "cpp": [ - "vector_2d bitmap_cell_offset(bitmap src, int cell)" + "void bitmap_set_cell_details(bitmap bmp, int width, int height, int columns, int rows, int count)" + ], + "python": [ + "def bitmap_set_cell_details(bmp, width, height, columns, rows, count):" ], "csharp": [ - "public Vector2D Bitmap.CellOffset(int cell);", - "public static Vector2D SplashKit.BitmapCellOffset(Bitmap src, int cell);" + "public void Bitmap.SetCellDetails(int width, int height, int columns, int rows, int count);", + "public static void SplashKit.BitmapSetCellDetails(Bitmap bmp, int width, int height, int columns, int rows, int count);" ], "pascal": [ - "function BitmapCellOffset(src: Bitmap; cell: Integer): Vector2D" + "procedure BitmapSetCellDetails(bmp: Bitmap; width: Integer; height: Integer; columns: Integer; rows: Integer; count: Integer)" ] } }, { - "signature": "rectangle bitmap_cell_rectangle(bitmap src);", - "name": "bitmap_cell_rectangle", - "method_name": "cell_rectangle", - "unique_global_name": "bitmap_cell_rectangle", - "unique_method_name": "bitmap.cell_rectangle", + "signature": "bool bitmap_valid(bitmap bmp);", + "name": "bitmap_valid", + "method_name": null, + "unique_global_name": "bitmap_valid", + "unique_method_name": null, "suffix_name": null, - "description": "Returns a rectangle that will encompass a cell of the bitmap.", + "description": "Lets you test if bitmap value is valid. This will return true when it is a valid bitmap.", "brief": null, "return": { - "type": "rectangle", - "description": "A rectangle with width and height from the bitmap's cell details.", + "type": "bool", + "description": "true when the bitmap is valid.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "src": { + "bmp": { "type": "bitmap", - "description": "The bitmap to get the details from", + "description": "the bitmap to test", "is_pointer": false, "is_const": false, "is_reference": false, @@ -30893,68 +30188,51 @@ } }, "attributes": { - "class": "bitmap", - "method": "cell_rectangle", "group": "graphics", - "static": "images", - "self": "src" + "static": "images" }, "signatures": { - "python": [ - "def bitmap_cell_rectangle(src):" - ], "cpp": [ - "rectangle bitmap_cell_rectangle(bitmap src)" + "bool bitmap_valid(bitmap bmp)" + ], + "python": [ + "def bitmap_valid(bmp):" ], "csharp": [ - "public Rectangle Bitmap.CellRectangle();", - "public static Rectangle SplashKit.BitmapCellRectangle(Bitmap src);" + "public static bool SplashKit.BitmapValid(Bitmap bmp);" ], "pascal": [ - "function BitmapCellRectangle(src: Bitmap): Rectangle" + "function BitmapValid(bmp: Bitmap): Boolean" ] } }, { - "signature": "rectangle bitmap_cell_rectangle(bitmap src,const point_2d &pt);", - "name": "bitmap_cell_rectangle", - "method_name": "cell_rectangle", - "unique_global_name": "bitmap_cell_rectangle_at_point", - "unique_method_name": "bitmap.cell_rectangle_at_point", + "signature": "int bitmap_width(bitmap bmp);", + "name": "bitmap_width", + "method_name": null, + "unique_global_name": "bitmap_width", + "unique_method_name": null, "suffix_name": null, - "description": "Returns a rectangle that will encompass the bitmap cell if it were drawn\nat the indicated point.", + "description": "Returns the width of the bitmap.", "brief": null, "return": { - "type": "rectangle", - "description": "A rectangle at pt, with width and height from the bitmap's cell details.", + "type": "int", + "description": "The width of the bitmap", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "src": { + "bmp": { "type": "bitmap", - "description": "The bitmap to get the details from", + "description": "The bitmap", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "pt": { - "type": "point_2d", - "description": "The point details for the rectangle.", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null @@ -30962,49 +30240,48 @@ }, "attributes": { "class": "bitmap", - "method": "cell_rectangle", - "suffix": "at_point", + "getter": "width", "group": "graphics", "static": "images", - "self": "src" + "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_cell_rectangle_at_point(src, pt):" - ], "cpp": [ - "rectangle bitmap_cell_rectangle(bitmap src, const point_2d &pt)" + "int bitmap_width(bitmap bmp)" + ], + "python": [ + "def bitmap_width(bmp):" ], "csharp": [ - "public Rectangle Bitmap.CellRectangle(Point2D pt);", - "public static Rectangle SplashKit.BitmapCellRectangle(Bitmap src, Point2D pt);" + "public int Bitmap.Width { get }", + "public static int SplashKit.BitmapWidth(Bitmap bmp);" ], "pascal": [ - "function BitmapCellRectangle(src: Bitmap; const pt: Point2D): Rectangle" + "function BitmapWidth(bmp: Bitmap): Integer" ] } }, { - "signature": "int bitmap_cell_rows(bitmap bmp);", - "name": "bitmap_cell_rows", + "signature": "int bitmap_width(string name);", + "name": "bitmap_width", "method_name": null, - "unique_global_name": "bitmap_cell_rows", + "unique_global_name": "bitmap_width_of_bitmap_named", "unique_method_name": null, "suffix_name": null, - "description": "Returns the number of rows of cells in the bitmap. These details are set in\n`bitmap_set_cell_details`.", + "description": "Returns the width of the bitmap.", "brief": null, "return": { "type": "int", - "description": "The number of rows of cells in the bitmap.", + "description": "The width of the bitmap", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to get the details from.", + "name": { + "type": "string", + "description": "The name of the bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31017,40 +30294,37 @@ } }, "attributes": { - "class": "bitmap", - "getter": "cell_rows", + "suffix": "of_bitmap_named", "group": "graphics", - "static": "images", - "self": "bmp" + "static": "images" }, "signatures": { - "python": [ - "def bitmap_cell_rows(bmp):" - ], "cpp": [ - "int bitmap_cell_rows(bitmap bmp)" + "int bitmap_width(string name)" + ], + "python": [ + "def bitmap_width_of_bitmap_named(name):" ], "csharp": [ - "public int Bitmap.CellRows { get }", - "public static int SplashKit.BitmapCellRows(Bitmap bmp);" + "public static int SplashKit.BitmapWidth(string name);" ], "pascal": [ - "function BitmapCellRows(bmp: Bitmap): Integer" + "function BitmapWidth(name: String): Integer" ] } }, { - "signature": "int bitmap_cell_width(bitmap bmp);", - "name": "bitmap_cell_width", - "method_name": null, - "unique_global_name": "bitmap_cell_width", - "unique_method_name": null, + "signature": "void clear_bitmap(bitmap bmp,color clr);", + "name": "clear_bitmap", + "method_name": "clear", + "unique_global_name": "clear_bitmap", + "unique_method_name": "bitmap.clear", "suffix_name": null, - "description": "Returns the width of each cell in this bitmap.", + "description": "Clear the bitmap to the indicated color. This will ensure the entire\nsurface of the bitmap is set to that color.", "brief": null, "return": { - "type": "int", - "description": "The width of each cells in bmp", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, @@ -31059,7 +30333,20 @@ "parameters": { "bmp": { "type": "bitmap", - "description": "The bitmap to get the details from.", + "description": "The bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "clr": { + "type": "color", + "description": "The new color for the surface of the bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31073,48 +30360,61 @@ }, "attributes": { "class": "bitmap", - "getter": "cell_width", + "method": "clear", "group": "graphics", "static": "images", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_cell_width(bmp):" - ], "cpp": [ - "int bitmap_cell_width(bitmap bmp)" + "void clear_bitmap(bitmap bmp, color clr)" + ], + "python": [ + "def clear_bitmap(bmp, clr):" ], "csharp": [ - "public int Bitmap.CellWidth { get }", - "public static int SplashKit.BitmapCellWidth(Bitmap bmp);" + "public void Bitmap.Clear(Color clr);", + "public static void SplashKit.ClearBitmap(Bitmap bmp, Color clr);" ], "pascal": [ - "function BitmapCellWidth(bmp: Bitmap): Integer" + "procedure ClearBitmap(bmp: Bitmap; clr: Color)" ] } }, { - "signature": "point_2d bitmap_center(bitmap bmp);", - "name": "bitmap_center", + "signature": "void clear_bitmap(string name,color clr);", + "name": "clear_bitmap", "method_name": null, - "unique_global_name": "bitmap_center", + "unique_global_name": "clear_bitmap_named", "unique_method_name": null, "suffix_name": null, - "description": "This returns a point that represents the center of the bitmap in local\nspace.", + "description": "Clear the bitmap to the indicated color. This will ensure the entire\nsurface of the bitmap is set to that color.", "brief": null, "return": { - "type": "point_2d", - "description": "A point in the center of the bitmap.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to get the center of.", + "name": { + "type": "string", + "description": "The name of the bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "clr": { + "type": "color", + "description": "The new color for the surface of the bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31127,49 +30427,72 @@ } }, "attributes": { - "class": "bitmap", - "getter": "center", + "suffix": "named", "group": "graphics", - "static": "images", - "self": "bmp" + "static": "images" }, "signatures": { - "python": [ - "def bitmap_center(bmp):" - ], "cpp": [ - "point_2d bitmap_center(bitmap bmp)" + "void clear_bitmap(string name, color clr)" + ], + "python": [ + "def clear_bitmap_named(name, clr):" ], "csharp": [ - "public Point2D Bitmap.Center { get }", - "public static Point2D SplashKit.BitmapCenter(Bitmap bmp);" + "public static void SplashKit.ClearBitmap(string name, Color clr);" ], "pascal": [ - "function BitmapCenter(bmp: Bitmap): Point2D" + "procedure ClearBitmap(name: String; clr: Color)" ] } }, { - "signature": "string bitmap_filename(bitmap bmp);", - "name": "bitmap_filename", + "signature": "bitmap create_bitmap(string name,int width,int height);", + "name": "create_bitmap", "method_name": null, - "unique_global_name": "bitmap_filename", + "unique_global_name": "create_bitmap", "unique_method_name": null, "suffix_name": null, - "description": "Returns the filename from which the bitmap was loaded. This will be an empty\nstring for created bitmaps.", + "description": "Creates a new bitmap that you can draw to. Initially the bitmap will\nbe transparent.", "brief": null, "return": { - "type": "string", - "description": "The file name of the bitmap.", + "type": "bitmap", + "description": "A new transparent bitmap", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to get the filename from.", + "name": { + "type": "string", + "description": "The name of the bitmap resource to be created. If this\nalready exists SplashKit will alter the name to make it\nunique.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "width": { + "type": "int", + "description": "The width of the created bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "height": { + "type": "int", + "description": "The height of the created bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31183,39 +30506,38 @@ }, "attributes": { "class": "bitmap", - "getter": "filename", + "constructor": true, "group": "graphics", - "static": "images", - "self": "bmp" + "static": "images" }, "signatures": { - "python": [ - "def bitmap_filename(bmp):" - ], "cpp": [ - "string bitmap_filename(bitmap bmp)" + "bitmap create_bitmap(string name, int width, int height)" + ], + "python": [ + "def create_bitmap(name, width, height):" ], "csharp": [ - "public string Bitmap.Filename { get }", - "public static string SplashKit.BitmapFilename(Bitmap bmp);" + "public static Bitmap SplashKit.CreateBitmap(string name, int width, int height);", + "public Bitmap(string name, int width, int height);" ], "pascal": [ - "function BitmapFilename(bmp: Bitmap): String" + "function CreateBitmap(name: String; width: Integer; height: Integer): Bitmap" ] } }, { - "signature": "int bitmap_height(bitmap bmp);", - "name": "bitmap_height", - "method_name": null, - "unique_global_name": "bitmap_height", - "unique_method_name": null, + "signature": "void draw_bitmap(bitmap bmp,double x,double y);", + "name": "draw_bitmap", + "method_name": "draw", + "unique_global_name": "draw_bitmap", + "unique_method_name": "bitmap.draw", "suffix_name": null, - "description": "Returns the total height of the bitmap. If the bitmap contains cells, you ca\nget the height of a cell using `bitmap_cell_height`.", + "description": "Draws the bitmap supplied into `bmp` to the current window.\nat `x` and `y`.", "brief": null, "return": { - "type": "int", - "description": "The height of the bitmap.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, @@ -31224,7 +30546,7 @@ "parameters": { "bmp": { "type": "bitmap", - "description": "The bitmap to get the details from.", + "description": "the bitmap which will be drawn to the screen", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31234,52 +30556,23 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "bitmap", - "getter": "height", - "group": "graphics", - "static": "images", - "self": "bmp" - }, - "signatures": { - "python": [ - "def bitmap_height(bmp):" - ], - "cpp": [ - "int bitmap_height(bitmap bmp)" - ], - "csharp": [ - "public int Bitmap.Height { get }", - "public static int SplashKit.BitmapHeight(Bitmap bmp);" - ], - "pascal": [ - "function BitmapHeight(bmp: Bitmap): Integer" - ] - } - }, - { - "signature": "int bitmap_height(string name);", - "name": "bitmap_height", - "method_name": null, - "unique_global_name": "bitmap_height_of_bitmap_named", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns the total height of the bitmap. If the bitmap contains cells, you ca\nget the height of a cell using `bitmap_cell_height`.", - "brief": null, - "return": { - "type": "int", - "description": "The height of the bitmap.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "name": { - "type": "string", - "description": "The name of the bitmap to get the details from.", + }, + "x": { + "type": "double", + "description": "the x location which represents where the bitmap\nwill be drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "the y location which represents where the bitmap\nwill be drawn", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31292,37 +30585,40 @@ } }, "attributes": { - "suffix": "of_bitmap_named", + "class": "bitmap", + "method": "draw", + "self": "bmp", "group": "graphics", "static": "images" }, "signatures": { - "python": [ - "def bitmap_height_of_bitmap_named(name):" - ], "cpp": [ - "int bitmap_height(string name)" + "void draw_bitmap(bitmap bmp, double x, double y)" + ], + "python": [ + "def draw_bitmap(bmp, x, y):" ], "csharp": [ - "public static int SplashKit.BitmapHeight(string name);" + "public void Bitmap.Draw(double x, double y);", + "public static void SplashKit.DrawBitmap(Bitmap bmp, double x, double y);" ], "pascal": [ - "function BitmapHeight(name: String): Integer" + "procedure DrawBitmap(bmp: Bitmap; x: Double; y: Double)" ] } }, { - "signature": "string bitmap_name(bitmap bmp);", - "name": "bitmap_name", - "method_name": null, - "unique_global_name": "bitmap_name", - "unique_method_name": null, + "signature": "void draw_bitmap(bitmap bmp,double x,double y,drawing_options opts);", + "name": "draw_bitmap", + "method_name": "draw", + "unique_global_name": "draw_bitmap_with_options", + "unique_method_name": "bitmap.draw_with_options", "suffix_name": null, - "description": "Returns the name of the bitmap was loaded. This is the name you can use to\naccess this bitmap.", + "description": "Draws the bitmap supplied into `bmp` to the current window.\nwith extra drawing options supplied in `opts` at `x` and `y`.", "brief": null, "return": { - "type": "string", - "description": "The name of the bitmap.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, @@ -31331,7 +30627,46 @@ "parameters": { "bmp": { "type": "bitmap", - "description": "The bitmap to get the name from.", + "description": "the bitmap which will be drawn to the screen", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x": { + "type": "double", + "description": "the x location which represents where the bitmap\nwill be drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "the y location which represents where the bitmap\nwill be drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "opts": { + "type": "drawing_options", + "description": "the `drawing_options` which provide extra information\nfor how to draw the `bitmap`", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31345,39 +30680,40 @@ }, "attributes": { "class": "bitmap", - "getter": "name", + "method": "draw", + "self": "bmp", + "suffix": "with_options", "group": "graphics", - "static": "images", - "self": "bmp" + "static": "images" }, "signatures": { - "python": [ - "def bitmap_name(bmp):" - ], "cpp": [ - "string bitmap_name(bitmap bmp)" + "void draw_bitmap(bitmap bmp, double x, double y, drawing_options opts)" + ], + "python": [ + "def draw_bitmap_with_options(bmp, x, y, opts):" ], "csharp": [ - "public string Bitmap.Name { get }", - "public static string SplashKit.BitmapName(Bitmap bmp);" + "public void Bitmap.Draw(double x, double y, DrawingOptions opts);", + "public static void SplashKit.DrawBitmap(Bitmap bmp, double x, double y, DrawingOptions opts);" ], "pascal": [ - "function BitmapName(bmp: Bitmap): String" + "procedure DrawBitmap(bmp: Bitmap; x: Double; y: Double; opts: DrawingOptions)" ] } }, { - "signature": "bitmap bitmap_named(string name);", - "name": "bitmap_named", + "signature": "void draw_bitmap(string name,double x,double y);", + "name": "draw_bitmap", "method_name": null, - "unique_global_name": "bitmap_named", + "unique_global_name": "draw_bitmap_named", "unique_method_name": null, "suffix_name": null, - "description": "Returns the `bitmap` that has been loaded with the specified name,\nsee `load_bitmap`. This will attempt to load the bitmap if it has not\nbeen loaded.", + "description": "Searches and draws a bitmap with name `name` to the current window.\nwith extra drawing options supplied in `opts` at `x` and `y`.", "brief": null, "return": { - "type": "bitmap", - "description": "The bitmap with the name specified, which may refer to nothing\nif the bitmap has not been loaded.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, @@ -31386,7 +30722,7 @@ "parameters": { "name": { "type": "string", - "description": "The name of the bitmap to check.", + "description": "the name of the bitmap which will be drawn to the screen", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31396,48 +30732,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "group": "graphics", - "static": "images" - }, - "signatures": { - "python": [ - "def bitmap_named(name):" - ], - "cpp": [ - "bitmap bitmap_named(string name)" - ], - "csharp": [ - "public static Bitmap SplashKit.BitmapNamed(string name);" - ], - "pascal": [ - "function BitmapNamed(name: String): Bitmap" - ] - } - }, - { - "signature": "rectangle bitmap_rectangle_of_cell(bitmap src,int cell);", - "name": "bitmap_rectangle_of_cell", - "method_name": "rectangle_of_cell", - "unique_global_name": "bitmap_rectangle_of_cell", - "unique_method_name": "bitmap.rectangle_of_cell", - "suffix_name": null, - "description": "Returns a rectangle that can be used to access the part of a bitmap\nrelated to an individual cell.", - "brief": null, - "return": { - "type": "rectangle", - "description": "The area of the cell within the bitmap", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "src": { - "type": "bitmap", - "description": "The bitmap", + }, + "x": { + "type": "double", + "description": "the x location which represents where the bitmap\nwill be drawn", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31448,9 +30746,9 @@ "is_vector": false, "type_parameter": null }, - "cell": { - "type": "int", - "description": "The cell", + "y": { + "type": "double", + "description": "the y location which represents where the bitmap\nwill be drawn", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31463,36 +30761,33 @@ } }, "attributes": { - "class": "bitmap", - "method": "rectangle_of_cell", + "suffix": "named", "group": "graphics", - "static": "images", - "self": "src" + "static": "images" }, "signatures": { - "python": [ - "def bitmap_rectangle_of_cell(src, cell):" - ], "cpp": [ - "rectangle bitmap_rectangle_of_cell(bitmap src, int cell)" + "void draw_bitmap(string name, double x, double y)" + ], + "python": [ + "def draw_bitmap_named(name, x, y):" ], "csharp": [ - "public Rectangle Bitmap.RectangleOfCell(int cell);", - "public static Rectangle SplashKit.BitmapRectangleOfCell(Bitmap src, int cell);" + "public static void SplashKit.DrawBitmap(string name, double x, double y);" ], "pascal": [ - "function BitmapRectangleOfCell(src: Bitmap; cell: Integer): Rectangle" + "procedure DrawBitmap(name: String; x: Double; y: Double)" ] } }, { - "signature": "void bitmap_set_cell_details(bitmap bmp,int width,int height,int columns,int rows,int count);", - "name": "bitmap_set_cell_details", - "method_name": "set_cell_details", - "unique_global_name": "bitmap_set_cell_details", - "unique_method_name": "bitmap.set_cell_details", + "signature": "void draw_bitmap(string name,double x,double y,drawing_options opts);", + "name": "draw_bitmap", + "method_name": null, + "unique_global_name": "draw_bitmap_named_with_options", + "unique_method_name": null, "suffix_name": null, - "description": "Initialise the bitmap cell details. This allows parts of the bitmap to be\ndrawn as individual cells.", + "description": "Searches and draws a bitmap with name `name` to the current window.\nwith extra drawing options supplied in `opts` at `x` and `y`.", "brief": null, "return": { "type": "void", @@ -31503,9 +30798,9 @@ "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap", + "name": { + "type": "string", + "description": "the name of the bitmap which will be drawn to the screen", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31516,9 +30811,9 @@ "is_vector": false, "type_parameter": null }, - "width": { - "type": "int", - "description": "The width of each cell", + "x": { + "type": "double", + "description": "the x location which represents where the bitmap\nwill be drawn", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31529,35 +30824,9 @@ "is_vector": false, "type_parameter": null }, - "height": { - "type": "int", - "description": "The height of each cell", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "columns": { - "type": "int", - "description": "The number of cell columns within the bitmap", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rows": { - "type": "int", - "description": "The number of cell rows within the bitmap", + "y": { + "type": "double", + "description": "the y location which represents where the bitmap\nwill be drawn", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31568,9 +30837,9 @@ "is_vector": false, "type_parameter": null }, - "count": { - "type": "int", - "description": "The total number of cells, may be fewer than columns *\nrows", + "opts": { + "type": "drawing_options", + "description": "the `drawing_options` which provide extra information\nfor how to draw the `bitmap`", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31583,100 +30852,46 @@ } }, "attributes": { - "class": "bitmap", - "method": "set_cell_details", + "suffix": "named_with_options", "group": "graphics", - "static": "images", - "self": "bmp" + "static": "images" }, "signatures": { - "python": [ - "def bitmap_set_cell_details(bmp, width, height, columns, rows, count):" - ], "cpp": [ - "void bitmap_set_cell_details(bitmap bmp, int width, int height, int columns, int rows, int count)" - ], - "csharp": [ - "public void Bitmap.SetCellDetails(int width, int height, int columns, int rows, int count);", - "public static void SplashKit.BitmapSetCellDetails(Bitmap bmp, int width, int height, int columns, int rows, int count);" + "void draw_bitmap(string name, double x, double y, drawing_options opts)" ], - "pascal": [ - "procedure BitmapSetCellDetails(bmp: Bitmap; width: Integer; height: Integer; columns: Integer; rows: Integer; count: Integer)" - ] - } - }, - { - "signature": "bool bitmap_valid(bitmap bmp);", - "name": "bitmap_valid", - "method_name": null, - "unique_global_name": "bitmap_valid", - "unique_method_name": null, - "suffix_name": null, - "description": "Lets you test if bitmap value is valid. This will return true when it is a valid bitmap.", - "brief": null, - "return": { - "type": "bool", - "description": "true when the bitmap is valid.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "bmp": { - "type": "bitmap", - "description": "the bitmap to test", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "graphics", - "static": "images" - }, - "signatures": { "python": [ - "def bitmap_valid(bmp):" - ], - "cpp": [ - "bool bitmap_valid(bitmap bmp)" + "def draw_bitmap_named_with_options(name, x, y, opts):" ], "csharp": [ - "public static bool SplashKit.BitmapValid(Bitmap bmp);" + "public static void SplashKit.DrawBitmap(string name, double x, double y, DrawingOptions opts);" ], "pascal": [ - "function BitmapValid(bmp: Bitmap): Boolean" + "procedure DrawBitmap(name: String; x: Double; y: Double; opts: DrawingOptions)" ] } }, { - "signature": "int bitmap_width(bitmap bmp);", - "name": "bitmap_width", - "method_name": null, - "unique_global_name": "bitmap_width", - "unique_method_name": null, + "signature": "void draw_bitmap_on_bitmap(bitmap destination,bitmap bmp,double x,double y);", + "name": "draw_bitmap_on_bitmap", + "method_name": "draw_bitmap", + "unique_global_name": "draw_bitmap_on_bitmap_on_bitmap", + "unique_method_name": "bitmap.draw_bitmap_on_bitmap", "suffix_name": null, - "description": "Returns the width of the bitmap.", + "description": "Draws the bitmap supplied into `bmp` to the given bitmap.\nat `x` and `y`.", "brief": null, "return": { - "type": "int", - "description": "The width of the bitmap", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { + "destination": { "type": "bitmap", - "description": "The bitmap", + "description": "the bitmap to draw the bitmap to", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31686,52 +30901,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "bitmap", - "getter": "width", - "group": "graphics", - "static": "images", - "self": "bmp" - }, - "signatures": { - "python": [ - "def bitmap_width(bmp):" - ], - "cpp": [ - "int bitmap_width(bitmap bmp)" - ], - "csharp": [ - "public int Bitmap.Width { get }", - "public static int SplashKit.BitmapWidth(Bitmap bmp);" - ], - "pascal": [ - "function BitmapWidth(bmp: Bitmap): Integer" - ] - } - }, - { - "signature": "int bitmap_width(string name);", - "name": "bitmap_width", - "method_name": null, - "unique_global_name": "bitmap_width_of_bitmap_named", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns the width of the bitmap.", - "brief": null, - "return": { - "type": "int", - "description": "The width of the bitmap", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "name": { - "type": "string", - "description": "The name of the bitmap", + }, + "bmp": { + "type": "bitmap", + "description": "the bitmap which will be drawn to the screen", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31741,49 +30914,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "suffix": "of_bitmap_named", - "group": "graphics", - "static": "images" - }, - "signatures": { - "python": [ - "def bitmap_width_of_bitmap_named(name):" - ], - "cpp": [ - "int bitmap_width(string name)" - ], - "csharp": [ - "public static int SplashKit.BitmapWidth(string name);" - ], - "pascal": [ - "function BitmapWidth(name: String): Integer" - ] - } - }, - { - "signature": "void clear_bitmap(bitmap bmp,color clr);", - "name": "clear_bitmap", - "method_name": "clear", - "unique_global_name": "clear_bitmap", - "unique_method_name": "bitmap.clear", - "suffix_name": null, - "description": "Clear the bitmap to the indicated color. This will ensure the entire\nsurface of the bitmap is set to that color.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap", + }, + "x": { + "type": "double", + "description": "the x location which represents where the bitmap\nwill be drawn", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31794,9 +30928,9 @@ "is_vector": false, "type_parameter": null }, - "clr": { - "type": "color", - "description": "The new color for the surface of the bitmap", + "y": { + "type": "double", + "description": "the y location which represents where the bitmap\nwill be drawn", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31810,35 +30944,36 @@ }, "attributes": { "class": "bitmap", - "method": "clear", + "method": "draw_bitmap", + "self": "bmp", + "suffix": "on_bitmap", "group": "graphics", - "static": "images", - "self": "bmp" + "static": "images" }, "signatures": { - "python": [ - "def clear_bitmap(bmp, clr):" - ], "cpp": [ - "void clear_bitmap(bitmap bmp, color clr)" + "void draw_bitmap_on_bitmap(bitmap destination, bitmap bmp, double x, double y)" + ], + "python": [ + "def draw_bitmap_on_bitmap_on_bitmap(destination, bmp, x, y):" ], "csharp": [ - "public void Bitmap.Clear(Color clr);", - "public static void SplashKit.ClearBitmap(Bitmap bmp, Color clr);" + "public void Bitmap.DrawBitmap(Bitmap destination, double x, double y);", + "public static void SplashKit.DrawBitmapOnBitmap(Bitmap destination, Bitmap bmp, double x, double y);" ], "pascal": [ - "procedure ClearBitmap(bmp: Bitmap; clr: Color)" + "procedure DrawBitmapOnBitmap(destination: Bitmap; bmp: Bitmap; x: Double; y: Double)" ] } }, { - "signature": "void clear_bitmap(string name,color clr);", - "name": "clear_bitmap", - "method_name": null, - "unique_global_name": "clear_bitmap_named", - "unique_method_name": null, + "signature": "void draw_bitmap_on_bitmap(bitmap destination,bitmap bmp,double x,double y,drawing_options opts);", + "name": "draw_bitmap_on_bitmap", + "method_name": "draw_bitmap", + "unique_global_name": "draw_bitmap_on_bitmap_on_bitmap_with_options", + "unique_method_name": "bitmap.draw_bitmap_on_bitmap_with_options", "suffix_name": null, - "description": "Clear the bitmap to the indicated color. This will ensure the entire\nsurface of the bitmap is set to that color.", + "description": "Draws the bitmap supplied into `bmp` to the given bitmap.\nwith extra drawing options supplied in `opts` at `x` and `y`.", "brief": null, "return": { "type": "void", @@ -31849,9 +30984,9 @@ "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name of the bitmap", + "destination": { + "type": "bitmap", + "description": "the bitmap to draw the bitmap to", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31862,9 +30997,9 @@ "is_vector": false, "type_parameter": null }, - "clr": { - "type": "color", - "description": "The new color for the surface of the bitmap", + "bmp": { + "type": "bitmap", + "description": "the bitmap which will be drawn to the screen", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31874,49 +31009,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "suffix": "named", - "group": "graphics", - "static": "images" - }, - "signatures": { - "python": [ - "def clear_bitmap_named(name, clr):" - ], - "cpp": [ - "void clear_bitmap(string name, color clr)" - ], - "csharp": [ - "public static void SplashKit.ClearBitmap(string name, Color clr);" - ], - "pascal": [ - "procedure ClearBitmap(name: String; clr: Color)" - ] - } - }, - { - "signature": "bitmap create_bitmap(string name,int width,int height);", - "name": "create_bitmap", - "method_name": null, - "unique_global_name": "create_bitmap", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a new bitmap that you can draw to. Initially the bitmap will\nbe transparent.", - "brief": null, - "return": { - "type": "bitmap", - "description": "A new transparent bitmap", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "name": { - "type": "string", - "description": "The name of the bitmap resource to be created. If this\nalready exists SplashKit will alter the name to make it\nunique.", + }, + "x": { + "type": "double", + "description": "the x location which represents where the bitmap\nwill be drawn", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31927,9 +31023,9 @@ "is_vector": false, "type_parameter": null }, - "width": { - "type": "int", - "description": "The width of the created bitmap", + "y": { + "type": "double", + "description": "the y location which represents where the bitmap\nwill be drawn", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31940,9 +31036,9 @@ "is_vector": false, "type_parameter": null }, - "height": { - "type": "int", - "description": "The height of the created bitmap", + "opts": { + "type": "drawing_options", + "description": "the `drawing_options` which provide extra information\nfor how to draw the `bitmap`", "is_pointer": false, "is_const": false, "is_reference": false, @@ -31956,34 +31052,36 @@ }, "attributes": { "class": "bitmap", - "constructor": true, + "method": "draw_bitmap", + "self": "bmp", + "suffix": "on_bitmap_with_options", "group": "graphics", "static": "images" }, "signatures": { - "python": [ - "def create_bitmap(name, width, height):" - ], "cpp": [ - "bitmap create_bitmap(string name, int width, int height)" + "void draw_bitmap_on_bitmap(bitmap destination, bitmap bmp, double x, double y, drawing_options opts)" + ], + "python": [ + "def draw_bitmap_on_bitmap_on_bitmap_with_options(destination, bmp, x, y, opts):" ], "csharp": [ - "public static Bitmap SplashKit.CreateBitmap(string name, int width, int height);", - "public Bitmap(string name, int width, int height);" + "public void Bitmap.DrawBitmap(Bitmap destination, double x, double y, DrawingOptions opts);", + "public static void SplashKit.DrawBitmapOnBitmap(Bitmap destination, Bitmap bmp, double x, double y, DrawingOptions opts);" ], "pascal": [ - "function CreateBitmap(name: String; width: Integer; height: Integer): Bitmap" + "procedure DrawBitmapOnBitmap(destination: Bitmap; bmp: Bitmap; x: Double; y: Double; opts: DrawingOptions)" ] } }, { - "signature": "void draw_bitmap(bitmap bmp,double x,double y);", - "name": "draw_bitmap", - "method_name": "draw", - "unique_global_name": "draw_bitmap", - "unique_method_name": "bitmap.draw", + "signature": "void draw_bitmap_on_window(window destination,bitmap bmp,double x,double y);", + "name": "draw_bitmap_on_window", + "method_name": "draw_bitmap", + "unique_global_name": "draw_bitmap_on_window", + "unique_method_name": "window.draw_bitmap", "suffix_name": null, - "description": "Draws the bitmap supplied into `bmp` to the current window.\nat `x` and `y`.", + "description": "Draws the bitmap supplied into `bmp` to the given window.\nat `x` and `y`.", "brief": null, "return": { "type": "void", @@ -31994,6 +31092,19 @@ "type_parameter": null }, "parameters": { + "destination": { + "type": "window", + "description": "the window to draw the bitmap to", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "bmp": { "type": "bitmap", "description": "the bitmap which will be drawn to the screen", @@ -32035,36 +31146,36 @@ } }, "attributes": { - "class": "bitmap", - "method": "draw", - "self": "bmp", + "class": "window", + "method": "draw_bitmap", + "self": "destination", "group": "graphics", "static": "images" }, "signatures": { - "python": [ - "def draw_bitmap(bmp, x, y):" - ], "cpp": [ - "void draw_bitmap(bitmap bmp, double x, double y)" + "void draw_bitmap_on_window(window destination, bitmap bmp, double x, double y)" + ], + "python": [ + "def draw_bitmap_on_window(destination, bmp, x, y):" ], "csharp": [ - "public void Bitmap.Draw(double x, double y);", - "public static void SplashKit.DrawBitmap(Bitmap bmp, double x, double y);" + "public void Window.DrawBitmap(Bitmap bmp, double x, double y);", + "public static void SplashKit.DrawBitmapOnWindow(Window destination, Bitmap bmp, double x, double y);" ], "pascal": [ - "procedure DrawBitmap(bmp: Bitmap; x: Double; y: Double)" + "procedure DrawBitmapOnWindow(destination: Window; bmp: Bitmap; x: Double; y: Double)" ] } }, { - "signature": "void draw_bitmap(bitmap bmp,double x,double y,drawing_options opts);", - "name": "draw_bitmap", - "method_name": "draw", - "unique_global_name": "draw_bitmap_with_options", - "unique_method_name": "bitmap.draw_with_options", + "signature": "void draw_bitmap_on_window(window destination,bitmap bmp,double x,double y,drawing_options opts);", + "name": "draw_bitmap_on_window", + "method_name": "draw_bitmap", + "unique_global_name": "draw_bitmap_on_window_with_options", + "unique_method_name": "window.draw_bitmap_with_options", "suffix_name": null, - "description": "Draws the bitmap supplied into `bmp` to the current window.\nwith extra drawing options supplied in `opts` at `x` and `y`.", + "description": "Draws the bitmap supplied into `bmp` to the given window.\nwith extra drawing options supplied in `opts` at `x` and `y`.", "brief": null, "return": { "type": "void", @@ -32075,6 +31186,19 @@ "type_parameter": null }, "parameters": { + "destination": { + "type": "window", + "description": "the window to draw the bitmap to", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "bmp": { "type": "bitmap", "description": "the bitmap which will be drawn to the screen", @@ -32129,37 +31253,37 @@ } }, "attributes": { - "class": "bitmap", - "method": "draw", - "self": "bmp", + "class": "window", + "method": "draw_bitmap", + "self": "destination", "suffix": "with_options", "group": "graphics", "static": "images" }, "signatures": { - "python": [ - "def draw_bitmap_with_options(bmp, x, y, opts):" - ], "cpp": [ - "void draw_bitmap(bitmap bmp, double x, double y, drawing_options opts)" + "void draw_bitmap_on_window(window destination, bitmap bmp, double x, double y, drawing_options opts)" + ], + "python": [ + "def draw_bitmap_on_window_with_options(destination, bmp, x, y, opts):" ], "csharp": [ - "public void Bitmap.Draw(double x, double y, DrawingOptions opts);", - "public static void SplashKit.DrawBitmap(Bitmap bmp, double x, double y, DrawingOptions opts);" + "public void Window.DrawBitmap(Bitmap bmp, double x, double y, DrawingOptions opts);", + "public static void SplashKit.DrawBitmapOnWindow(Window destination, Bitmap bmp, double x, double y, DrawingOptions opts);" ], "pascal": [ - "procedure DrawBitmap(bmp: Bitmap; x: Double; y: Double; opts: DrawingOptions)" + "procedure DrawBitmapOnWindow(destination: Window; bmp: Bitmap; x: Double; y: Double; opts: DrawingOptions)" ] } }, { - "signature": "void draw_bitmap(string name,double x,double y);", - "name": "draw_bitmap", + "signature": "void free_all_bitmaps();", + "name": "free_all_bitmaps", "method_name": null, - "unique_global_name": "draw_bitmap_named", + "unique_global_name": "free_all_bitmaps", "unique_method_name": null, "suffix_name": null, - "description": "Searches and draws a bitmap with name `name` to the current window.\nwith extra drawing options supplied in `opts` at `x` and `y`.", + "description": "Free all of the loaded bitmap resources.", "brief": null, "return": { "type": "void", @@ -32170,74 +31294,34 @@ "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "the name of the bitmap which will be drawn to the screen", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "the x location which represents where the bitmap\nwill be drawn", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "the y location which represents where the bitmap\nwill be drawn", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { - "suffix": "named", "group": "graphics", "static": "images" }, "signatures": { - "python": [ - "def draw_bitmap_named(name, x, y):" - ], "cpp": [ - "void draw_bitmap(string name, double x, double y)" + "void free_all_bitmaps()" + ], + "python": [ + "def free_all_bitmaps():" ], "csharp": [ - "public static void SplashKit.DrawBitmap(string name, double x, double y);" + "public static void SplashKit.FreeAllBitmaps();" ], "pascal": [ - "procedure DrawBitmap(name: String; x: Double; y: Double)" + "procedure FreeAllBitmaps()" ] } }, { - "signature": "void draw_bitmap(string name,double x,double y,drawing_options opts);", - "name": "draw_bitmap", - "method_name": null, - "unique_global_name": "draw_bitmap_named_with_options", - "unique_method_name": null, + "signature": "void free_bitmap(bitmap to_delete);", + "name": "free_bitmap", + "method_name": "free", + "unique_global_name": "free_bitmap", + "unique_method_name": "bitmap.free", "suffix_name": null, - "description": "Searches and draws a bitmap with name `name` to the current window.\nwith extra drawing options supplied in `opts` at `x` and `y`.", + "description": "Frees the bitmap resource.", "brief": null, "return": { "type": "void", @@ -32248,10 +31332,10 @@ "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "the name of the bitmap which will be drawn to the screen", - "is_pointer": false, + "to_delete": { + "type": "bitmap", + "description": "The bitmap to be freed.", + "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, @@ -32260,10 +31344,53 @@ ], "is_vector": false, "type_parameter": null - }, - "x": { - "type": "double", - "description": "the x location which represents where the bitmap\nwill be drawn", + } + }, + "attributes": { + "class": "bitmap", + "destructor": true, + "method": "free", + "group": "graphics", + "static": "images", + "self": "to_delete" + }, + "signatures": { + "cpp": [ + "void free_bitmap(bitmap to_delete)" + ], + "python": [ + "def free_bitmap(to_delete):" + ], + "csharp": [ + "public void Bitmap.Free();", + "public static void SplashKit.FreeBitmap(Bitmap toDelete);" + ], + "pascal": [ + "procedure FreeBitmap(toDelete: Bitmap)" + ] + } + }, + { + "signature": "bool has_bitmap(string name);", + "name": "has_bitmap", + "method_name": null, + "unique_global_name": "has_bitmap", + "unique_method_name": null, + "suffix_name": null, + "description": "Determines if SplashKit has a bitmap loaded for the supplied name.\nThis checks against all bitmaps loaded.", + "brief": null, + "return": { + "type": "bool", + "description": "True if SplashKit has a bitmap with that name", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "name": { + "type": "string", + "description": "The name to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32273,10 +31400,48 @@ ], "is_vector": false, "type_parameter": null - }, - "y": { - "type": "double", - "description": "the y location which represents where the bitmap\nwill be drawn", + } + }, + "attributes": { + "group": "graphics", + "static": "images" + }, + "signatures": { + "cpp": [ + "bool has_bitmap(string name)" + ], + "python": [ + "def has_bitmap(name):" + ], + "csharp": [ + "public static bool SplashKit.HasBitmap(string name);" + ], + "pascal": [ + "function HasBitmap(name: String): Boolean" + ] + } + }, + { + "signature": "bitmap load_bitmap(string name,string filename);", + "name": "load_bitmap", + "method_name": null, + "unique_global_name": "load_bitmap", + "unique_method_name": null, + "suffix_name": null, + "description": "Loads and returns a bitmap. The supplied `filename` is used to\nlocate the Bitmap to load. The supplied `name` indicates the\nname to use to refer to this Bitmap in SplashKit. The `bitmap` can then\nbe retrieved by passing this `name` to the `bitmap_named` function.", + "brief": null, + "return": { + "type": "bitmap", + "description": "The loaded bitmap", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "name": { + "type": "string", + "description": "The name of the bitmap resource in SplashKit", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32287,9 +31452,9 @@ "is_vector": false, "type_parameter": null }, - "opts": { - "type": "drawing_options", - "description": "the `drawing_options` which provide extra information\nfor how to draw the `bitmap`", + "filename": { + "type": "string", + "description": "The filename to load", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32302,72 +31467,48 @@ } }, "attributes": { - "suffix": "named_with_options", + "class": "bitmap", + "constructor": true, "group": "graphics", "static": "images" }, "signatures": { - "python": [ - "def draw_bitmap_named_with_options(name, x, y, opts):" - ], "cpp": [ - "void draw_bitmap(string name, double x, double y, drawing_options opts)" + "bitmap load_bitmap(string name, string filename)" + ], + "python": [ + "def load_bitmap(name, filename):" ], "csharp": [ - "public static void SplashKit.DrawBitmap(string name, double x, double y, DrawingOptions opts);" + "public static Bitmap SplashKit.LoadBitmap(string name, string filename);", + "public Bitmap(string name, string filename);" ], "pascal": [ - "procedure DrawBitmap(name: String; x: Double; y: Double; opts: DrawingOptions)" + "function LoadBitmap(name: String; filename: String): Bitmap" ] } }, { - "signature": "void draw_bitmap_on_bitmap(bitmap destination,bitmap bmp,double x,double y);", - "name": "draw_bitmap_on_bitmap", - "method_name": "draw_bitmap", - "unique_global_name": "draw_bitmap_on_bitmap_on_bitmap", - "unique_method_name": "bitmap.draw_bitmap_on_bitmap", + "signature": "bool pixel_drawn_at_point(bitmap bmp,const point_2d &pt);", + "name": "pixel_drawn_at_point", + "method_name": "pixel_drawn_at_point", + "unique_global_name": "pixel_drawn_at_point_pt", + "unique_method_name": "bitmap.pixel_drawn_at_point_pt", "suffix_name": null, - "description": "Draws the bitmap supplied into `bmp` to the given bitmap.\nat `x` and `y`.", + "description": "Check if the bitmap has a pixel drawn at the indicated point.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "True if the pixel at that point in the bitmap is drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "bitmap", - "description": "the bitmap to draw the bitmap to", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, "bmp": { "type": "bitmap", - "description": "the bitmap which will be drawn to the screen", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "the x location which represents where the bitmap\nwill be drawn", + "description": "The bitmap to check.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32378,12 +31519,12 @@ "is_vector": false, "type_parameter": null }, - "y": { - "type": "double", - "description": "the y location which represents where the bitmap\nwill be drawn", + "pt": { + "type": "point_2d", + "description": "The point within the bitmap to check.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -32394,62 +31535,49 @@ }, "attributes": { "class": "bitmap", - "method": "draw_bitmap", - "self": "bmp", - "suffix": "on_bitmap", + "method": "pixel_drawn_at_point", + "suffix": "pt", "group": "graphics", - "static": "images" + "static": "images", + "self": "bmp" }, "signatures": { - "python": [ - "def draw_bitmap_on_bitmap_on_bitmap(destination, bmp, x, y):" - ], "cpp": [ - "void draw_bitmap_on_bitmap(bitmap destination, bitmap bmp, double x, double y)" + "bool pixel_drawn_at_point(bitmap bmp, const point_2d &pt)" + ], + "python": [ + "def pixel_drawn_at_point_pt(bmp, pt):" ], "csharp": [ - "public void Bitmap.DrawBitmap(Bitmap destination, double x, double y);", - "public static void SplashKit.DrawBitmapOnBitmap(Bitmap destination, Bitmap bmp, double x, double y);" + "public bool Bitmap.PixelDrawnAtPoint(Point2D pt);", + "public static bool SplashKit.PixelDrawnAtPoint(Bitmap bmp, Point2D pt);" ], "pascal": [ - "procedure DrawBitmapOnBitmap(destination: Bitmap; bmp: Bitmap; x: Double; y: Double)" + "function PixelDrawnAtPoint(bmp: Bitmap; const pt: Point2D): Boolean" ] } }, { - "signature": "void draw_bitmap_on_bitmap(bitmap destination,bitmap bmp,double x,double y,drawing_options opts);", - "name": "draw_bitmap_on_bitmap", - "method_name": "draw_bitmap", - "unique_global_name": "draw_bitmap_on_bitmap_on_bitmap_with_options", - "unique_method_name": "bitmap.draw_bitmap_on_bitmap_with_options", + "signature": "bool pixel_drawn_at_point(bitmap bmp,double x,double y);", + "name": "pixel_drawn_at_point", + "method_name": "pixel_drawn_at_point", + "unique_global_name": "pixel_drawn_at_point", + "unique_method_name": "bitmap.pixel_drawn_at_point", "suffix_name": null, - "description": "Draws the bitmap supplied into `bmp` to the given bitmap.\nwith extra drawing options supplied in `opts` at `x` and `y`.", + "description": "Check if the bitmap has a pixel drawn at the indicated point.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "True if the pixel at that point in the bitmap is drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "bitmap", - "description": "the bitmap to draw the bitmap to", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, "bmp": { "type": "bitmap", - "description": "the bitmap which will be drawn to the screen", + "description": "The bitmap to check.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32462,7 +31590,7 @@ }, "x": { "type": "double", - "description": "the x location which represents where the bitmap\nwill be drawn", + "description": "The x coordinate within the bitmap to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32475,20 +31603,7 @@ }, "y": { "type": "double", - "description": "the y location which represents where the bitmap\nwill be drawn", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "the `drawing_options` which provide extra information\nfor how to draw the `bitmap`", + "description": "The y coordinate within the bitmap to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32502,62 +31617,48 @@ }, "attributes": { "class": "bitmap", - "method": "draw_bitmap", - "self": "bmp", - "suffix": "on_bitmap_with_options", + "method": "pixel_drawn_at_point", "group": "graphics", - "static": "images" + "static": "images", + "self": "bmp" }, "signatures": { - "python": [ - "def draw_bitmap_on_bitmap_on_bitmap_with_options(destination, bmp, x, y, opts):" - ], "cpp": [ - "void draw_bitmap_on_bitmap(bitmap destination, bitmap bmp, double x, double y, drawing_options opts)" + "bool pixel_drawn_at_point(bitmap bmp, double x, double y)" + ], + "python": [ + "def pixel_drawn_at_point(bmp, x, y):" ], "csharp": [ - "public void Bitmap.DrawBitmap(Bitmap destination, double x, double y, DrawingOptions opts);", - "public static void SplashKit.DrawBitmapOnBitmap(Bitmap destination, Bitmap bmp, double x, double y, DrawingOptions opts);" + "public bool Bitmap.PixelDrawnAtPoint(double x, double y);", + "public static bool SplashKit.PixelDrawnAtPoint(Bitmap bmp, double x, double y);" ], "pascal": [ - "procedure DrawBitmapOnBitmap(destination: Bitmap; bmp: Bitmap; x: Double; y: Double; opts: DrawingOptions)" + "function PixelDrawnAtPoint(bmp: Bitmap; x: Double; y: Double): Boolean" ] } }, { - "signature": "void draw_bitmap_on_window(window destination,bitmap bmp,double x,double y);", - "name": "draw_bitmap_on_window", - "method_name": "draw_bitmap", - "unique_global_name": "draw_bitmap_on_window", - "unique_method_name": "window.draw_bitmap", + "signature": "bool pixel_drawn_at_point(bitmap bmp,int cell,const point_2d &pt);", + "name": "pixel_drawn_at_point", + "method_name": "pixel_drawn_at_point_in_cell", + "unique_global_name": "pixel_drawn_at_point_in_cell_pt", + "unique_method_name": "bitmap.pixel_drawn_at_point_in_cell_in_cell_pt", "suffix_name": null, - "description": "Draws the bitmap supplied into `bmp` to the given window.\nat `x` and `y`.", + "description": "Check if the bitmap has a pixel drawn at the indicated point in the cell.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "True if the pixel at that point in the bitmap's cell is\ndrawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "the window to draw the bitmap to", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, "bmp": { "type": "bitmap", - "description": "the bitmap which will be drawn to the screen", + "description": "The bitmap to check.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32568,9 +31669,9 @@ "is_vector": false, "type_parameter": null }, - "x": { - "type": "double", - "description": "the x location which represents where the bitmap\nwill be drawn", + "cell": { + "type": "int", + "description": "The bitmap cell to check.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32581,12 +31682,12 @@ "is_vector": false, "type_parameter": null }, - "y": { - "type": "double", - "description": "the y location which represents where the bitmap\nwill be drawn", + "pt": { + "type": "point_2d", + "description": "The point within the bitmap to check.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -32596,49 +31697,50 @@ } }, "attributes": { - "class": "window", - "method": "draw_bitmap", - "self": "destination", + "class": "bitmap", + "method": "pixel_drawn_at_point_in_cell", + "suffix": "in_cell_pt", "group": "graphics", - "static": "images" + "static": "images", + "self": "bmp" }, "signatures": { - "python": [ - "def draw_bitmap_on_window(destination, bmp, x, y):" - ], "cpp": [ - "void draw_bitmap_on_window(window destination, bitmap bmp, double x, double y)" + "bool pixel_drawn_at_point(bitmap bmp, int cell, const point_2d &pt)" + ], + "python": [ + "def pixel_drawn_at_point_in_cell_pt(bmp, cell, pt):" ], "csharp": [ - "public void Window.DrawBitmap(Bitmap bmp, double x, double y);", - "public static void SplashKit.DrawBitmapOnWindow(Window destination, Bitmap bmp, double x, double y);" + "public bool Bitmap.PixelDrawnAtPointInCell(int cell, Point2D pt);", + "public static bool SplashKit.PixelDrawnAtPoint(Bitmap bmp, int cell, Point2D pt);" ], "pascal": [ - "procedure DrawBitmapOnWindow(destination: Window; bmp: Bitmap; x: Double; y: Double)" + "function PixelDrawnAtPoint(bmp: Bitmap; cell: Integer; const pt: Point2D): Boolean" ] } }, { - "signature": "void draw_bitmap_on_window(window destination,bitmap bmp,double x,double y,drawing_options opts);", - "name": "draw_bitmap_on_window", - "method_name": "draw_bitmap", - "unique_global_name": "draw_bitmap_on_window_with_options", - "unique_method_name": "window.draw_bitmap_with_options", + "signature": "bool pixel_drawn_at_point(bitmap bmp,int cell,double x,double y);", + "name": "pixel_drawn_at_point", + "method_name": "pixel_drawn_at_point", + "unique_global_name": "pixel_drawn_at_point_in_cell", + "unique_method_name": "bitmap.pixel_drawn_at_point_in_cell", "suffix_name": null, - "description": "Draws the bitmap supplied into `bmp` to the given window.\nwith extra drawing options supplied in `opts` at `x` and `y`.", + "description": "Check if the bitmap has a pixel drawn at the indicated point in the cell.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "True if the pixel at that point in the bitmap's cell is\ndrawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "the window to draw the bitmap to", + "bmp": { + "type": "bitmap", + "description": "The bitmap to check.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32649,9 +31751,9 @@ "is_vector": false, "type_parameter": null }, - "bmp": { - "type": "bitmap", - "description": "the bitmap which will be drawn to the screen", + "cell": { + "type": "int", + "description": "The bitmap cell to check.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32664,7 +31766,7 @@ }, "x": { "type": "double", - "description": "the x location which represents where the bitmap\nwill be drawn", + "description": "The x coordinate within the bitmap to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32677,20 +31779,7 @@ }, "y": { "type": "double", - "description": "the y location which represents where the bitmap\nwill be drawn", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "the `drawing_options` which provide extra information\nfor how to draw the `bitmap`", + "description": "The y coordinate within the bitmap to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32703,75 +31792,37 @@ } }, "attributes": { - "class": "window", - "method": "draw_bitmap", - "self": "destination", - "suffix": "with_options", + "class": "bitmap", + "method": "pixel_drawn_at_point", + "suffix": "in_cell", "group": "graphics", - "static": "images" + "static": "images", + "self": "bmp" }, "signatures": { - "python": [ - "def draw_bitmap_on_window_with_options(destination, bmp, x, y, opts):" - ], "cpp": [ - "void draw_bitmap_on_window(window destination, bitmap bmp, double x, double y, drawing_options opts)" - ], - "csharp": [ - "public void Window.DrawBitmap(Bitmap bmp, double x, double y, DrawingOptions opts);", - "public static void SplashKit.DrawBitmapOnWindow(Window destination, Bitmap bmp, double x, double y, DrawingOptions opts);" + "bool pixel_drawn_at_point(bitmap bmp, int cell, double x, double y)" ], - "pascal": [ - "procedure DrawBitmapOnWindow(destination: Window; bmp: Bitmap; x: Double; y: Double; opts: DrawingOptions)" - ] - } - }, - { - "signature": "void free_all_bitmaps();", - "name": "free_all_bitmaps", - "method_name": null, - "unique_global_name": "free_all_bitmaps", - "unique_method_name": null, - "suffix_name": null, - "description": "Free all of the loaded bitmap resources.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "graphics", - "static": "images" - }, - "signatures": { "python": [ - "def free_all_bitmaps():" - ], - "cpp": [ - "void free_all_bitmaps()" + "def pixel_drawn_at_point_in_cell(bmp, cell, x, y):" ], "csharp": [ - "public static void SplashKit.FreeAllBitmaps();" + "public bool Bitmap.PixelDrawnAtPoint(int cell, double x, double y);", + "public static bool SplashKit.PixelDrawnAtPoint(Bitmap bmp, int cell, double x, double y);" ], "pascal": [ - "procedure FreeAllBitmaps()" + "function PixelDrawnAtPoint(bmp: Bitmap; cell: Integer; x: Double; y: Double): Boolean" ] } }, { - "signature": "void free_bitmap(bitmap to_delete);", - "name": "free_bitmap", - "method_name": "free", - "unique_global_name": "free_bitmap", - "unique_method_name": "bitmap.free", + "signature": "void setup_collision_mask(bitmap bmp);", + "name": "setup_collision_mask", + "method_name": "setup_collision_mask", + "unique_global_name": "setup_collision_mask", + "unique_method_name": "bitmap.setup_collision_mask", "suffix_name": null, - "description": "Frees the bitmap resource.", + "description": "Sets up the collision mask for a bitmap. This enables collision detection between\nthis bitmap and other bitmaps or shapes.\n\nThis is automatically called when a bitmap is loaded, and only needs to be \ncalled on bitmaps created using `create_bitmap`, and when a bitmap is\nchanged by drawing onto the bitmap.", "brief": null, "return": { "type": "void", @@ -32782,9 +31833,9 @@ "type_parameter": null }, "parameters": { - "to_delete": { + "bmp": { "type": "bitmap", - "description": "The bitmap to be freed.", + "description": "the bitmap to setup", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32798,100 +31849,112 @@ }, "attributes": { "class": "bitmap", - "destructor": true, - "method": "free", + "method": "setup_collision_mask", "group": "graphics", "static": "images", - "self": "to_delete" + "self": "bmp" }, "signatures": { - "python": [ - "def free_bitmap(to_delete):" - ], "cpp": [ - "void free_bitmap(bitmap to_delete)" + "void setup_collision_mask(bitmap bmp)" + ], + "python": [ + "def setup_collision_mask(bmp):" ], "csharp": [ - "public void Bitmap.Free();", - "public static void SplashKit.FreeBitmap(Bitmap toDelete);" + "public void Bitmap.SetupCollisionMask();", + "public static void SplashKit.SetupCollisionMask(Bitmap bmp);" ], "pascal": [ - "procedure FreeBitmap(toDelete: Bitmap)" + "procedure SetupCollisionMask(bmp: Bitmap)" ] } }, { - "signature": "bool has_bitmap(string name);", - "name": "has_bitmap", + "signature": "void draw_line(color clr,const line &l);", + "name": "draw_line", "method_name": null, - "unique_global_name": "has_bitmap", + "unique_global_name": "draw_line_record", "unique_method_name": null, "suffix_name": null, - "description": "Determines if SplashKit has a bitmap loaded for the supplied name.\nThis checks against all bitmaps loaded.", + "description": "Draws a line onto the current window.", "brief": null, "return": { - "type": "bool", - "description": "True if SplashKit has a bitmap with that name", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name to check", + "clr": { + "type": "color", + "description": "The color of the line", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "l": { + "type": "line", + "description": "The line's details", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { - "group": "graphics", - "static": "images" + "suffix": "record", + "group": "graphics" }, "signatures": { - "python": [ - "def has_bitmap(name):" - ], "cpp": [ - "bool has_bitmap(string name)" + "void draw_line(color clr, const line &l)" + ], + "python": [ + "def draw_line_record(clr, l):" ], "csharp": [ - "public static bool SplashKit.HasBitmap(string name);" + "public static void SplashKit.DrawLine(Color clr, Line l);" ], "pascal": [ - "function HasBitmap(name: String): Boolean" + "procedure DrawLine(clr: Color; const l: Line)" ] } }, { - "signature": "bitmap load_bitmap(string name,string filename);", - "name": "load_bitmap", + "signature": "void draw_line(color clr,const line &l,drawing_options opts);", + "name": "draw_line", "method_name": null, - "unique_global_name": "load_bitmap", + "unique_global_name": "draw_line_record_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Loads and returns a bitmap. The supplied `filename` is used to\nlocate the Bitmap to load. The supplied `name` indicates the\nname to use to refer to this Bitmap in SplashKit. The `bitmap` can then\nbe retrieved by passing this `name` to the `bitmap_named` function.", + "description": "Draws a line.", "brief": null, "return": { - "type": "bitmap", - "description": "The loaded bitmap", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name of the bitmap resource in SplashKit", + "clr": { + "type": "color", + "description": "The color of the line", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32902,9 +31965,22 @@ "is_vector": false, "type_parameter": null }, - "filename": { - "type": "string", - "description": "The filename to load", + "l": { + "type": "line", + "description": "The line's details", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "opts": { + "type": "drawing_options", + "description": "The drawing options", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32917,48 +31993,45 @@ } }, "attributes": { - "class": "bitmap", - "constructor": true, - "group": "graphics", - "static": "images" + "suffix": "record_with_options", + "group": "graphics" }, "signatures": { - "python": [ - "def load_bitmap(name, filename):" - ], "cpp": [ - "bitmap load_bitmap(string name, string filename)" + "void draw_line(color clr, const line &l, drawing_options opts)" + ], + "python": [ + "def draw_line_record_with_options(clr, l, opts):" ], "csharp": [ - "public static Bitmap SplashKit.LoadBitmap(string name, string filename);", - "public Bitmap(string name, string filename);" + "public static void SplashKit.DrawLine(Color clr, Line l, DrawingOptions opts);" ], "pascal": [ - "function LoadBitmap(name: String; filename: String): Bitmap" + "procedure DrawLine(clr: Color; const l: Line; opts: DrawingOptions)" ] } }, { - "signature": "bool pixel_drawn_at_point(bitmap bmp,const point_2d &pt);", - "name": "pixel_drawn_at_point", - "method_name": "pixel_drawn_at_point", - "unique_global_name": "pixel_drawn_at_point_pt", - "unique_method_name": "bitmap.pixel_drawn_at_point_pt", + "signature": "void draw_line(color clr,const point_2d &from_pt,const point_2d &to_pt);", + "name": "draw_line", + "method_name": null, + "unique_global_name": "draw_line_point_to_point", + "unique_method_name": null, "suffix_name": null, - "description": "Check if the bitmap has a pixel drawn at the indicated point.", + "description": "Draw a line from one point to another on the current window.", "brief": null, "return": { - "type": "bool", - "description": "True if the pixel at that point in the bitmap is drawn.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to check.", + "clr": { + "type": "color", + "description": "The color of the line", "is_pointer": false, "is_const": false, "is_reference": false, @@ -32969,9 +32042,22 @@ "is_vector": false, "type_parameter": null }, - "pt": { + "from_pt": { "type": "point_2d", - "description": "The point within the bitmap to check.", + "description": "The start of the line", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "to_pt": { + "type": "point_2d", + "description": "The end of the line", "is_pointer": false, "is_const": true, "is_reference": true, @@ -32984,50 +32070,45 @@ } }, "attributes": { - "class": "bitmap", - "method": "pixel_drawn_at_point", - "suffix": "pt", - "group": "graphics", - "static": "images", - "self": "bmp" + "suffix": "point_to_point", + "group": "graphics" }, "signatures": { - "python": [ - "def pixel_drawn_at_point_pt(bmp, pt):" - ], "cpp": [ - "bool pixel_drawn_at_point(bitmap bmp, const point_2d &pt)" + "void draw_line(color clr, const point_2d &from_pt, const point_2d &to_pt)" + ], + "python": [ + "def draw_line_point_to_point(clr, from_pt, to_pt):" ], "csharp": [ - "public bool Bitmap.PixelDrawnAtPoint(Point2D pt);", - "public static bool SplashKit.PixelDrawnAtPoint(Bitmap bmp, Point2D pt);" + "public static void SplashKit.DrawLine(Color clr, Point2D fromPt, Point2D toPt);" ], "pascal": [ - "function PixelDrawnAtPoint(bmp: Bitmap; const pt: Point2D): Boolean" + "procedure DrawLine(clr: Color; const fromPt: Point2D; const toPt: Point2D)" ] } }, { - "signature": "bool pixel_drawn_at_point(bitmap bmp,double x,double y);", - "name": "pixel_drawn_at_point", - "method_name": "pixel_drawn_at_point", - "unique_global_name": "pixel_drawn_at_point", - "unique_method_name": "bitmap.pixel_drawn_at_point", + "signature": "void draw_line(color clr,const point_2d &from_pt,const point_2d &to_pt,const drawing_options &opts);", + "name": "draw_line", + "method_name": null, + "unique_global_name": "draw_line_point_to_point_with_options", + "unique_method_name": null, "suffix_name": null, - "description": "Check if the bitmap has a pixel drawn at the indicated point.", + "description": "Draw a line from one point to another on the current window.", "brief": null, "return": { - "type": "bool", - "description": "True if the pixel at that point in the bitmap is drawn.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to check.", + "clr": { + "type": "color", + "description": "The color of the line", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33038,12 +32119,12 @@ "is_vector": false, "type_parameter": null }, - "x": { - "type": "double", - "description": "The x coordinate within the bitmap to check", + "from_pt": { + "type": "point_2d", + "description": "The start of the line", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -33051,12 +32132,25 @@ "is_vector": false, "type_parameter": null }, - "y": { - "type": "double", - "description": "The y coordinate within the bitmap to check", + "to_pt": { + "type": "point_2d", + "description": "The end of the line", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "opts": { + "type": "drawing_options", + "description": "The drawing options", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -33066,49 +32160,45 @@ } }, "attributes": { - "class": "bitmap", - "method": "pixel_drawn_at_point", - "group": "graphics", - "static": "images", - "self": "bmp" + "suffix": "point_to_point_with_options", + "group": "graphics" }, "signatures": { - "python": [ - "def pixel_drawn_at_point(bmp, x, y):" - ], "cpp": [ - "bool pixel_drawn_at_point(bitmap bmp, double x, double y)" + "void draw_line(color clr, const point_2d &from_pt, const point_2d &to_pt, const drawing_options &opts)" + ], + "python": [ + "def draw_line_point_to_point_with_options(clr, from_pt, to_pt, opts):" ], "csharp": [ - "public bool Bitmap.PixelDrawnAtPoint(double x, double y);", - "public static bool SplashKit.PixelDrawnAtPoint(Bitmap bmp, double x, double y);" + "public static void SplashKit.DrawLine(Color clr, Point2D fromPt, Point2D toPt, DrawingOptions opts);" ], "pascal": [ - "function PixelDrawnAtPoint(bmp: Bitmap; x: Double; y: Double): Boolean" + "procedure DrawLine(clr: Color; const fromPt: Point2D; const toPt: Point2D; const opts: DrawingOptions)" ] } }, { - "signature": "bool pixel_drawn_at_point(bitmap bmp,int cell,const point_2d &pt);", - "name": "pixel_drawn_at_point", - "method_name": "pixel_drawn_at_point_in_cell", - "unique_global_name": "pixel_drawn_at_point_in_cell_pt", - "unique_method_name": "bitmap.pixel_drawn_at_point_in_cell_in_cell_pt", + "signature": "void draw_line(color clr,double x1,double y1,double x2,double y2);", + "name": "draw_line", + "method_name": null, + "unique_global_name": "draw_line", + "unique_method_name": null, "suffix_name": null, - "description": "Check if the bitmap has a pixel drawn at the indicated point in the cell.", + "description": "Draw a line from one point to another on the current window.", "brief": null, "return": { - "type": "bool", - "description": "True if the pixel at that point in the bitmap's cell is\ndrawn.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to check.", + "clr": { + "type": "color", + "description": "The color of the line", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33119,9 +32209,9 @@ "is_vector": false, "type_parameter": null }, - "cell": { - "type": "int", - "description": "The bitmap cell to check.", + "x1": { + "type": "double", + "description": "The distance from the left of the window/bitmap to the first\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33132,12 +32222,38 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The point within the bitmap to check.", + "y1": { + "type": "double", + "description": "The distance from the top of the window/bitmap to the first\npoint", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x2": { + "type": "double", + "description": "The distance from the left of the window/bitmap to the second\npoint", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y2": { + "type": "double", + "description": "The distance from the top of the window/bitmap to the second\npoint", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -33147,50 +32263,44 @@ } }, "attributes": { - "class": "bitmap", - "method": "pixel_drawn_at_point_in_cell", - "suffix": "in_cell_pt", - "group": "graphics", - "static": "images", - "self": "bmp" + "group": "graphics" }, "signatures": { - "python": [ - "def pixel_drawn_at_point_in_cell_pt(bmp, cell, pt):" - ], "cpp": [ - "bool pixel_drawn_at_point(bitmap bmp, int cell, const point_2d &pt)" + "void draw_line(color clr, double x1, double y1, double x2, double y2)" + ], + "python": [ + "def draw_line(clr, x1, y1, x2, y2):" ], "csharp": [ - "public bool Bitmap.PixelDrawnAtPointInCell(int cell, Point2D pt);", - "public static bool SplashKit.PixelDrawnAtPoint(Bitmap bmp, int cell, Point2D pt);" + "public static void SplashKit.DrawLine(Color clr, double x1, double y1, double x2, double y2);" ], "pascal": [ - "function PixelDrawnAtPoint(bmp: Bitmap; cell: Integer; const pt: Point2D): Boolean" + "procedure DrawLine(clr: Color; x1: Double; y1: Double; x2: Double; y2: Double)" ] } }, { - "signature": "bool pixel_drawn_at_point(bitmap bmp,int cell,double x,double y);", - "name": "pixel_drawn_at_point", - "method_name": "pixel_drawn_at_point", - "unique_global_name": "pixel_drawn_at_point_in_cell", - "unique_method_name": "bitmap.pixel_drawn_at_point_in_cell", + "signature": "void draw_line(color clr,double x1,double y1,double x2,double y2,const drawing_options &opts);", + "name": "draw_line", + "method_name": null, + "unique_global_name": "draw_line_with_options", + "unique_method_name": null, "suffix_name": null, - "description": "Check if the bitmap has a pixel drawn at the indicated point in the cell.", + "description": "Draw a line from one point to another", "brief": null, "return": { - "type": "bool", - "description": "True if the pixel at that point in the bitmap's cell is\ndrawn.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to check.", + "clr": { + "type": "color", + "description": "The color of the line", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33201,9 +32311,9 @@ "is_vector": false, "type_parameter": null }, - "cell": { - "type": "int", - "description": "The bitmap cell to check.", + "x1": { + "type": "double", + "description": "The distance from the left of the window/bitmap to the first\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33214,9 +32324,9 @@ "is_vector": false, "type_parameter": null }, - "x": { + "y1": { "type": "double", - "description": "The x coordinate within the bitmap to check", + "description": "The distance from the top of the window/bitmap to the first\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33227,52 +32337,73 @@ "is_vector": false, "type_parameter": null }, - "y": { + "x2": { "type": "double", - "description": "The y coordinate within the bitmap to check", + "description": "The distance from the left of the window/bitmap to the second\npoint", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y2": { + "type": "double", + "description": "The distance from the top of the window/bitmap to the second\npoint", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "opts": { + "type": "drawing_options", + "description": "The drawing options", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "bitmap", - "method": "pixel_drawn_at_point", - "suffix": "in_cell", - "group": "graphics", - "static": "images", - "self": "bmp" + "suffix": "with_options", + "group": "graphics" }, "signatures": { - "python": [ - "def pixel_drawn_at_point_in_cell(bmp, cell, x, y):" - ], "cpp": [ - "bool pixel_drawn_at_point(bitmap bmp, int cell, double x, double y)" + "void draw_line(color clr, double x1, double y1, double x2, double y2, const drawing_options &opts)" + ], + "python": [ + "def draw_line_with_options(clr, x1, y1, x2, y2, opts):" ], "csharp": [ - "public bool Bitmap.PixelDrawnAtPoint(int cell, double x, double y);", - "public static bool SplashKit.PixelDrawnAtPoint(Bitmap bmp, int cell, double x, double y);" + "public static void SplashKit.DrawLine(Color clr, double x1, double y1, double x2, double y2, DrawingOptions opts);" ], "pascal": [ - "function PixelDrawnAtPoint(bmp: Bitmap; cell: Integer; x: Double; y: Double): Boolean" + "procedure DrawLine(clr: Color; x1: Double; y1: Double; x2: Double; y2: Double; const opts: DrawingOptions)" ] } }, { - "signature": "void setup_collision_mask(bitmap bmp);", - "name": "setup_collision_mask", - "method_name": "setup_collision_mask", - "unique_global_name": "setup_collision_mask", - "unique_method_name": "bitmap.setup_collision_mask", + "signature": "void draw_line_on_bitmap(bitmap destination,color clr,const line &l);", + "name": "draw_line_on_bitmap", + "method_name": "draw_line", + "unique_global_name": "draw_line_on_bitmap_record", + "unique_method_name": "bitmap.draw_line_record", "suffix_name": null, - "description": "Sets up the collision mask for a bitmap. This enables collision detection between\nthis bitmap and other bitmaps or shapes.\n\nThis is automatically called when a bitmap is loaded, and only needs to be \ncalled on bitmaps created using `create_bitmap`, and when a bitmap is\nchanged by drawing onto the bitmap.", + "description": "Draws a line onto the given bitmap.", "brief": null, "return": { "type": "void", @@ -33283,9 +32414,9 @@ "type_parameter": null }, "parameters": { - "bmp": { + "destination": { "type": "bitmap", - "description": "the bitmap to setup", + "description": "The destination bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33295,49 +32426,7 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "bitmap", - "method": "setup_collision_mask", - "group": "graphics", - "static": "images", - "self": "bmp" - }, - "signatures": { - "python": [ - "def setup_collision_mask(bmp):" - ], - "cpp": [ - "void setup_collision_mask(bitmap bmp)" - ], - "csharp": [ - "public void Bitmap.SetupCollisionMask();", - "public static void SplashKit.SetupCollisionMask(Bitmap bmp);" - ], - "pascal": [ - "procedure SetupCollisionMask(bmp: Bitmap)" - ] - } - }, - { - "signature": "void draw_line(color clr,const line &l);", - "name": "draw_line", - "method_name": null, - "unique_global_name": "draw_line_record", - "unique_method_name": null, - "suffix_name": null, - "description": "Draws a line onto the current window.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { + }, "clr": { "type": "color", "description": "The color of the line", @@ -33366,32 +32455,36 @@ } }, "attributes": { + "class": "bitmap", + "method": "draw_line", "suffix": "record", - "group": "graphics" + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def draw_line_record(clr, l):" - ], "cpp": [ - "void draw_line(color clr, const line &l)" + "void draw_line_on_bitmap(bitmap destination, color clr, const line &l)" + ], + "python": [ + "def draw_line_on_bitmap_record(destination, clr, l):" ], "csharp": [ - "public static void SplashKit.DrawLine(Color clr, Line l);" + "public void Bitmap.DrawLine(Color clr, Line l);", + "public static void SplashKit.DrawLineOnBitmap(Bitmap destination, Color clr, Line l);" ], "pascal": [ - "procedure DrawLine(clr: Color; const l: Line)" + "procedure DrawLineOnBitmap(destination: Bitmap; clr: Color; const l: Line)" ] } }, { - "signature": "void draw_line(color clr,const line &l,drawing_options opts);", - "name": "draw_line", - "method_name": null, - "unique_global_name": "draw_line_record_with_options", - "unique_method_name": null, + "signature": "void draw_line_on_bitmap(bitmap destination,color clr,const line &l,drawing_options opts);", + "name": "draw_line_on_bitmap", + "method_name": "draw_line", + "unique_global_name": "draw_line_on_bitmap_record_with_options", + "unique_method_name": "bitmap.draw_line_record_with_options", "suffix_name": null, - "description": "Draws a line.", + "description": "Draws a line on the given bitmap.", "brief": null, "return": { "type": "void", @@ -33402,6 +32495,19 @@ "type_parameter": null }, "parameters": { + "destination": { + "type": "bitmap", + "description": "The destination bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "clr": { "type": "color", "description": "The color of the line", @@ -33443,32 +32549,36 @@ } }, "attributes": { + "class": "bitmap", + "method": "draw_line", "suffix": "record_with_options", - "group": "graphics" + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def draw_line_record_with_options(clr, l, opts):" - ], "cpp": [ - "void draw_line(color clr, const line &l, drawing_options opts)" + "void draw_line_on_bitmap(bitmap destination, color clr, const line &l, drawing_options opts)" + ], + "python": [ + "def draw_line_on_bitmap_record_with_options(destination, clr, l, opts):" ], "csharp": [ - "public static void SplashKit.DrawLine(Color clr, Line l, DrawingOptions opts);" + "public void Bitmap.DrawLine(Color clr, Line l, DrawingOptions opts);", + "public static void SplashKit.DrawLineOnBitmap(Bitmap destination, Color clr, Line l, DrawingOptions opts);" ], "pascal": [ - "procedure DrawLine(clr: Color; const l: Line; opts: DrawingOptions)" + "procedure DrawLineOnBitmap(destination: Bitmap; clr: Color; const l: Line; opts: DrawingOptions)" ] } }, { - "signature": "void draw_line(color clr,const point_2d &from_pt,const point_2d &to_pt);", - "name": "draw_line", - "method_name": null, - "unique_global_name": "draw_line_point_to_point", - "unique_method_name": null, + "signature": "void draw_line_on_bitmap(bitmap destination,color clr,const point_2d &from_pt,const point_2d &to_pt);", + "name": "draw_line_on_bitmap", + "method_name": "draw_line", + "unique_global_name": "draw_line_on_bitmap_point_to_point", + "unique_method_name": "bitmap.draw_line_point_to_point", "suffix_name": null, - "description": "Draw a line from one point to another on the current window.", + "description": "Draw a line from one point to another on the given bitmap.", "brief": null, "return": { "type": "void", @@ -33479,9 +32589,9 @@ "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color of the line", + "destination": { + "type": "bitmap", + "description": "The destination bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33492,10 +32602,23 @@ "is_vector": false, "type_parameter": null }, - "from_pt": { - "type": "point_2d", - "description": "The start of the line", - "is_pointer": false, + "clr": { + "type": "color", + "description": "The color of the line", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "from_pt": { + "type": "point_2d", + "description": "The start of the line", + "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, @@ -33520,32 +32643,36 @@ } }, "attributes": { + "class": "bitmap", + "method": "draw_line", "suffix": "point_to_point", - "group": "graphics" + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def draw_line_point_to_point(clr, from_pt, to_pt):" - ], "cpp": [ - "void draw_line(color clr, const point_2d &from_pt, const point_2d &to_pt)" + "void draw_line_on_bitmap(bitmap destination, color clr, const point_2d &from_pt, const point_2d &to_pt)" + ], + "python": [ + "def draw_line_on_bitmap_point_to_point(destination, clr, from_pt, to_pt):" ], "csharp": [ - "public static void SplashKit.DrawLine(Color clr, Point2D fromPt, Point2D toPt);" + "public void Bitmap.DrawLine(Color clr, Point2D fromPt, Point2D toPt);", + "public static void SplashKit.DrawLineOnBitmap(Bitmap destination, Color clr, Point2D fromPt, Point2D toPt);" ], "pascal": [ - "procedure DrawLine(clr: Color; const fromPt: Point2D; const toPt: Point2D)" + "procedure DrawLineOnBitmap(destination: Bitmap; clr: Color; const fromPt: Point2D; const toPt: Point2D)" ] } }, { - "signature": "void draw_line(color clr,const point_2d &from_pt,const point_2d &to_pt,const drawing_options &opts);", - "name": "draw_line", - "method_name": null, - "unique_global_name": "draw_line_point_to_point_with_options", - "unique_method_name": null, + "signature": "void draw_line_on_bitmap(bitmap destination,color clr,const point_2d &from_pt,const point_2d &to_pt,const drawing_options &opts);", + "name": "draw_line_on_bitmap", + "method_name": "draw_line", + "unique_global_name": "draw_line_on_bitmap_point_to_point_with_options", + "unique_method_name": "bitmap.draw_line_point_to_point_with_options", "suffix_name": null, - "description": "Draw a line from one point to another on the current window.", + "description": "Draw a line from one point to another on the given bitmap.", "brief": null, "return": { "type": "void", @@ -33556,6 +32683,19 @@ "type_parameter": null }, "parameters": { + "destination": { + "type": "bitmap", + "description": "The destination bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "clr": { "type": "color", "description": "The color of the line", @@ -33610,32 +32750,36 @@ } }, "attributes": { + "class": "bitmap", + "method": "draw_line", "suffix": "point_to_point_with_options", - "group": "graphics" + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def draw_line_point_to_point_with_options(clr, from_pt, to_pt, opts):" - ], "cpp": [ - "void draw_line(color clr, const point_2d &from_pt, const point_2d &to_pt, const drawing_options &opts)" + "void draw_line_on_bitmap(bitmap destination, color clr, const point_2d &from_pt, const point_2d &to_pt, const drawing_options &opts)" + ], + "python": [ + "def draw_line_on_bitmap_point_to_point_with_options(destination, clr, from_pt, to_pt, opts):" ], "csharp": [ - "public static void SplashKit.DrawLine(Color clr, Point2D fromPt, Point2D toPt, DrawingOptions opts);" + "public void Bitmap.DrawLine(Color clr, Point2D fromPt, Point2D toPt, DrawingOptions opts);", + "public static void SplashKit.DrawLineOnBitmap(Bitmap destination, Color clr, Point2D fromPt, Point2D toPt, DrawingOptions opts);" ], "pascal": [ - "procedure DrawLine(clr: Color; const fromPt: Point2D; const toPt: Point2D; const opts: DrawingOptions)" + "procedure DrawLineOnBitmap(destination: Bitmap; clr: Color; const fromPt: Point2D; const toPt: Point2D; const opts: DrawingOptions)" ] } }, { - "signature": "void draw_line(color clr,double x1,double y1,double x2,double y2);", - "name": "draw_line", - "method_name": null, - "unique_global_name": "draw_line", - "unique_method_name": null, + "signature": "void draw_line_on_bitmap(bitmap destination,color clr,double x1,double y1,double x2,double y2);", + "name": "draw_line_on_bitmap", + "method_name": "draw_line", + "unique_global_name": "draw_line_on_bitmap", + "unique_method_name": "bitmap.draw_line", "suffix_name": null, - "description": "Draw a line from one point to another on the current window.", + "description": "Draw a line from one point to another on the given bitmap.", "brief": null, "return": { "type": "void", @@ -33646,6 +32790,19 @@ "type_parameter": null }, "parameters": { + "destination": { + "type": "bitmap", + "description": "The destination bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "clr": { "type": "color", "description": "The color of the line", @@ -33661,7 +32818,7 @@ }, "x1": { "type": "double", - "description": "The distance from the left of the window/bitmap to the first\npoint", + "description": "The distance from the left of the bitmap/bitmap to the first\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33674,7 +32831,7 @@ }, "y1": { "type": "double", - "description": "The distance from the top of the window/bitmap to the first\npoint", + "description": "The distance from the top of the bitmap/bitmap to the first\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33687,7 +32844,7 @@ }, "x2": { "type": "double", - "description": "The distance from the left of the window/bitmap to the second\npoint", + "description": "The distance from the left of the bitmap/bitmap to the second\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33700,7 +32857,7 @@ }, "y2": { "type": "double", - "description": "The distance from the top of the window/bitmap to the second\npoint", + "description": "The distance from the top of the bitmap/bitmap to the second\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33713,29 +32870,33 @@ } }, "attributes": { - "group": "graphics" + "class": "bitmap", + "method": "draw_line", + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def draw_line(clr, x1, y1, x2, y2):" - ], "cpp": [ - "void draw_line(color clr, double x1, double y1, double x2, double y2)" + "void draw_line_on_bitmap(bitmap destination, color clr, double x1, double y1, double x2, double y2)" + ], + "python": [ + "def draw_line_on_bitmap(destination, clr, x1, y1, x2, y2):" ], "csharp": [ - "public static void SplashKit.DrawLine(Color clr, double x1, double y1, double x2, double y2);" + "public void Bitmap.DrawLine(Color clr, double x1, double y1, double x2, double y2);", + "public static void SplashKit.DrawLineOnBitmap(Bitmap destination, Color clr, double x1, double y1, double x2, double y2);" ], "pascal": [ - "procedure DrawLine(clr: Color; x1: Double; y1: Double; x2: Double; y2: Double)" + "procedure DrawLineOnBitmap(destination: Bitmap; clr: Color; x1: Double; y1: Double; x2: Double; y2: Double)" ] } }, { - "signature": "void draw_line(color clr,double x1,double y1,double x2,double y2,const drawing_options &opts);", - "name": "draw_line", - "method_name": null, - "unique_global_name": "draw_line_with_options", - "unique_method_name": null, + "signature": "void draw_line_on_bitmap(bitmap destination,color clr,double x1,double y1,double x2,double y2,const drawing_options &opts);", + "name": "draw_line_on_bitmap", + "method_name": "draw_line", + "unique_global_name": "draw_line_on_bitmap_with_options", + "unique_method_name": "bitmap.draw_line_with_options", "suffix_name": null, "description": "Draw a line from one point to another", "brief": null, @@ -33748,6 +32909,19 @@ "type_parameter": null }, "parameters": { + "destination": { + "type": "bitmap", + "description": "The destination bitmap", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "clr": { "type": "color", "description": "The color of the line", @@ -33763,7 +32937,7 @@ }, "x1": { "type": "double", - "description": "The distance from the left of the window/bitmap to the first\npoint", + "description": "The distance from the left of the bitmap/bitmap to the first\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33776,7 +32950,7 @@ }, "y1": { "type": "double", - "description": "The distance from the top of the window/bitmap to the first\npoint", + "description": "The distance from the top of the bitmap/bitmap to the first\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33789,7 +32963,7 @@ }, "x2": { "type": "double", - "description": "The distance from the left of the window/bitmap to the second\npoint", + "description": "The distance from the left of the bitmap/bitmap to the second\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33802,7 +32976,7 @@ }, "y2": { "type": "double", - "description": "The distance from the top of the window/bitmap to the second\npoint", + "description": "The distance from the top of the bitmap/bitmap to the second\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -33828,32 +33002,36 @@ } }, "attributes": { + "class": "bitmap", + "method": "draw_line", "suffix": "with_options", - "group": "graphics" + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def draw_line_with_options(clr, x1, y1, x2, y2, opts):" - ], "cpp": [ - "void draw_line(color clr, double x1, double y1, double x2, double y2, const drawing_options &opts)" + "void draw_line_on_bitmap(bitmap destination, color clr, double x1, double y1, double x2, double y2, const drawing_options &opts)" + ], + "python": [ + "def draw_line_on_bitmap_with_options(destination, clr, x1, y1, x2, y2, opts):" ], "csharp": [ - "public static void SplashKit.DrawLine(Color clr, double x1, double y1, double x2, double y2, DrawingOptions opts);" + "public void Bitmap.DrawLine(Color clr, double x1, double y1, double x2, double y2, DrawingOptions opts);", + "public static void SplashKit.DrawLineOnBitmap(Bitmap destination, Color clr, double x1, double y1, double x2, double y2, DrawingOptions opts);" ], "pascal": [ - "procedure DrawLine(clr: Color; x1: Double; y1: Double; x2: Double; y2: Double; const opts: DrawingOptions)" + "procedure DrawLineOnBitmap(destination: Bitmap; clr: Color; x1: Double; y1: Double; x2: Double; y2: Double; const opts: DrawingOptions)" ] } }, { - "signature": "void draw_line_on_bitmap(bitmap destination,color clr,const line &l);", - "name": "draw_line_on_bitmap", + "signature": "void draw_line_on_window(window destination,color clr,const line &l);", + "name": "draw_line_on_window", "method_name": "draw_line", - "unique_global_name": "draw_line_on_bitmap_record", - "unique_method_name": "bitmap.draw_line_record", + "unique_global_name": "draw_line_on_window_record", + "unique_method_name": "window.draw_line_record", "suffix_name": null, - "description": "Draws a line onto the given bitmap.", + "description": "Draws a line onto the given window.", "brief": null, "return": { "type": "void", @@ -33865,7 +33043,7 @@ }, "parameters": { "destination": { - "type": "bitmap", + "type": "window", "description": "The destination bitmap", "is_pointer": false, "is_const": false, @@ -33905,36 +33083,36 @@ } }, "attributes": { - "class": "bitmap", + "class": "window", "method": "draw_line", "suffix": "record", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_line_on_bitmap_record(destination, clr, l):" - ], "cpp": [ - "void draw_line_on_bitmap(bitmap destination, color clr, const line &l)" + "void draw_line_on_window(window destination, color clr, const line &l)" + ], + "python": [ + "def draw_line_on_window_record(destination, clr, l):" ], "csharp": [ - "public void Bitmap.DrawLine(Color clr, Line l);", - "public static void SplashKit.DrawLineOnBitmap(Bitmap destination, Color clr, Line l);" + "public void Window.DrawLine(Color clr, Line l);", + "public static void SplashKit.DrawLineOnWindow(Window destination, Color clr, Line l);" ], "pascal": [ - "procedure DrawLineOnBitmap(destination: Bitmap; clr: Color; const l: Line)" + "procedure DrawLineOnWindow(destination: Window; clr: Color; const l: Line)" ] } }, { - "signature": "void draw_line_on_bitmap(bitmap destination,color clr,const line &l,drawing_options opts);", - "name": "draw_line_on_bitmap", + "signature": "void draw_line_on_window(window destination,color clr,const line &l,drawing_options opts);", + "name": "draw_line_on_window", "method_name": "draw_line", - "unique_global_name": "draw_line_on_bitmap_record_with_options", - "unique_method_name": "bitmap.draw_line_record_with_options", + "unique_global_name": "draw_line_on_window_record_with_options", + "unique_method_name": "window.draw_line_record_with_options", "suffix_name": null, - "description": "Draws a line on the given bitmap.", + "description": "Draws a line on the given window.", "brief": null, "return": { "type": "void", @@ -33946,7 +33124,7 @@ }, "parameters": { "destination": { - "type": "bitmap", + "type": "window", "description": "The destination bitmap", "is_pointer": false, "is_const": false, @@ -33999,36 +33177,36 @@ } }, "attributes": { - "class": "bitmap", + "class": "window", "method": "draw_line", "suffix": "record_with_options", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_line_on_bitmap_record_with_options(destination, clr, l, opts):" - ], "cpp": [ - "void draw_line_on_bitmap(bitmap destination, color clr, const line &l, drawing_options opts)" + "void draw_line_on_window(window destination, color clr, const line &l, drawing_options opts)" + ], + "python": [ + "def draw_line_on_window_record_with_options(destination, clr, l, opts):" ], "csharp": [ - "public void Bitmap.DrawLine(Color clr, Line l, DrawingOptions opts);", - "public static void SplashKit.DrawLineOnBitmap(Bitmap destination, Color clr, Line l, DrawingOptions opts);" + "public void Window.DrawLine(Color clr, Line l, DrawingOptions opts);", + "public static void SplashKit.DrawLineOnWindow(Window destination, Color clr, Line l, DrawingOptions opts);" ], "pascal": [ - "procedure DrawLineOnBitmap(destination: Bitmap; clr: Color; const l: Line; opts: DrawingOptions)" + "procedure DrawLineOnWindow(destination: Window; clr: Color; const l: Line; opts: DrawingOptions)" ] } }, { - "signature": "void draw_line_on_bitmap(bitmap destination,color clr,const point_2d &from_pt,const point_2d &to_pt);", - "name": "draw_line_on_bitmap", + "signature": "void draw_line_on_window(window destination,color clr,const point_2d &from_pt,const point_2d &to_pt);", + "name": "draw_line_on_window", "method_name": "draw_line", - "unique_global_name": "draw_line_on_bitmap_point_to_point", - "unique_method_name": "bitmap.draw_line_point_to_point", + "unique_global_name": "draw_line_on_window_point_to_point", + "unique_method_name": "window.draw_line_point_to_point", "suffix_name": null, - "description": "Draw a line from one point to another on the given bitmap.", + "description": "Draw a line from one point to another on the given window.", "brief": null, "return": { "type": "void", @@ -34040,7 +33218,7 @@ }, "parameters": { "destination": { - "type": "bitmap", + "type": "window", "description": "The destination bitmap", "is_pointer": false, "is_const": false, @@ -34093,36 +33271,36 @@ } }, "attributes": { - "class": "bitmap", + "class": "window", "method": "draw_line", "suffix": "point_to_point", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_line_on_bitmap_point_to_point(destination, clr, from_pt, to_pt):" - ], "cpp": [ - "void draw_line_on_bitmap(bitmap destination, color clr, const point_2d &from_pt, const point_2d &to_pt)" + "void draw_line_on_window(window destination, color clr, const point_2d &from_pt, const point_2d &to_pt)" + ], + "python": [ + "def draw_line_on_window_point_to_point(destination, clr, from_pt, to_pt):" ], "csharp": [ - "public void Bitmap.DrawLine(Color clr, Point2D fromPt, Point2D toPt);", - "public static void SplashKit.DrawLineOnBitmap(Bitmap destination, Color clr, Point2D fromPt, Point2D toPt);" + "public void Window.DrawLine(Color clr, Point2D fromPt, Point2D toPt);", + "public static void SplashKit.DrawLineOnWindow(Window destination, Color clr, Point2D fromPt, Point2D toPt);" ], "pascal": [ - "procedure DrawLineOnBitmap(destination: Bitmap; clr: Color; const fromPt: Point2D; const toPt: Point2D)" + "procedure DrawLineOnWindow(destination: Window; clr: Color; const fromPt: Point2D; const toPt: Point2D)" ] } }, { - "signature": "void draw_line_on_bitmap(bitmap destination,color clr,const point_2d &from_pt,const point_2d &to_pt,const drawing_options &opts);", - "name": "draw_line_on_bitmap", + "signature": "void draw_line_on_window(window destination,color clr,const point_2d &from_pt,const point_2d &to_pt,const drawing_options &opts);", + "name": "draw_line_on_window", "method_name": "draw_line", - "unique_global_name": "draw_line_on_bitmap_point_to_point_with_options", - "unique_method_name": "bitmap.draw_line_point_to_point_with_options", + "unique_global_name": "draw_line_on_window_point_to_point_with_options", + "unique_method_name": "window.draw_line_point_to_point_with_options", "suffix_name": null, - "description": "Draw a line from one point to another on the given bitmap.", + "description": "Draw a line from one point to another on the given window.", "brief": null, "return": { "type": "void", @@ -34134,7 +33312,7 @@ }, "parameters": { "destination": { - "type": "bitmap", + "type": "window", "description": "The destination bitmap", "is_pointer": false, "is_const": false, @@ -34200,36 +33378,36 @@ } }, "attributes": { - "class": "bitmap", + "class": "window", "method": "draw_line", "suffix": "point_to_point_with_options", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_line_on_bitmap_point_to_point_with_options(destination, clr, from_pt, to_pt, opts):" - ], "cpp": [ - "void draw_line_on_bitmap(bitmap destination, color clr, const point_2d &from_pt, const point_2d &to_pt, const drawing_options &opts)" + "void draw_line_on_window(window destination, color clr, const point_2d &from_pt, const point_2d &to_pt, const drawing_options &opts)" + ], + "python": [ + "def draw_line_on_window_point_to_point_with_options(destination, clr, from_pt, to_pt, opts):" ], "csharp": [ - "public void Bitmap.DrawLine(Color clr, Point2D fromPt, Point2D toPt, DrawingOptions opts);", - "public static void SplashKit.DrawLineOnBitmap(Bitmap destination, Color clr, Point2D fromPt, Point2D toPt, DrawingOptions opts);" + "public void Window.DrawLine(Color clr, Point2D fromPt, Point2D toPt, DrawingOptions opts);", + "public static void SplashKit.DrawLineOnWindow(Window destination, Color clr, Point2D fromPt, Point2D toPt, DrawingOptions opts);" ], "pascal": [ - "procedure DrawLineOnBitmap(destination: Bitmap; clr: Color; const fromPt: Point2D; const toPt: Point2D; const opts: DrawingOptions)" + "procedure DrawLineOnWindow(destination: Window; clr: Color; const fromPt: Point2D; const toPt: Point2D; const opts: DrawingOptions)" ] } }, { - "signature": "void draw_line_on_bitmap(bitmap destination,color clr,double x1,double y1,double x2,double y2);", - "name": "draw_line_on_bitmap", + "signature": "void draw_line_on_window(window destination,color clr,double x1,double y1,double x2,double y2);", + "name": "draw_line_on_window", "method_name": "draw_line", - "unique_global_name": "draw_line_on_bitmap", - "unique_method_name": "bitmap.draw_line", + "unique_global_name": "draw_line_on_window", + "unique_method_name": "window.draw_line", "suffix_name": null, - "description": "Draw a line from one point to another on the given bitmap.", + "description": "Draw a line from one point to another on the given window.", "brief": null, "return": { "type": "void", @@ -34241,7 +33419,7 @@ }, "parameters": { "destination": { - "type": "bitmap", + "type": "window", "description": "The destination bitmap", "is_pointer": false, "is_const": false, @@ -34268,7 +33446,7 @@ }, "x1": { "type": "double", - "description": "The distance from the left of the bitmap/bitmap to the first\npoint", + "description": "The distance from the left of the window/bitmap to the first\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34281,7 +33459,7 @@ }, "y1": { "type": "double", - "description": "The distance from the top of the bitmap/bitmap to the first\npoint", + "description": "The distance from the top of the window/bitmap to the first\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34294,7 +33472,7 @@ }, "x2": { "type": "double", - "description": "The distance from the left of the bitmap/bitmap to the second\npoint", + "description": "The distance from the left of the window/bitmap to the second\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34307,7 +33485,7 @@ }, "y2": { "type": "double", - "description": "The distance from the top of the bitmap/bitmap to the second\npoint", + "description": "The distance from the top of the window/bitmap to the second\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34320,33 +33498,33 @@ } }, "attributes": { - "class": "bitmap", + "class": "window", "method": "draw_line", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_line_on_bitmap(destination, clr, x1, y1, x2, y2):" - ], "cpp": [ - "void draw_line_on_bitmap(bitmap destination, color clr, double x1, double y1, double x2, double y2)" + "void draw_line_on_window(window destination, color clr, double x1, double y1, double x2, double y2)" + ], + "python": [ + "def draw_line_on_window(destination, clr, x1, y1, x2, y2):" ], "csharp": [ - "public void Bitmap.DrawLine(Color clr, double x1, double y1, double x2, double y2);", - "public static void SplashKit.DrawLineOnBitmap(Bitmap destination, Color clr, double x1, double y1, double x2, double y2);" + "public void Window.DrawLine(Color clr, double x1, double y1, double x2, double y2);", + "public static void SplashKit.DrawLineOnWindow(Window destination, Color clr, double x1, double y1, double x2, double y2);" ], "pascal": [ - "procedure DrawLineOnBitmap(destination: Bitmap; clr: Color; x1: Double; y1: Double; x2: Double; y2: Double)" + "procedure DrawLineOnWindow(destination: Window; clr: Color; x1: Double; y1: Double; x2: Double; y2: Double)" ] } }, { - "signature": "void draw_line_on_bitmap(bitmap destination,color clr,double x1,double y1,double x2,double y2,const drawing_options &opts);", - "name": "draw_line_on_bitmap", + "signature": "void draw_line_on_window(window destination,color clr,double x1,double y1,double x2,double y2,const drawing_options &opts);", + "name": "draw_line_on_window", "method_name": "draw_line", - "unique_global_name": "draw_line_on_bitmap_with_options", - "unique_method_name": "bitmap.draw_line_with_options", + "unique_global_name": "draw_line_on_window_with_options", + "unique_method_name": "window.draw_line_with_options", "suffix_name": null, "description": "Draw a line from one point to another", "brief": null, @@ -34360,7 +33538,7 @@ }, "parameters": { "destination": { - "type": "bitmap", + "type": "window", "description": "The destination bitmap", "is_pointer": false, "is_const": false, @@ -34387,7 +33565,7 @@ }, "x1": { "type": "double", - "description": "The distance from the left of the bitmap/bitmap to the first\npoint", + "description": "The distance from the left of the window/bitmap to the first\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34400,7 +33578,7 @@ }, "y1": { "type": "double", - "description": "The distance from the top of the bitmap/bitmap to the first\npoint", + "description": "The distance from the top of the window/bitmap to the first\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34413,7 +33591,7 @@ }, "x2": { "type": "double", - "description": "The distance from the left of the bitmap/bitmap to the second\npoint", + "description": "The distance from the left of the window/bitmap to the second\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34426,7 +33604,7 @@ }, "y2": { "type": "double", - "description": "The distance from the top of the bitmap/bitmap to the second\npoint", + "description": "The distance from the top of the window/bitmap to the second\npoint", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34452,36 +33630,36 @@ } }, "attributes": { - "class": "bitmap", + "class": "window", "method": "draw_line", "suffix": "with_options", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_line_on_bitmap_with_options(destination, clr, x1, y1, x2, y2, opts):" - ], "cpp": [ - "void draw_line_on_bitmap(bitmap destination, color clr, double x1, double y1, double x2, double y2, const drawing_options &opts)" + "void draw_line_on_window(window destination, color clr, double x1, double y1, double x2, double y2, const drawing_options &opts)" + ], + "python": [ + "def draw_line_on_window_with_options(destination, clr, x1, y1, x2, y2, opts):" ], "csharp": [ - "public void Bitmap.DrawLine(Color clr, double x1, double y1, double x2, double y2, DrawingOptions opts);", - "public static void SplashKit.DrawLineOnBitmap(Bitmap destination, Color clr, double x1, double y1, double x2, double y2, DrawingOptions opts);" + "public void Window.DrawLine(Color clr, double x1, double y1, double x2, double y2, DrawingOptions opts);", + "public static void SplashKit.DrawLineOnWindow(Window destination, Color clr, double x1, double y1, double x2, double y2, DrawingOptions opts);" ], "pascal": [ - "procedure DrawLineOnBitmap(destination: Bitmap; clr: Color; x1: Double; y1: Double; x2: Double; y2: Double; const opts: DrawingOptions)" + "procedure DrawLineOnWindow(destination: Window; clr: Color; x1: Double; y1: Double; x2: Double; y2: Double; const opts: DrawingOptions)" ] } }, { - "signature": "void draw_line_on_window(window destination,color clr,const line &l);", - "name": "draw_line_on_window", - "method_name": "draw_line", - "unique_global_name": "draw_line_on_window_record", - "unique_method_name": "window.draw_line_record", + "signature": "void draw_pixel(color clr,const point_2d &pt);", + "name": "draw_pixel", + "method_name": null, + "unique_global_name": "draw_pixel_at_point", + "unique_method_name": null, "suffix_name": null, - "description": "Draws a line onto the given window.", + "description": "Draws an individual pixel to the current window.", "brief": null, "return": { "type": "void", @@ -34492,22 +33670,9 @@ "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "The destination bitmap", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, "clr": { "type": "color", - "description": "The color of the line", + "description": "The color of the pixel", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34518,9 +33683,9 @@ "is_vector": false, "type_parameter": null }, - "l": { - "type": "line", - "description": "The line's details", + "pt": { + "type": "point_2d", + "description": "The location of the pixel to draw", "is_pointer": false, "is_const": true, "is_reference": true, @@ -34533,36 +33698,32 @@ } }, "attributes": { - "class": "window", - "method": "draw_line", - "suffix": "record", - "group": "graphics", - "self": "destination" + "suffix": "at_point", + "group": "graphics" }, "signatures": { - "python": [ - "def draw_line_on_window_record(destination, clr, l):" - ], "cpp": [ - "void draw_line_on_window(window destination, color clr, const line &l)" + "void draw_pixel(color clr, const point_2d &pt)" + ], + "python": [ + "def draw_pixel_at_point(clr, pt):" ], "csharp": [ - "public void Window.DrawLine(Color clr, Line l);", - "public static void SplashKit.DrawLineOnWindow(Window destination, Color clr, Line l);" + "public static void SplashKit.DrawPixel(Color clr, Point2D pt);" ], "pascal": [ - "procedure DrawLineOnWindow(destination: Window; clr: Color; const l: Line)" + "procedure DrawPixel(clr: Color; const pt: Point2D)" ] } }, { - "signature": "void draw_line_on_window(window destination,color clr,const line &l,drawing_options opts);", - "name": "draw_line_on_window", - "method_name": "draw_line", - "unique_global_name": "draw_line_on_window_record_with_options", - "unique_method_name": "window.draw_line_record_with_options", + "signature": "void draw_pixel(color clr,const point_2d &pt,drawing_options opts);", + "name": "draw_pixel", + "method_name": null, + "unique_global_name": "draw_pixel_at_point_with_options", + "unique_method_name": null, "suffix_name": null, - "description": "Draws a line on the given window.", + "description": "Draws an individual pixel with the supplied options.", "brief": null, "return": { "type": "void", @@ -34573,22 +33734,9 @@ "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "The destination bitmap", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, "clr": { "type": "color", - "description": "The color of the line", + "description": "The color of the pixel", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34599,9 +33747,9 @@ "is_vector": false, "type_parameter": null }, - "l": { - "type": "line", - "description": "The line's details", + "pt": { + "type": "point_2d", + "description": "The location of the pixel to draw", "is_pointer": false, "is_const": true, "is_reference": true, @@ -34627,36 +33775,32 @@ } }, "attributes": { - "class": "window", - "method": "draw_line", - "suffix": "record_with_options", - "group": "graphics", - "self": "destination" + "suffix": "at_point_with_options", + "group": "graphics" }, "signatures": { - "python": [ - "def draw_line_on_window_record_with_options(destination, clr, l, opts):" - ], "cpp": [ - "void draw_line_on_window(window destination, color clr, const line &l, drawing_options opts)" + "void draw_pixel(color clr, const point_2d &pt, drawing_options opts)" + ], + "python": [ + "def draw_pixel_at_point_with_options(clr, pt, opts):" ], "csharp": [ - "public void Window.DrawLine(Color clr, Line l, DrawingOptions opts);", - "public static void SplashKit.DrawLineOnWindow(Window destination, Color clr, Line l, DrawingOptions opts);" + "public static void SplashKit.DrawPixel(Color clr, Point2D pt, DrawingOptions opts);" ], "pascal": [ - "procedure DrawLineOnWindow(destination: Window; clr: Color; const l: Line; opts: DrawingOptions)" + "procedure DrawPixel(clr: Color; const pt: Point2D; opts: DrawingOptions)" ] } }, { - "signature": "void draw_line_on_window(window destination,color clr,const point_2d &from_pt,const point_2d &to_pt);", - "name": "draw_line_on_window", - "method_name": "draw_line", - "unique_global_name": "draw_line_on_window_point_to_point", - "unique_method_name": "window.draw_line_point_to_point", + "signature": "void draw_pixel(color clr,double x,double y);", + "name": "draw_pixel", + "method_name": null, + "unique_global_name": "draw_pixel", + "unique_method_name": null, "suffix_name": null, - "description": "Draw a line from one point to another on the given window.", + "description": "Draws an individual pixel to the current window.", "brief": null, "return": { "type": "void", @@ -34667,22 +33811,9 @@ "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "The destination bitmap", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, "clr": { "type": "color", - "description": "The color of the line", + "description": "The color of the pixel", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34693,12 +33824,12 @@ "is_vector": false, "type_parameter": null }, - "from_pt": { - "type": "point_2d", - "description": "The start of the line", + "x": { + "type": "double", + "description": "The distance from the left edge of the window to the\npixel", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -34706,12 +33837,12 @@ "is_vector": false, "type_parameter": null }, - "to_pt": { - "type": "point_2d", - "description": "The end of the line", + "y": { + "type": "double", + "description": "The distance from the top edge of the window to the\npixel", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -34721,36 +33852,31 @@ } }, "attributes": { - "class": "window", - "method": "draw_line", - "suffix": "point_to_point", - "group": "graphics", - "self": "destination" + "group": "graphics" }, "signatures": { - "python": [ - "def draw_line_on_window_point_to_point(destination, clr, from_pt, to_pt):" - ], "cpp": [ - "void draw_line_on_window(window destination, color clr, const point_2d &from_pt, const point_2d &to_pt)" + "void draw_pixel(color clr, double x, double y)" + ], + "python": [ + "def draw_pixel(clr, x, y):" ], "csharp": [ - "public void Window.DrawLine(Color clr, Point2D fromPt, Point2D toPt);", - "public static void SplashKit.DrawLineOnWindow(Window destination, Color clr, Point2D fromPt, Point2D toPt);" + "public static void SplashKit.DrawPixel(Color clr, double x, double y);" ], "pascal": [ - "procedure DrawLineOnWindow(destination: Window; clr: Color; const fromPt: Point2D; const toPt: Point2D)" + "procedure DrawPixel(clr: Color; x: Double; y: Double)" ] } }, { - "signature": "void draw_line_on_window(window destination,color clr,const point_2d &from_pt,const point_2d &to_pt,const drawing_options &opts);", - "name": "draw_line_on_window", - "method_name": "draw_line", - "unique_global_name": "draw_line_on_window_point_to_point_with_options", - "unique_method_name": "window.draw_line_point_to_point_with_options", + "signature": "void draw_pixel(color clr,double x,double y,drawing_options opts);", + "name": "draw_pixel", + "method_name": null, + "unique_global_name": "draw_pixel_with_options", + "unique_method_name": null, "suffix_name": null, - "description": "Draw a line from one point to another on the given window.", + "description": "Draws an individual pixel with the supplied options.", "brief": null, "return": { "type": "void", @@ -34761,22 +33887,9 @@ "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "The destination bitmap", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, "clr": { "type": "color", - "description": "The color of the line", + "description": "The color of the pixel", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34787,12 +33900,12 @@ "is_vector": false, "type_parameter": null }, - "from_pt": { - "type": "point_2d", - "description": "The start of the line", + "x": { + "type": "double", + "description": "The distance from the left edge of the window/bitmap to the\npixel", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -34800,12 +33913,12 @@ "is_vector": false, "type_parameter": null }, - "to_pt": { - "type": "point_2d", - "description": "The end of the line", + "y": { + "type": "double", + "description": "The distance from the top edge of the window/bitmap to the\npixel", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -34817,8 +33930,8 @@ "type": "drawing_options", "description": "The drawing options", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -34828,36 +33941,32 @@ } }, "attributes": { - "class": "window", - "method": "draw_line", - "suffix": "point_to_point_with_options", - "group": "graphics", - "self": "destination" + "suffix": "with_options", + "group": "graphics" }, "signatures": { - "python": [ - "def draw_line_on_window_point_to_point_with_options(destination, clr, from_pt, to_pt, opts):" - ], "cpp": [ - "void draw_line_on_window(window destination, color clr, const point_2d &from_pt, const point_2d &to_pt, const drawing_options &opts)" + "void draw_pixel(color clr, double x, double y, drawing_options opts)" + ], + "python": [ + "def draw_pixel_with_options(clr, x, y, opts):" ], "csharp": [ - "public void Window.DrawLine(Color clr, Point2D fromPt, Point2D toPt, DrawingOptions opts);", - "public static void SplashKit.DrawLineOnWindow(Window destination, Color clr, Point2D fromPt, Point2D toPt, DrawingOptions opts);" + "public static void SplashKit.DrawPixel(Color clr, double x, double y, DrawingOptions opts);" ], "pascal": [ - "procedure DrawLineOnWindow(destination: Window; clr: Color; const fromPt: Point2D; const toPt: Point2D; const opts: DrawingOptions)" + "procedure DrawPixel(clr: Color; x: Double; y: Double; opts: DrawingOptions)" ] } }, { - "signature": "void draw_line_on_window(window destination,color clr,double x1,double y1,double x2,double y2);", - "name": "draw_line_on_window", - "method_name": "draw_line", - "unique_global_name": "draw_line_on_window", - "unique_method_name": "window.draw_line", + "signature": "void draw_pixel_on_bitmap(bitmap destination,color clr,const point_2d &pt);", + "name": "draw_pixel_on_bitmap", + "method_name": "draw_pixel", + "unique_global_name": "draw_pixel_on_bitmap_at_point", + "unique_method_name": "bitmap.draw_pixel_at_point", "suffix_name": null, - "description": "Draw a line from one point to another on the given window.", + "description": "Draws an individual pixel to the given bitmap.", "brief": null, "return": { "type": "void", @@ -34869,8 +33978,8 @@ }, "parameters": { "destination": { - "type": "window", - "description": "The destination bitmap", + "type": "bitmap", + "description": "the bitmap to draw the pixel on", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34883,7 +33992,7 @@ }, "clr": { "type": "color", - "description": "The color of the line", + "description": "The color of the pixel", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34894,9 +34003,64 @@ "is_vector": false, "type_parameter": null }, - "x1": { - "type": "double", - "description": "The distance from the left of the window/bitmap to the first\npoint", + "pt": { + "type": "point_2d", + "description": "The location of the pixel to draw", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } + }, + "attributes": { + "class": "bitmap", + "method": "draw_pixel", + "suffix": "at_point", + "group": "graphics", + "self": "destination" + }, + "signatures": { + "cpp": [ + "void draw_pixel_on_bitmap(bitmap destination, color clr, const point_2d &pt)" + ], + "python": [ + "def draw_pixel_on_bitmap_at_point(destination, clr, pt):" + ], + "csharp": [ + "public void Bitmap.DrawPixel(Color clr, Point2D pt);", + "public static void SplashKit.DrawPixelOnBitmap(Bitmap destination, Color clr, Point2D pt);" + ], + "pascal": [ + "procedure DrawPixelOnBitmap(destination: Bitmap; clr: Color; const pt: Point2D)" + ] + } + }, + { + "signature": "void draw_pixel_on_bitmap(bitmap destination,color clr,const point_2d &pt,drawing_options opts);", + "name": "draw_pixel_on_bitmap", + "method_name": "draw_pixel", + "unique_global_name": "draw_pixel_on_bitmap_at_point_with_options", + "unique_method_name": "bitmap.draw_pixel_at_point_with_options", + "suffix_name": null, + "description": "Draws an individual pixel to the given bitmap with the given drawing options.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "destination": { + "type": "bitmap", + "description": "the bitmap to draw the pixel on", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34907,9 +34071,9 @@ "is_vector": false, "type_parameter": null }, - "y1": { - "type": "double", - "description": "The distance from the top of the window/bitmap to the first\npoint", + "clr": { + "type": "color", + "description": "The color of the pixel", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34920,12 +34084,12 @@ "is_vector": false, "type_parameter": null }, - "x2": { - "type": "double", - "description": "The distance from the left of the window/bitmap to the second\npoint", + "pt": { + "type": "point_2d", + "description": "The location of the pixel to draw", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -34933,9 +34097,9 @@ "is_vector": false, "type_parameter": null }, - "y2": { - "type": "double", - "description": "The distance from the top of the window/bitmap to the second\npoint", + "opts": { + "type": "drawing_options", + "description": "The drawing options", "is_pointer": false, "is_const": false, "is_reference": false, @@ -34948,35 +34112,36 @@ } }, "attributes": { - "class": "window", - "method": "draw_line", + "class": "bitmap", + "method": "draw_pixel", + "suffix": "at_point_with_options", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_line_on_window(destination, clr, x1, y1, x2, y2):" - ], "cpp": [ - "void draw_line_on_window(window destination, color clr, double x1, double y1, double x2, double y2)" + "void draw_pixel_on_bitmap(bitmap destination, color clr, const point_2d &pt, drawing_options opts)" + ], + "python": [ + "def draw_pixel_on_bitmap_at_point_with_options(destination, clr, pt, opts):" ], "csharp": [ - "public void Window.DrawLine(Color clr, double x1, double y1, double x2, double y2);", - "public static void SplashKit.DrawLineOnWindow(Window destination, Color clr, double x1, double y1, double x2, double y2);" + "public void Bitmap.DrawPixel(Color clr, Point2D pt, DrawingOptions opts);", + "public static void SplashKit.DrawPixelOnBitmap(Bitmap destination, Color clr, Point2D pt, DrawingOptions opts);" ], "pascal": [ - "procedure DrawLineOnWindow(destination: Window; clr: Color; x1: Double; y1: Double; x2: Double; y2: Double)" + "procedure DrawPixelOnBitmap(destination: Bitmap; clr: Color; const pt: Point2D; opts: DrawingOptions)" ] } }, { - "signature": "void draw_line_on_window(window destination,color clr,double x1,double y1,double x2,double y2,const drawing_options &opts);", - "name": "draw_line_on_window", - "method_name": "draw_line", - "unique_global_name": "draw_line_on_window_with_options", - "unique_method_name": "window.draw_line_with_options", + "signature": "void draw_pixel_on_bitmap(bitmap destination,color clr,double x,double y);", + "name": "draw_pixel_on_bitmap", + "method_name": "draw_pixel", + "unique_global_name": "draw_pixel_on_bitmap", + "unique_method_name": "bitmap.draw_pixel", "suffix_name": null, - "description": "Draw a line from one point to another", + "description": "Draws an individual pixel to the given bitmap.", "brief": null, "return": { "type": "void", @@ -34988,8 +34153,8 @@ }, "parameters": { "destination": { - "type": "window", - "description": "The destination bitmap", + "type": "bitmap", + "description": "the bitmap to draw the pixel on", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35002,33 +34167,7 @@ }, "clr": { "type": "color", - "description": "The color of the line", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x1": { - "type": "double", - "description": "The distance from the left of the window/bitmap to the first\npoint", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y1": { - "type": "double", - "description": "The distance from the top of the window/bitmap to the first\npoint", + "description": "The color of the pixel", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35039,9 +34178,9 @@ "is_vector": false, "type_parameter": null }, - "x2": { + "x": { "type": "double", - "description": "The distance from the left of the window/bitmap to the second\npoint", + "description": "The distance from the left edge of the bitmap to the\npixel", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35052,205 +34191,50 @@ "is_vector": false, "type_parameter": null }, - "y2": { + "y": { "type": "double", - "description": "The distance from the top of the window/bitmap to the second\npoint", + "description": "The distance from the top edge of the bitmap to the\npixel", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "The drawing options", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "window", - "method": "draw_line", - "suffix": "with_options", + "class": "bitmap", + "method": "draw_pixel", "group": "graphics", "self": "destination" }, "signatures": { - "python": [ - "def draw_line_on_window_with_options(destination, clr, x1, y1, x2, y2, opts):" - ], - "cpp": [ - "void draw_line_on_window(window destination, color clr, double x1, double y1, double x2, double y2, const drawing_options &opts)" - ], - "csharp": [ - "public void Window.DrawLine(Color clr, double x1, double y1, double x2, double y2, DrawingOptions opts);", - "public static void SplashKit.DrawLineOnWindow(Window destination, Color clr, double x1, double y1, double x2, double y2, DrawingOptions opts);" - ], - "pascal": [ - "procedure DrawLineOnWindow(destination: Window; clr: Color; x1: Double; y1: Double; x2: Double; y2: Double; const opts: DrawingOptions)" - ] - } - }, - { - "signature": "void draw_pixel(color clr,const point_2d &pt);", - "name": "draw_pixel", - "method_name": null, - "unique_global_name": "draw_pixel_at_point", - "unique_method_name": null, - "suffix_name": null, - "description": "Draws an individual pixel to the current window.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "clr": { - "type": "color", - "description": "The color of the pixel", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "pt": { - "type": "point_2d", - "description": "The location of the pixel to draw", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "at_point", - "group": "graphics" - }, - "signatures": { - "python": [ - "def draw_pixel_at_point(clr, pt):" - ], "cpp": [ - "void draw_pixel(color clr, const point_2d &pt)" - ], - "csharp": [ - "public static void SplashKit.DrawPixel(Color clr, Point2D pt);" + "void draw_pixel_on_bitmap(bitmap destination, color clr, double x, double y)" ], - "pascal": [ - "procedure DrawPixel(clr: Color; const pt: Point2D)" - ] - } - }, - { - "signature": "void draw_pixel(color clr,const point_2d &pt,drawing_options opts);", - "name": "draw_pixel", - "method_name": null, - "unique_global_name": "draw_pixel_at_point_with_options", - "unique_method_name": null, - "suffix_name": null, - "description": "Draws an individual pixel with the supplied options.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "clr": { - "type": "color", - "description": "The color of the pixel", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "pt": { - "type": "point_2d", - "description": "The location of the pixel to draw", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "The drawing options", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "at_point_with_options", - "group": "graphics" - }, - "signatures": { "python": [ - "def draw_pixel_at_point_with_options(clr, pt, opts):" - ], - "cpp": [ - "void draw_pixel(color clr, const point_2d &pt, drawing_options opts)" + "def draw_pixel_on_bitmap(destination, clr, x, y):" ], "csharp": [ - "public static void SplashKit.DrawPixel(Color clr, Point2D pt, DrawingOptions opts);" + "public void Bitmap.DrawPixel(Color clr, double x, double y);", + "public static void SplashKit.DrawPixelOnBitmap(Bitmap destination, Color clr, double x, double y);" ], "pascal": [ - "procedure DrawPixel(clr: Color; const pt: Point2D; opts: DrawingOptions)" + "procedure DrawPixelOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double)" ] } }, { - "signature": "void draw_pixel(color clr,double x,double y);", - "name": "draw_pixel", - "method_name": null, - "unique_global_name": "draw_pixel", - "unique_method_name": null, + "signature": "void draw_pixel_on_bitmap(bitmap destination,color clr,double x,double y,drawing_options opts);", + "name": "draw_pixel_on_bitmap", + "method_name": "draw_pixel", + "unique_global_name": "draw_pixel_on_bitmap_with_options", + "unique_method_name": "bitmap.draw_pixel_with_options", "suffix_name": null, - "description": "Draws an individual pixel to the current window.", + "description": "Draws an individual pixel to the given bitmap with the given drawing options.", "brief": null, "return": { "type": "void", @@ -35261,22 +34245,9 @@ "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color of the pixel", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The distance from the left edge of the window to the\npixel", + "destination": { + "type": "bitmap", + "description": "the bitmap to draw the pixel on", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35287,56 +34258,6 @@ "is_vector": false, "type_parameter": null }, - "y": { - "type": "double", - "description": "The distance from the top edge of the window to the\npixel", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "graphics" - }, - "signatures": { - "python": [ - "def draw_pixel(clr, x, y):" - ], - "cpp": [ - "void draw_pixel(color clr, double x, double y)" - ], - "csharp": [ - "public static void SplashKit.DrawPixel(Color clr, double x, double y);" - ], - "pascal": [ - "procedure DrawPixel(clr: Color; x: Double; y: Double)" - ] - } - }, - { - "signature": "void draw_pixel(color clr,double x,double y,drawing_options opts);", - "name": "draw_pixel", - "method_name": null, - "unique_global_name": "draw_pixel_with_options", - "unique_method_name": null, - "suffix_name": null, - "description": "Draws an individual pixel with the supplied options.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { "clr": { "type": "color", "description": "The color of the pixel", @@ -35352,7 +34273,7 @@ }, "x": { "type": "double", - "description": "The distance from the left edge of the window/bitmap to the\npixel", + "description": "The distance from the left edge of the bitmap to the\npixel", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35365,7 +34286,7 @@ }, "y": { "type": "double", - "description": "The distance from the top edge of the window/bitmap to the\npixel", + "description": "The distance from the top edge of the bitmap to the\npixel", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35391,32 +34312,36 @@ } }, "attributes": { + "class": "bitmap", + "method": "draw_pixel", "suffix": "with_options", - "group": "graphics" + "group": "graphics", + "self": "destination" }, "signatures": { - "python": [ - "def draw_pixel_with_options(clr, x, y, opts):" - ], "cpp": [ - "void draw_pixel(color clr, double x, double y, drawing_options opts)" + "void draw_pixel_on_bitmap(bitmap destination, color clr, double x, double y, drawing_options opts)" + ], + "python": [ + "def draw_pixel_on_bitmap_with_options(destination, clr, x, y, opts):" ], "csharp": [ - "public static void SplashKit.DrawPixel(Color clr, double x, double y, DrawingOptions opts);" + "public void Bitmap.DrawPixel(Color clr, double x, double y, DrawingOptions opts);", + "public static void SplashKit.DrawPixelOnBitmap(Bitmap destination, Color clr, double x, double y, DrawingOptions opts);" ], "pascal": [ - "procedure DrawPixel(clr: Color; x: Double; y: Double; opts: DrawingOptions)" + "procedure DrawPixelOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; opts: DrawingOptions)" ] } }, { - "signature": "void draw_pixel_on_bitmap(bitmap destination,color clr,const point_2d &pt);", - "name": "draw_pixel_on_bitmap", - "method_name": "draw_pixel", - "unique_global_name": "draw_pixel_on_bitmap_at_point", - "unique_method_name": "bitmap.draw_pixel_at_point", + "signature": "void draw_pixel_on_window(window destination,color clr,const point_2d &pt);", + "name": "draw_pixel_on_window", + "method_name": null, + "unique_global_name": "draw_pixel_on_window_at_point", + "unique_method_name": null, "suffix_name": null, - "description": "Draws an individual pixel to the given bitmap.", + "description": "Draws an individual pixel to the given window.", "brief": null, "return": { "type": "void", @@ -35428,8 +34353,8 @@ }, "parameters": { "destination": { - "type": "bitmap", - "description": "the bitmap to draw the pixel on", + "type": "window", + "description": "The window to draw the pixel on", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35468,36 +34393,33 @@ } }, "attributes": { - "class": "bitmap", - "method": "draw_pixel", + "class": "window", "suffix": "at_point", - "group": "graphics", - "self": "destination" + "group": "graphics" }, "signatures": { - "python": [ - "def draw_pixel_on_bitmap_at_point(destination, clr, pt):" - ], "cpp": [ - "void draw_pixel_on_bitmap(bitmap destination, color clr, const point_2d &pt)" + "void draw_pixel_on_window(window destination, color clr, const point_2d &pt)" + ], + "python": [ + "def draw_pixel_on_window_at_point(destination, clr, pt):" ], "csharp": [ - "public void Bitmap.DrawPixel(Color clr, Point2D pt);", - "public static void SplashKit.DrawPixelOnBitmap(Bitmap destination, Color clr, Point2D pt);" + "public static void SplashKit.DrawPixelOnWindow(Window destination, Color clr, Point2D pt);" ], "pascal": [ - "procedure DrawPixelOnBitmap(destination: Bitmap; clr: Color; const pt: Point2D)" + "procedure DrawPixelOnWindow(destination: Window; clr: Color; const pt: Point2D)" ] } }, { - "signature": "void draw_pixel_on_bitmap(bitmap destination,color clr,const point_2d &pt,drawing_options opts);", - "name": "draw_pixel_on_bitmap", - "method_name": "draw_pixel", - "unique_global_name": "draw_pixel_on_bitmap_at_point_with_options", - "unique_method_name": "bitmap.draw_pixel_at_point_with_options", + "signature": "void draw_pixel_on_window(window destination,color clr,const point_2d &pt,drawing_options opts);", + "name": "draw_pixel_on_window", + "method_name": null, + "unique_global_name": "draw_pixel_on_window_at_point_with_options", + "unique_method_name": null, "suffix_name": null, - "description": "Draws an individual pixel to the given bitmap with the given drawing options.", + "description": "Draws an individual pixel to the given window with the given drawing options.", "brief": null, "return": { "type": "void", @@ -35509,8 +34431,8 @@ }, "parameters": { "destination": { - "type": "bitmap", - "description": "the bitmap to draw the pixel on", + "type": "window", + "description": "The window to draw the pixel on", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35562,36 +34484,33 @@ } }, "attributes": { - "class": "bitmap", - "method": "draw_pixel", + "class": "window", "suffix": "at_point_with_options", - "group": "graphics", - "self": "destination" + "group": "graphics" }, "signatures": { - "python": [ - "def draw_pixel_on_bitmap_at_point_with_options(destination, clr, pt, opts):" - ], "cpp": [ - "void draw_pixel_on_bitmap(bitmap destination, color clr, const point_2d &pt, drawing_options opts)" + "void draw_pixel_on_window(window destination, color clr, const point_2d &pt, drawing_options opts)" + ], + "python": [ + "def draw_pixel_on_window_at_point_with_options(destination, clr, pt, opts):" ], "csharp": [ - "public void Bitmap.DrawPixel(Color clr, Point2D pt, DrawingOptions opts);", - "public static void SplashKit.DrawPixelOnBitmap(Bitmap destination, Color clr, Point2D pt, DrawingOptions opts);" + "public static void SplashKit.DrawPixelOnWindow(Window destination, Color clr, Point2D pt, DrawingOptions opts);" ], "pascal": [ - "procedure DrawPixelOnBitmap(destination: Bitmap; clr: Color; const pt: Point2D; opts: DrawingOptions)" + "procedure DrawPixelOnWindow(destination: Window; clr: Color; const pt: Point2D; opts: DrawingOptions)" ] } }, { - "signature": "void draw_pixel_on_bitmap(bitmap destination,color clr,double x,double y);", - "name": "draw_pixel_on_bitmap", - "method_name": "draw_pixel", - "unique_global_name": "draw_pixel_on_bitmap", - "unique_method_name": "bitmap.draw_pixel", + "signature": "void draw_pixel_on_window(window destination,color clr,double x,double y);", + "name": "draw_pixel_on_window", + "method_name": null, + "unique_global_name": "draw_pixel_on_window", + "unique_method_name": null, "suffix_name": null, - "description": "Draws an individual pixel to the given bitmap.", + "description": "Draws an individual pixel to the given window.", "brief": null, "return": { "type": "void", @@ -35603,8 +34522,8 @@ }, "parameters": { "destination": { - "type": "bitmap", - "description": "the bitmap to draw the pixel on", + "type": "window", + "description": "the window to draw the pixel on", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35630,7 +34549,7 @@ }, "x": { "type": "double", - "description": "The distance from the left edge of the bitmap to the\npixel", + "description": "The distance from the left edge of the window to the\npixel", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35643,7 +34562,7 @@ }, "y": { "type": "double", - "description": "The distance from the top edge of the bitmap to the\npixel", + "description": "The distance from the top edge of the window to the\npixel", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35656,35 +34575,32 @@ } }, "attributes": { - "class": "bitmap", - "method": "draw_pixel", - "group": "graphics", - "self": "destination" + "class": "window", + "group": "graphics" }, "signatures": { - "python": [ - "def draw_pixel_on_bitmap(destination, clr, x, y):" - ], "cpp": [ - "void draw_pixel_on_bitmap(bitmap destination, color clr, double x, double y)" + "void draw_pixel_on_window(window destination, color clr, double x, double y)" + ], + "python": [ + "def draw_pixel_on_window(destination, clr, x, y):" ], "csharp": [ - "public void Bitmap.DrawPixel(Color clr, double x, double y);", - "public static void SplashKit.DrawPixelOnBitmap(Bitmap destination, Color clr, double x, double y);" + "public static void SplashKit.DrawPixelOnWindow(Window destination, Color clr, double x, double y);" ], "pascal": [ - "procedure DrawPixelOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double)" + "procedure DrawPixelOnWindow(destination: Window; clr: Color; x: Double; y: Double)" ] } }, { - "signature": "void draw_pixel_on_bitmap(bitmap destination,color clr,double x,double y,drawing_options opts);", - "name": "draw_pixel_on_bitmap", - "method_name": "draw_pixel", - "unique_global_name": "draw_pixel_on_bitmap_with_options", - "unique_method_name": "bitmap.draw_pixel_with_options", + "signature": "void draw_pixel_on_window(window destination,color clr,double x,double y,drawing_options opts);", + "name": "draw_pixel_on_window", + "method_name": null, + "unique_global_name": "draw_pixel_on_window_with_options", + "unique_method_name": null, "suffix_name": null, - "description": "Draws an individual pixel to the given bitmap with the given drawing options.", + "description": "Draws an individual pixel to the given window with the given drawing options.", "brief": null, "return": { "type": "void", @@ -35696,8 +34612,8 @@ }, "parameters": { "destination": { - "type": "bitmap", - "description": "the bitmap to draw the pixel on", + "type": "window", + "description": "The window to draw the pixel on", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35723,7 +34639,7 @@ }, "x": { "type": "double", - "description": "The distance from the left edge of the bitmap to the\npixel", + "description": "The distance from the left edge of the window to the\npixel", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35736,7 +34652,7 @@ }, "y": { "type": "double", - "description": "The distance from the top edge of the bitmap to the\npixel", + "description": "The distance from the top edge of the window to the\npixel", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35762,62 +34678,46 @@ } }, "attributes": { - "class": "bitmap", - "method": "draw_pixel", + "class": "window", "suffix": "with_options", - "group": "graphics", - "self": "destination" + "group": "graphics" }, "signatures": { - "python": [ - "def draw_pixel_on_bitmap_with_options(destination, clr, x, y, opts):" - ], "cpp": [ - "void draw_pixel_on_bitmap(bitmap destination, color clr, double x, double y, drawing_options opts)" + "void draw_pixel_on_window(window destination, color clr, double x, double y, drawing_options opts)" + ], + "python": [ + "def draw_pixel_on_window_with_options(destination, clr, x, y, opts):" ], "csharp": [ - "public void Bitmap.DrawPixel(Color clr, double x, double y, DrawingOptions opts);", - "public static void SplashKit.DrawPixelOnBitmap(Bitmap destination, Color clr, double x, double y, DrawingOptions opts);" + "public static void SplashKit.DrawPixelOnWindow(Window destination, Color clr, double x, double y, DrawingOptions opts);" ], "pascal": [ - "procedure DrawPixelOnBitmap(destination: Bitmap; clr: Color; x: Double; y: Double; opts: DrawingOptions)" + "procedure DrawPixelOnWindow(destination: Window; clr: Color; x: Double; y: Double; opts: DrawingOptions)" ] } }, { - "signature": "void draw_pixel_on_window(window destination,color clr,const point_2d &pt);", - "name": "draw_pixel_on_window", - "method_name": "draw_pixel", - "unique_global_name": "draw_pixel_on_window_at_point", - "unique_method_name": "window.draw_pixel_at_point", + "signature": "color get_pixel(bitmap bmp,const point_2d &pt);", + "name": "get_pixel", + "method_name": null, + "unique_global_name": "get_pixel_from_bitmap_at_point", + "unique_method_name": null, "suffix_name": null, - "description": "Draws an individual pixel to the given window.", + "description": "Returns the color of the pixel at the location on the supplied\nbitmap.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "color", + "description": "The color of the pixel at the supplied location", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "The window to draw the pixel on", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the pixel", + "bmp": { + "type": "bitmap", + "description": "The bitmap to get the color from", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35830,7 +34730,7 @@ }, "pt": { "type": "point_2d", - "description": "The location of the pixel to draw", + "description": "The position of the pixel", "is_pointer": false, "is_const": true, "is_reference": true, @@ -35843,49 +34743,45 @@ } }, "attributes": { - "class": "window", - "method": "draw_pixel", - "suffix": "at_point", - "group": "graphics", - "self": "destination" + "suffix": "from_bitmap_at_point", + "group": "graphics" }, "signatures": { - "python": [ - "def draw_pixel_on_window_at_point(destination, clr, pt):" - ], "cpp": [ - "void draw_pixel_on_window(window destination, color clr, const point_2d &pt)" + "color get_pixel(bitmap bmp, const point_2d &pt)" + ], + "python": [ + "def get_pixel_from_bitmap_at_point(bmp, pt):" ], "csharp": [ - "public void Window.DrawPixel(Color clr, Point2D pt);", - "public static void SplashKit.DrawPixelOnWindow(Window destination, Color clr, Point2D pt);" + "public static Color SplashKit.GetPixel(Bitmap bmp, Point2D pt);" ], "pascal": [ - "procedure DrawPixelOnWindow(destination: Window; clr: Color; const pt: Point2D)" + "function GetPixel(bmp: Bitmap; const pt: Point2D): Color" ] } }, { - "signature": "void draw_pixel_on_window(window destination,color clr,const point_2d &pt,drawing_options opts);", - "name": "draw_pixel_on_window", - "method_name": "draw_pixel", - "unique_global_name": "draw_pixel_on_window_at_point_with_options", - "unique_method_name": "window.draw_pixel_at_point_with_options", + "signature": "color get_pixel(bitmap bmp,double x,double y);", + "name": "get_pixel", + "method_name": null, + "unique_global_name": "get_pixel_from_bitmap", + "unique_method_name": null, "suffix_name": null, - "description": "Draws an individual pixel to the given window with the given drawing options.", + "description": "Returns the color of the pixel at the x,y location on the supplied\nbitmap.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "color", + "description": "The color of the pixel at the supplied location", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "The window to draw the pixel on", + "bmp": { + "type": "bitmap", + "description": "The bitmap to get the color from", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35896,9 +34792,9 @@ "is_vector": false, "type_parameter": null }, - "clr": { - "type": "color", - "description": "The color of the pixel", + "x": { + "type": "double", + "description": "The distance from the left edge of the bitmap to the pixel\nto read", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35909,22 +34805,9 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The location of the pixel to draw", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "The drawing options", + "y": { + "type": "double", + "description": "The distance from the top of the bitmap to the pixel to read", "is_pointer": false, "is_const": false, "is_reference": false, @@ -35937,91 +34820,48 @@ } }, "attributes": { - "class": "window", - "method": "draw_pixel", - "suffix": "at_point_with_options", - "group": "graphics", - "self": "destination" + "suffix": "from_bitmap", + "group": "graphics" }, "signatures": { - "python": [ - "def draw_pixel_on_window_at_point_with_options(destination, clr, pt, opts):" - ], "cpp": [ - "void draw_pixel_on_window(window destination, color clr, const point_2d &pt, drawing_options opts)" + "color get_pixel(bitmap bmp, double x, double y)" + ], + "python": [ + "def get_pixel_from_bitmap(bmp, x, y):" ], "csharp": [ - "public void Window.DrawPixel(Color clr, Point2D pt, DrawingOptions opts);", - "public static void SplashKit.DrawPixelOnWindow(Window destination, Color clr, Point2D pt, DrawingOptions opts);" + "public static Color SplashKit.GetPixel(Bitmap bmp, double x, double y);" ], "pascal": [ - "procedure DrawPixelOnWindow(destination: Window; clr: Color; const pt: Point2D; opts: DrawingOptions)" + "function GetPixel(bmp: Bitmap; x: Double; y: Double): Color" ] } }, { - "signature": "void draw_pixel_on_window(window destination,color clr,double x,double y);", - "name": "draw_pixel_on_window", - "method_name": "draw_pixel", - "unique_global_name": "draw_pixel_on_window", - "unique_method_name": "window.draw_pixel", + "signature": "color get_pixel(const point_2d &pt);", + "name": "get_pixel", + "method_name": null, + "unique_global_name": "get_pixel_at_point", + "unique_method_name": null, "suffix_name": null, - "description": "Draws an individual pixel to the given window.", + "description": "Returns the color of the pixel at the x,y location on the current\nwindow.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "color", + "description": "The color of the pixel at the supplied location", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "the window to draw the pixel on", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the pixel", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The distance from the left edge of the window to the\npixel", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The distance from the top edge of the window to the\npixel", + "pt": { + "type": "point_2d", + "description": "The position of the pixel", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -36031,74 +34871,45 @@ } }, "attributes": { - "class": "window", - "method": "draw_pixel", - "group": "graphics", - "self": "destination" + "suffix": "at_point", + "group": "graphics" }, "signatures": { - "python": [ - "def draw_pixel_on_window(destination, clr, x, y):" - ], "cpp": [ - "void draw_pixel_on_window(window destination, color clr, double x, double y)" + "color get_pixel(const point_2d &pt)" + ], + "python": [ + "def get_pixel_at_point(pt):" ], "csharp": [ - "public void Window.DrawPixel(Color clr, double x, double y);", - "public static void SplashKit.DrawPixelOnWindow(Window destination, Color clr, double x, double y);" + "public static Color SplashKit.GetPixel(Point2D pt);" ], "pascal": [ - "procedure DrawPixelOnWindow(destination: Window; clr: Color; x: Double; y: Double)" + "function GetPixel(const pt: Point2D): Color" ] } }, { - "signature": "void draw_pixel_on_window(window destination,color clr,double x,double y,drawing_options opts);", - "name": "draw_pixel_on_window", - "method_name": "draw_pixel", - "unique_global_name": "draw_pixel_on_window_with_options", - "unique_method_name": "window.draw_pixel_with_options", + "signature": "color get_pixel(double x,double y);", + "name": "get_pixel", + "method_name": null, + "unique_global_name": "get_pixel", + "unique_method_name": null, "suffix_name": null, - "description": "Draws an individual pixel to the given window with the given drawing options.", + "description": "Returns the color of the pixel at the x,y location on the current\nwindow.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "color", + "description": "The color of the pixel at the supplied location", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "destination": { - "type": "window", - "description": "The window to draw the pixel on", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the pixel", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, "x": { "type": "double", - "description": "The distance from the left edge of the window to the\npixel", + "description": "The distance from the left edge of the window to the pixel\nto read", "is_pointer": false, "is_const": false, "is_reference": false, @@ -36111,20 +34922,7 @@ }, "y": { "type": "double", - "description": "The distance from the top edge of the window to the\npixel", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "The drawing options", + "description": "The distance from the top of the window to the pixel to read", "is_pointer": false, "is_const": false, "is_reference": false, @@ -36137,36 +34935,31 @@ } }, "attributes": { - "class": "window", - "method": "draw_pixel", - "suffix": "with_options", - "group": "graphics", - "self": "destination" + "group": "graphics" }, "signatures": { - "python": [ - "def draw_pixel_on_window_with_options(destination, clr, x, y, opts):" - ], "cpp": [ - "void draw_pixel_on_window(window destination, color clr, double x, double y, drawing_options opts)" + "color get_pixel(double x, double y)" + ], + "python": [ + "def get_pixel(x, y):" ], "csharp": [ - "public void Window.DrawPixel(Color clr, double x, double y, DrawingOptions opts);", - "public static void SplashKit.DrawPixelOnWindow(Window destination, Color clr, double x, double y, DrawingOptions opts);" + "public static Color SplashKit.GetPixel(double x, double y);" ], "pascal": [ - "procedure DrawPixelOnWindow(destination: Window; clr: Color; x: Double; y: Double; opts: DrawingOptions)" + "function GetPixel(x: Double; y: Double): Color" ] } }, { - "signature": "color get_pixel(bitmap bmp,const point_2d &pt);", + "signature": "color get_pixel(window wnd,const point_2d &pt);", "name": "get_pixel", "method_name": null, - "unique_global_name": "get_pixel_from_bitmap_at_point", + "unique_global_name": "get_pixel_from_window_at_point", "unique_method_name": null, "suffix_name": null, - "description": "Returns the color of the pixel at the location on the supplied\nbitmap.", + "description": "Returns the color of the pixel at the location on the supplied\nwindow.", "brief": null, "return": { "type": "color", @@ -36177,9 +34970,9 @@ "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to get the color from", + "wnd": { + "type": "window", + "description": "The window to get the color from", "is_pointer": false, "is_const": false, "is_reference": false, @@ -36205,32 +34998,32 @@ } }, "attributes": { - "suffix": "from_bitmap_at_point", + "suffix": "from_window_at_point", "group": "graphics" }, "signatures": { - "python": [ - "def get_pixel_from_bitmap_at_point(bmp, pt):" - ], "cpp": [ - "color get_pixel(bitmap bmp, const point_2d &pt)" + "color get_pixel(window wnd, const point_2d &pt)" + ], + "python": [ + "def get_pixel_from_window_at_point(wnd, pt):" ], "csharp": [ - "public static Color SplashKit.GetPixel(Bitmap bmp, Point2D pt);" + "public static Color SplashKit.GetPixel(Window wnd, Point2D pt);" ], "pascal": [ - "function GetPixel(bmp: Bitmap; const pt: Point2D): Color" + "function GetPixel(wnd: Window; const pt: Point2D): Color" ] } }, { - "signature": "color get_pixel(bitmap bmp,double x,double y);", + "signature": "color get_pixel(window wnd,double x,double y);", "name": "get_pixel", "method_name": null, - "unique_global_name": "get_pixel_from_bitmap", + "unique_global_name": "get_pixel_from_window", "unique_method_name": null, "suffix_name": null, - "description": "Returns the color of the pixel at the x,y location on the supplied\nbitmap.", + "description": "Returns the color of the pixel at the x,y location on the supplied\nwindow.", "brief": null, "return": { "type": "color", @@ -36241,22 +35034,9 @@ "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to get the color from", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The distance from the left edge of the bitmap to the pixel\nto read", + "wnd": { + "type": "window", + "description": "The window to get the color from", "is_pointer": false, "is_const": false, "is_reference": false, @@ -36267,108 +35047,6 @@ "is_vector": false, "type_parameter": null }, - "y": { - "type": "double", - "description": "The distance from the top of the bitmap to the pixel to read", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "from_bitmap", - "group": "graphics" - }, - "signatures": { - "python": [ - "def get_pixel_from_bitmap(bmp, x, y):" - ], - "cpp": [ - "color get_pixel(bitmap bmp, double x, double y)" - ], - "csharp": [ - "public static Color SplashKit.GetPixel(Bitmap bmp, double x, double y);" - ], - "pascal": [ - "function GetPixel(bmp: Bitmap; x: Double; y: Double): Color" - ] - } - }, - { - "signature": "color get_pixel(const point_2d &pt);", - "name": "get_pixel", - "method_name": null, - "unique_global_name": "get_pixel_at_point", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns the color of the pixel at the x,y location on the current\nwindow.", - "brief": null, - "return": { - "type": "color", - "description": "The color of the pixel at the supplied location", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "pt": { - "type": "point_2d", - "description": "The position of the pixel", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "at_point", - "group": "graphics" - }, - "signatures": { - "python": [ - "def get_pixel_at_point(pt):" - ], - "cpp": [ - "color get_pixel(const point_2d &pt)" - ], - "csharp": [ - "public static Color SplashKit.GetPixel(Point2D pt);" - ], - "pascal": [ - "function GetPixel(const pt: Point2D): Color" - ] - } - }, - { - "signature": "color get_pixel(double x,double y);", - "name": "get_pixel", - "method_name": null, - "unique_global_name": "get_pixel", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns the color of the pixel at the x,y location on the current\nwindow.", - "brief": null, - "return": { - "type": "color", - "description": "The color of the pixel at the supplied location", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { "x": { "type": "double", "description": "The distance from the left edge of the window to the pixel\nto read", @@ -36397,31 +35075,32 @@ } }, "attributes": { + "suffix": "from_window", "group": "graphics" }, "signatures": { - "python": [ - "def get_pixel(x, y):" - ], "cpp": [ - "color get_pixel(double x, double y)" + "color get_pixel(window wnd, double x, double y)" + ], + "python": [ + "def get_pixel_from_window(wnd, x, y):" ], "csharp": [ - "public static Color SplashKit.GetPixel(double x, double y);" + "public static Color SplashKit.GetPixel(Window wnd, double x, double y);" ], "pascal": [ - "function GetPixel(x: Double; y: Double): Color" + "function GetPixel(wnd: Window; x: Double; y: Double): Color" ] } }, { - "signature": "color get_pixel(window wnd,const point_2d &pt);", - "name": "get_pixel", + "signature": "color get_pixel_from_window(window destination,const point_2d &pt);", + "name": "get_pixel_from_window", "method_name": null, - "unique_global_name": "get_pixel_from_window_at_point", + "unique_global_name": "get_pixel_from_window_at_point_from_window", "unique_method_name": null, "suffix_name": null, - "description": "Returns the color of the pixel at the location on the supplied\nwindow.", + "description": "Returns the color of the pixel at the x,y location on the given\nwindow.", "brief": null, "return": { "type": "color", @@ -36432,9 +35111,9 @@ "type_parameter": null }, "parameters": { - "wnd": { + "destination": { "type": "window", - "description": "The window to get the color from", + "description": "The window to draw the pixel on", "is_pointer": false, "is_const": false, "is_reference": false, @@ -36460,32 +35139,32 @@ } }, "attributes": { - "suffix": "from_window_at_point", + "suffix": "at_point_from_window", "group": "graphics" }, "signatures": { - "python": [ - "def get_pixel_from_window_at_point(wnd, pt):" - ], "cpp": [ - "color get_pixel(window wnd, const point_2d &pt)" + "color get_pixel_from_window(window destination, const point_2d &pt)" + ], + "python": [ + "def get_pixel_from_window_at_point_from_window(destination, pt):" ], "csharp": [ - "public static Color SplashKit.GetPixel(Window wnd, Point2D pt);" + "public static Color SplashKit.GetPixelFromWindow(Window destination, Point2D pt);" ], "pascal": [ - "function GetPixel(wnd: Window; const pt: Point2D): Color" + "function GetPixelFromWindow(destination: Window; const pt: Point2D): Color" ] } }, { - "signature": "color get_pixel(window wnd,double x,double y);", - "name": "get_pixel", + "signature": "color get_pixel_from_window(window destination,double x,double y);", + "name": "get_pixel_from_window", "method_name": null, - "unique_global_name": "get_pixel_from_window", + "unique_global_name": "get_pixel_from_window_from_window", "unique_method_name": null, "suffix_name": null, - "description": "Returns the color of the pixel at the x,y location on the supplied\nwindow.", + "description": "Returns the color of the pixel at the x,y location on the given\nwindow.", "brief": null, "return": { "type": "color", @@ -36496,9 +35175,9 @@ "type_parameter": null }, "parameters": { - "wnd": { + "destination": { "type": "window", - "description": "The window to get the color from", + "description": "The window to draw the pixel on", "is_pointer": false, "is_const": false, "is_reference": false, @@ -36537,21 +35216,22 @@ } }, "attributes": { + "class": "window", "suffix": "from_window", "group": "graphics" }, "signatures": { - "python": [ - "def get_pixel_from_window(wnd, x, y):" - ], "cpp": [ - "color get_pixel(window wnd, double x, double y)" + "color get_pixel_from_window(window destination, double x, double y)" + ], + "python": [ + "def get_pixel_from_window_from_window(destination, x, y):" ], "csharp": [ - "public static Color SplashKit.GetPixel(Window wnd, double x, double y);" + "public static Color SplashKit.GetPixelFromWindow(Window destination, double x, double y);" ], "pascal": [ - "function GetPixel(wnd: Window; x: Double; y: Double): Color" + "function GetPixelFromWindow(destination: Window; x: Double; y: Double): Color" ] } }, @@ -36604,12 +35284,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_quad(clr, q):" - ], "cpp": [ "void draw_quad(color clr, const quad &q)" ], + "python": [ + "def draw_quad(clr, q):" + ], "csharp": [ "public static void SplashKit.DrawQuad(Color clr, Quad q);" ], @@ -36681,12 +35361,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_quad_with_options(clr, q, opts):" - ], "cpp": [ "void draw_quad(color clr, const quad &q, const drawing_options &opts)" ], + "python": [ + "def draw_quad_with_options(clr, q, opts):" + ], "csharp": [ "public static void SplashKit.DrawQuad(Color clr, Quad q, DrawingOptions opts);" ], @@ -36760,12 +35440,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_quad_on_bitmap(destination, clr, q):" - ], "cpp": [ "void draw_quad_on_bitmap(bitmap destination, color clr, const quad &q)" ], + "python": [ + "def draw_quad_on_bitmap(destination, clr, q):" + ], "csharp": [ "public void Bitmap.DrawQuad(Color clr, Quad q);", "public static void SplashKit.DrawQuadOnBitmap(Bitmap destination, Color clr, Quad q);" @@ -36854,12 +35534,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_quad_on_bitmap_with_options(destination, clr, q, opts):" - ], "cpp": [ "void draw_quad_on_bitmap(bitmap destination, color clr, const quad &q, const drawing_options &opts)" ], + "python": [ + "def draw_quad_on_bitmap_with_options(destination, clr, q, opts):" + ], "csharp": [ "public void Bitmap.DrawQuad(Color clr, Quad q, DrawingOptions opts);", "public static void SplashKit.DrawQuadOnBitmap(Bitmap destination, Color clr, Quad q, DrawingOptions opts);" @@ -36934,12 +35614,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_quad_on_window(destination, clr, q):" - ], "cpp": [ "void draw_quad_on_window(window destination, color clr, const quad &q)" ], + "python": [ + "def draw_quad_on_window(destination, clr, q):" + ], "csharp": [ "public void Window.DrawQuad(Color clr, Quad q);", "public static void SplashKit.DrawQuadOnWindow(Window destination, Color clr, Quad q);" @@ -37028,12 +35708,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_quad_on_window_with_options(destination, clr, q, opts):" - ], "cpp": [ "void draw_quad_on_window(window destination, color clr, const quad &q, const drawing_options &opts)" ], + "python": [ + "def draw_quad_on_window_with_options(destination, clr, q, opts):" + ], "csharp": [ "public void Window.DrawQuad(Color clr, Quad q, DrawingOptions opts);", "public static void SplashKit.DrawQuadOnWindow(Window destination, Color clr, Quad q, DrawingOptions opts);" @@ -37093,12 +35773,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_rectangle_record(clr, rect):" - ], "cpp": [ "void draw_rectangle(color clr, const rectangle &rect)" ], + "python": [ + "def draw_rectangle_record(clr, rect):" + ], "csharp": [ "public static void SplashKit.DrawRectangle(Color clr, Rectangle rect);" ], @@ -37170,12 +35850,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_rectangle_record_with_options(clr, rect, opts):" - ], "cpp": [ "void draw_rectangle(color clr, const rectangle &rect, const drawing_options &opts)" ], + "python": [ + "def draw_rectangle_record_with_options(clr, rect, opts):" + ], "csharp": [ "public static void SplashKit.DrawRectangle(Color clr, Rectangle rect, DrawingOptions opts);" ], @@ -37272,12 +35952,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_rectangle(clr, x, y, width, height):" - ], "cpp": [ "void draw_rectangle(color clr, double x, double y, double width, double height)" ], + "python": [ + "def draw_rectangle(clr, x, y, width, height):" + ], "csharp": [ "public static void SplashKit.DrawRectangle(Color clr, double x, double y, double width, double height);" ], @@ -37388,12 +36068,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_rectangle_with_options(clr, x, y, width, height, opts):" - ], "cpp": [ "void draw_rectangle(color clr, double x, double y, double width, double height, const drawing_options &opts)" ], + "python": [ + "def draw_rectangle_with_options(clr, x, y, width, height, opts):" + ], "csharp": [ "public static void SplashKit.DrawRectangle(Color clr, double x, double y, double width, double height, DrawingOptions opts);" ], @@ -37468,12 +36148,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_rectangle_on_bitmap_record(destination, clr, rect):" - ], "cpp": [ "void draw_rectangle_on_bitmap(bitmap destination, color clr, const rectangle &rect)" ], + "python": [ + "def draw_rectangle_on_bitmap_record(destination, clr, rect):" + ], "csharp": [ "public void Bitmap.DrawRectangle(Color clr, Rectangle rect);", "public static void SplashKit.DrawRectangleOnBitmap(Bitmap destination, Color clr, Rectangle rect);" @@ -37562,12 +36242,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_rectangle_on_bitmap_record_with_options(destination, clr, rect, opts):" - ], "cpp": [ "void draw_rectangle_on_bitmap(bitmap destination, color clr, const rectangle &rect, const drawing_options &opts)" ], + "python": [ + "def draw_rectangle_on_bitmap_record_with_options(destination, clr, rect, opts):" + ], "csharp": [ "public void Bitmap.DrawRectangle(Color clr, Rectangle rect, DrawingOptions opts);", "public static void SplashKit.DrawRectangleOnBitmap(Bitmap destination, Color clr, Rectangle rect, DrawingOptions opts);" @@ -37681,12 +36361,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_rectangle_on_bitmap(destination, clr, x, y, width, height):" - ], "cpp": [ "void draw_rectangle_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height)" ], + "python": [ + "def draw_rectangle_on_bitmap(destination, clr, x, y, width, height):" + ], "csharp": [ "public void Bitmap.DrawRectangle(Color clr, double x, double y, double width, double height);", "public static void SplashKit.DrawRectangleOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height);" @@ -37814,12 +36494,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_rectangle_on_bitmap_with_options(destination, clr, x, y, width, height, opts):" - ], "cpp": [ "void draw_rectangle_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height, drawing_options opts)" ], + "python": [ + "def draw_rectangle_on_bitmap_with_options(destination, clr, x, y, width, height, opts):" + ], "csharp": [ "public void Bitmap.DrawRectangle(Color clr, double x, double y, double width, double height, DrawingOptions opts);", "public static void SplashKit.DrawRectangleOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);" @@ -37895,12 +36575,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_rectangle_on_window_record(destination, clr, rect):" - ], "cpp": [ "void draw_rectangle_on_window(window destination, color clr, const rectangle &rect)" ], + "python": [ + "def draw_rectangle_on_window_record(destination, clr, rect):" + ], "csharp": [ "public void Window.DrawRectangle(Color clr, Rectangle rect);", "public static void SplashKit.DrawRectangleOnWindow(Window destination, Color clr, Rectangle rect);" @@ -37989,12 +36669,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_rectangle_on_window_record_with_options(destination, clr, rect, opts):" - ], "cpp": [ "void draw_rectangle_on_window(window destination, color clr, const rectangle &rect, const drawing_options &opts)" ], + "python": [ + "def draw_rectangle_on_window_record_with_options(destination, clr, rect, opts):" + ], "csharp": [ "public void Window.DrawRectangle(Color clr, Rectangle rect, DrawingOptions opts);", "public static void SplashKit.DrawRectangleOnWindow(Window destination, Color clr, Rectangle rect, DrawingOptions opts);" @@ -38108,12 +36788,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_rectangle_on_window(destination, clr, x, y, width, height):" - ], "cpp": [ "void draw_rectangle_on_window(window destination, color clr, double x, double y, double width, double height)" ], + "python": [ + "def draw_rectangle_on_window(destination, clr, x, y, width, height):" + ], "csharp": [ "public void Window.DrawRectangle(Color clr, double x, double y, double width, double height);", "public static void SplashKit.DrawRectangleOnWindow(Window destination, Color clr, double x, double y, double width, double height);" @@ -38241,12 +36921,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_rectangle_on_window_with_options(destination, clr, x, y, width, height, opts):" - ], "cpp": [ "void draw_rectangle_on_window(window destination, color clr, double x, double y, double width, double height, drawing_options opts)" ], + "python": [ + "def draw_rectangle_on_window_with_options(destination, clr, x, y, width, height, opts):" + ], "csharp": [ "public void Window.DrawRectangle(Color clr, double x, double y, double width, double height, DrawingOptions opts);", "public static void SplashKit.DrawRectangleOnWindow(Window destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);" @@ -38305,12 +36985,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def fill_quad(clr, q):" - ], "cpp": [ "void fill_quad(color clr, const quad &q)" ], + "python": [ + "def fill_quad(clr, q):" + ], "csharp": [ "public static void SplashKit.FillQuad(Color clr, Quad q);" ], @@ -38382,12 +37062,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def fill_quad_with_options(clr, q, opts):" - ], "cpp": [ "void fill_quad(color clr, const quad &q, const drawing_options &opts)" ], + "python": [ + "def fill_quad_with_options(clr, q, opts):" + ], "csharp": [ "public static void SplashKit.FillQuad(Color clr, Quad q, DrawingOptions opts);" ], @@ -38461,12 +37141,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_quad_on_bitmap(destination, clr, q):" - ], "cpp": [ "void fill_quad_on_bitmap(bitmap destination, color clr, const quad &q)" ], + "python": [ + "def fill_quad_on_bitmap(destination, clr, q):" + ], "csharp": [ "public void Bitmap.FillQuad(Color clr, Quad q);", "public static void SplashKit.FillQuadOnBitmap(Bitmap destination, Color clr, Quad q);" @@ -38555,12 +37235,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_quad_on_bitmap_with_options(destination, clr, q, opts):" - ], "cpp": [ "void fill_quad_on_bitmap(bitmap destination, color clr, const quad &q, const drawing_options &opts)" ], + "python": [ + "def fill_quad_on_bitmap_with_options(destination, clr, q, opts):" + ], "csharp": [ "public void Bitmap.FillQuad(Color clr, Quad q, DrawingOptions opts);", "public static void SplashKit.FillQuadOnBitmap(Bitmap destination, Color clr, Quad q, DrawingOptions opts);" @@ -38635,12 +37315,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_quad_on_window(destination, clr, q):" - ], "cpp": [ "void fill_quad_on_window(window destination, color clr, const quad &q)" ], + "python": [ + "def fill_quad_on_window(destination, clr, q):" + ], "csharp": [ "public void Window.FillQuad(Color clr, Quad q);", "public static void SplashKit.FillQuadOnWindow(Window destination, Color clr, Quad q);" @@ -38653,9 +37333,9 @@ { "signature": "void fill_quad_on_window(window destination,color clr,const quad &q,const drawing_options &opts);", "name": "fill_quad_on_window", - "method_name": "fill_quad", + "method_name": null, "unique_global_name": "fill_quad_on_window_with_options", - "unique_method_name": "window.fill_quad_with_options", + "unique_method_name": null, "suffix_name": null, "description": "Fill a quad on the supplied window using the supplied drawing options.", "brief": null, @@ -38723,20 +37403,17 @@ }, "attributes": { "class": "window", - "method": "fill_quad", "suffix": "with_options", - "group": "graphics", - "self": "destination" + "group": "graphics" }, "signatures": { - "python": [ - "def fill_quad_on_window_with_options(destination, clr, q, opts):" - ], "cpp": [ "void fill_quad_on_window(window destination, color clr, const quad &q, const drawing_options &opts)" ], + "python": [ + "def fill_quad_on_window_with_options(destination, clr, q, opts):" + ], "csharp": [ - "public void Window.FillQuad(Color clr, Quad q, DrawingOptions opts);", "public static void SplashKit.FillQuadOnWindow(Window destination, Color clr, Quad q, DrawingOptions opts);" ], "pascal": [ @@ -38794,12 +37471,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def fill_rectangle_record(clr, rect):" - ], "cpp": [ "void fill_rectangle(color clr, const rectangle &rect)" ], + "python": [ + "def fill_rectangle_record(clr, rect):" + ], "csharp": [ "public static void SplashKit.FillRectangle(Color clr, Rectangle rect);" ], @@ -38871,12 +37548,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def fill_rectangle_record_with_options(clr, rect, opts):" - ], "cpp": [ "void fill_rectangle(color clr, const rectangle &rect, const drawing_options &opts)" ], + "python": [ + "def fill_rectangle_record_with_options(clr, rect, opts):" + ], "csharp": [ "public static void SplashKit.FillRectangle(Color clr, Rectangle rect, DrawingOptions opts);" ], @@ -38973,12 +37650,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def fill_rectangle(clr, x, y, width, height):" - ], "cpp": [ "void fill_rectangle(color clr, double x, double y, double width, double height)" ], + "python": [ + "def fill_rectangle(clr, x, y, width, height):" + ], "csharp": [ "public static void SplashKit.FillRectangle(Color clr, double x, double y, double width, double height);" ], @@ -39089,12 +37766,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def fill_rectangle_with_options(clr, x, y, width, height, opts):" - ], "cpp": [ "void fill_rectangle(color clr, double x, double y, double width, double height, const drawing_options &opts)" ], + "python": [ + "def fill_rectangle_with_options(clr, x, y, width, height, opts):" + ], "csharp": [ "public static void SplashKit.FillRectangle(Color clr, double x, double y, double width, double height, DrawingOptions opts);" ], @@ -39169,12 +37846,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_rectangle_on_bitmap_record(destination, clr, rect):" - ], "cpp": [ "void fill_rectangle_on_bitmap(bitmap destination, color clr, const rectangle &rect)" ], + "python": [ + "def fill_rectangle_on_bitmap_record(destination, clr, rect):" + ], "csharp": [ "public void Bitmap.FillRectangle(Color clr, Rectangle rect);", "public static void SplashKit.FillRectangleOnBitmap(Bitmap destination, Color clr, Rectangle rect);" @@ -39263,12 +37940,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_rectangle_on_bitmap_record_with_options(destination, clr, rect, opts):" - ], "cpp": [ "void fill_rectangle_on_bitmap(bitmap destination, color clr, const rectangle &rect, const drawing_options &opts)" ], + "python": [ + "def fill_rectangle_on_bitmap_record_with_options(destination, clr, rect, opts):" + ], "csharp": [ "public void Bitmap.FillRectangle(Color clr, Rectangle rect, DrawingOptions opts);", "public static void SplashKit.FillRectangleOnBitmap(Bitmap destination, Color clr, Rectangle rect, DrawingOptions opts);" @@ -39382,12 +38059,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_rectangle_on_bitmap(destination, clr, x, y, width, height):" - ], "cpp": [ "void fill_rectangle_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height)" ], + "python": [ + "def fill_rectangle_on_bitmap(destination, clr, x, y, width, height):" + ], "csharp": [ "public void Bitmap.FillRectangle(Color clr, double x, double y, double width, double height);", "public static void SplashKit.FillRectangleOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height);" @@ -39515,12 +38192,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_rectangle_on_bitmap_with_options(destination, clr, x, y, width, height, opts):" - ], "cpp": [ "void fill_rectangle_on_bitmap(bitmap destination, color clr, double x, double y, double width, double height, const drawing_options &opts)" ], + "python": [ + "def fill_rectangle_on_bitmap_with_options(destination, clr, x, y, width, height, opts):" + ], "csharp": [ "public void Bitmap.FillRectangle(Color clr, double x, double y, double width, double height, DrawingOptions opts);", "public static void SplashKit.FillRectangleOnBitmap(Bitmap destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);" @@ -39596,12 +38273,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_rectangle_on_window_record(destination, clr, rect):" - ], "cpp": [ "void fill_rectangle_on_window(window destination, color clr, const rectangle &rect)" ], + "python": [ + "def fill_rectangle_on_window_record(destination, clr, rect):" + ], "csharp": [ "public void Window.FillRectangle(Color clr, Rectangle rect);", "public static void SplashKit.FillRectangleOnWindow(Window destination, Color clr, Rectangle rect);" @@ -39690,12 +38367,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_rectangle_on_window_record_with_options(destination, clr, rect, opts):" - ], "cpp": [ "void fill_rectangle_on_window(window destination, color clr, const rectangle &rect, const drawing_options &opts)" ], + "python": [ + "def fill_rectangle_on_window_record_with_options(destination, clr, rect, opts):" + ], "csharp": [ "public void Window.FillRectangle(Color clr, Rectangle rect, DrawingOptions opts);", "public static void SplashKit.FillRectangleOnWindow(Window destination, Color clr, Rectangle rect, DrawingOptions opts);" @@ -39809,12 +38486,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_rectangle_on_window(destination, clr, x, y, width, height):" - ], "cpp": [ "void fill_rectangle_on_window(window destination, color clr, double x, double y, double width, double height)" ], + "python": [ + "def fill_rectangle_on_window(destination, clr, x, y, width, height):" + ], "csharp": [ "public void Window.FillRectangle(Color clr, double x, double y, double width, double height);", "public static void SplashKit.FillRectangleOnWindow(Window destination, Color clr, double x, double y, double width, double height);" @@ -39942,12 +38619,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_rectangle_on_window_with_options(destination, clr, x, y, width, height, opts):" - ], "cpp": [ "void fill_rectangle_on_window(window destination, color clr, double x, double y, double width, double height, const drawing_options &opts)" ], + "python": [ + "def fill_rectangle_on_window_with_options(destination, clr, x, y, width, height, opts):" + ], "csharp": [ "public void Window.FillRectangle(Color clr, double x, double y, double width, double height, DrawingOptions opts);", "public static void SplashKit.FillRectangleOnWindow(Window destination, Color clr, double x, double y, double width, double height, DrawingOptions opts);" @@ -40060,12 +38737,12 @@ "static": "text" }, "signatures": { - "python": [ - "def draw_text_font_as_string(text, clr, fnt, font_size, x, y):" - ], "cpp": [ "void draw_text(const string &text, const color &clr, const string &fnt, int font_size, double x, double y)" ], + "python": [ + "def draw_text_font_as_string(text, clr, fnt, font_size, x, y):" + ], "csharp": [ "public static void SplashKit.DrawText(string text, Color clr, string fnt, int fontSize, double x, double y);" ], @@ -40190,12 +38867,12 @@ "static": "text" }, "signatures": { - "python": [ - "def draw_text_with_options_font_as_string(text, clr, fnt, font_size, x, y, opts):" - ], "cpp": [ "void draw_text(const string &text, const color &clr, const string &fnt, int font_size, double x, double y, const drawing_options &opts)" ], + "python": [ + "def draw_text_with_options_font_as_string(text, clr, fnt, font_size, x, y, opts):" + ], "csharp": [ "public static void SplashKit.DrawText(string text, Color clr, string fnt, int fontSize, double x, double y, DrawingOptions opts);" ], @@ -40281,12 +38958,12 @@ "static": "text" }, "signatures": { - "python": [ - "def draw_text_no_font_no_size(text, clr, x, y):" - ], "cpp": [ "void draw_text(const string &text, const color &clr, double x, double y)" ], + "python": [ + "def draw_text_no_font_no_size(text, clr, x, y):" + ], "csharp": [ "public static void SplashKit.DrawText(string text, Color clr, double x, double y);" ], @@ -40385,12 +39062,12 @@ "static": "text" }, "signatures": { - "python": [ - "def draw_text_no_font_no_size_with_options(text, clr, x, y, opts):" - ], "cpp": [ "void draw_text(const string &text, const color &clr, double x, double y, const drawing_options &opts)" ], + "python": [ + "def draw_text_no_font_no_size_with_options(text, clr, x, y, opts):" + ], "csharp": [ "public static void SplashKit.DrawText(string text, Color clr, double x, double y, DrawingOptions opts);" ], @@ -40501,12 +39178,12 @@ "static": "text" }, "signatures": { - "python": [ - "def draw_text(text, clr, fnt, font_size, x, y):" - ], "cpp": [ "void draw_text(const string &text, const color &clr, font fnt, int font_size, double x, double y)" ], + "python": [ + "def draw_text(text, clr, fnt, font_size, x, y):" + ], "csharp": [ "public static void SplashKit.DrawText(string text, Color clr, Font fnt, int fontSize, double x, double y);" ], @@ -40631,12 +39308,12 @@ "static": "text" }, "signatures": { - "python": [ - "def draw_text_with_options(text, clr, fnt, font_size, x, y, opts):" - ], "cpp": [ "void draw_text(const string &text, const color &clr, font fnt, int font_size, double x, double y, const drawing_options &opts)" ], + "python": [ + "def draw_text_with_options(text, clr, fnt, font_size, x, y, opts):" + ], "csharp": [ "public static void SplashKit.DrawText(string text, Color clr, Font fnt, int fontSize, double x, double y, DrawingOptions opts);" ], @@ -40764,12 +39441,12 @@ "self": "bmp" }, "signatures": { - "python": [ - "def draw_text_on_bitmap_font_as_string(bmp, text, clr, fnt, font_size, x, y):" - ], "cpp": [ "void draw_text_on_bitmap(bitmap bmp, const string &text, const color &clr, const string &fnt, int font_size, double x, double y)" ], + "python": [ + "def draw_text_on_bitmap_font_as_string(bmp, text, clr, fnt, font_size, x, y):" + ], "csharp": [ "public void Bitmap.DrawText(string text, Color clr, string fnt, int fontSize, double x, double y);", "public static void SplashKit.DrawTextOnBitmap(Bitmap bmp, string text, Color clr, string fnt, int fontSize, double x, double y);" @@ -40911,12 +39588,12 @@ "self": "bmp" }, "signatures": { - "python": [ - "def draw_text_on_bitmap_with_options_font_as_string(bmp, text, clr, fnt, font_size, x, y, opts):" - ], "cpp": [ "void draw_text_on_bitmap(bitmap bmp, const string &text, const color &clr, const string &fnt, int font_size, double x, double y, const drawing_options &opts)" ], + "python": [ + "def draw_text_on_bitmap_with_options_font_as_string(bmp, text, clr, fnt, font_size, x, y, opts):" + ], "csharp": [ "public void Bitmap.DrawText(string text, Color clr, string fnt, int fontSize, double x, double y, DrawingOptions opts);", "public static void SplashKit.DrawTextOnBitmap(Bitmap bmp, string text, Color clr, string fnt, int fontSize, double x, double y, DrawingOptions opts);" @@ -41019,12 +39696,12 @@ "self": "bmp" }, "signatures": { - "python": [ - "def draw_text_on_bitmap_no_font_no_size(bmp, text, clr, x, y):" - ], "cpp": [ "void draw_text_on_bitmap(bitmap bmp, const string &text, const color &clr, double x, double y)" ], + "python": [ + "def draw_text_on_bitmap_no_font_no_size(bmp, text, clr, x, y):" + ], "csharp": [ "public void Bitmap.DrawText(string text, Color clr, double x, double y);", "public static void SplashKit.DrawTextOnBitmap(Bitmap bmp, string text, Color clr, double x, double y);" @@ -41140,12 +39817,12 @@ "self": "bmp" }, "signatures": { - "python": [ - "def draw_text_on_bitmap_no_font_no_size_with_options(bmp, text, clr, x, y, opts):" - ], "cpp": [ "void draw_text_on_bitmap(bitmap bmp, const string &text, const color &clr, double x, double y, const drawing_options &opts)" ], + "python": [ + "def draw_text_on_bitmap_no_font_no_size_with_options(bmp, text, clr, x, y, opts):" + ], "csharp": [ "public void Bitmap.DrawText(string text, Color clr, double x, double y, DrawingOptions opts);", "public static void SplashKit.DrawTextOnBitmap(Bitmap bmp, string text, Color clr, double x, double y, DrawingOptions opts);" @@ -41273,12 +39950,12 @@ "self": "bmp" }, "signatures": { - "python": [ - "def draw_text_on_bitmap(bmp, text, clr, fnt, font_size, x, y):" - ], "cpp": [ "void draw_text_on_bitmap(bitmap bmp, const string &text, const color &clr, font fnt, int font_size, double x, double y)" ], + "python": [ + "def draw_text_on_bitmap(bmp, text, clr, fnt, font_size, x, y):" + ], "csharp": [ "public void Bitmap.DrawText(string text, Color clr, Font fnt, int fontSize, double x, double y);", "public static void SplashKit.DrawTextOnBitmap(Bitmap bmp, string text, Color clr, Font fnt, int fontSize, double x, double y);" @@ -41420,12 +40097,12 @@ "self": "bmp" }, "signatures": { - "python": [ - "def draw_text_on_bitmap_with_options(bmp, text, clr, fnt, font_size, x, y, opts):" - ], "cpp": [ "void draw_text_on_bitmap(bitmap bmp, const string &text, const color &clr, font fnt, int font_size, double x, double y, const drawing_options &opts)" ], + "python": [ + "def draw_text_on_bitmap_with_options(bmp, text, clr, fnt, font_size, x, y, opts):" + ], "csharp": [ "public void Bitmap.DrawText(string text, Color clr, Font fnt, int fontSize, double x, double y, DrawingOptions opts);", "public static void SplashKit.DrawTextOnBitmap(Bitmap bmp, string text, Color clr, Font fnt, int fontSize, double x, double y, DrawingOptions opts);" @@ -41554,12 +40231,12 @@ "self": "wnd" }, "signatures": { - "python": [ - "def draw_text_on_window_font_as_string(wnd, text, clr, fnt, font_size, x, y):" - ], "cpp": [ "void draw_text_on_window(window wnd, const string &text, const color &clr, const string &fnt, int font_size, double x, double y)" ], + "python": [ + "def draw_text_on_window_font_as_string(wnd, text, clr, fnt, font_size, x, y):" + ], "csharp": [ "public void Window.DrawText(string text, Color clr, string fnt, int fontSize, double x, double y);", "public static void SplashKit.DrawTextOnWindow(Window wnd, string text, Color clr, string fnt, int fontSize, double x, double y);" @@ -41701,12 +40378,12 @@ "self": "wnd" }, "signatures": { - "python": [ - "def draw_text_on_window_with_options_font_as_string(wnd, text, clr, fnt, font_size, x, y, opts):" - ], "cpp": [ "void draw_text_on_window(window wnd, const string &text, const color &clr, const string &fnt, int font_size, double x, double y, const drawing_options &opts)" ], + "python": [ + "def draw_text_on_window_with_options_font_as_string(wnd, text, clr, fnt, font_size, x, y, opts):" + ], "csharp": [ "public void Window.DrawText(string text, Color clr, string fnt, int fontSize, double x, double y, DrawingOptions opts);", "public static void SplashKit.DrawTextOnWindow(Window wnd, string text, Color clr, string fnt, int fontSize, double x, double y, DrawingOptions opts);" @@ -41809,12 +40486,12 @@ "self": "wnd" }, "signatures": { - "python": [ - "def draw_text_on_window_no_font_no_size(wnd, text, clr, x, y):" - ], "cpp": [ "void draw_text_on_window(window wnd, const string &text, const color &clr, double x, double y)" ], + "python": [ + "def draw_text_on_window_no_font_no_size(wnd, text, clr, x, y):" + ], "csharp": [ "public void Window.DrawText(string text, Color clr, double x, double y);", "public static void SplashKit.DrawTextOnWindow(Window wnd, string text, Color clr, double x, double y);" @@ -41930,12 +40607,12 @@ "self": "wnd" }, "signatures": { - "python": [ - "def draw_text_on_window_no_font_no_size_with_options(wnd, text, clr, x, y, opts):" - ], "cpp": [ "void draw_text_on_window(window wnd, const string &text, const color &clr, double x, double y, const drawing_options &opts)" ], + "python": [ + "def draw_text_on_window_no_font_no_size_with_options(wnd, text, clr, x, y, opts):" + ], "csharp": [ "public void Window.DrawText(string text, Color clr, double x, double y, DrawingOptions opts);", "public static void SplashKit.DrawTextOnWindow(Window wnd, string text, Color clr, double x, double y, DrawingOptions opts);" @@ -42063,12 +40740,12 @@ "self": "wnd" }, "signatures": { - "python": [ - "def draw_text_on_window(wnd, text, clr, fnt, font_size, x, y):" - ], "cpp": [ "void draw_text_on_window(window wnd, const string &text, const color &clr, font fnt, int font_size, double x, double y)" ], + "python": [ + "def draw_text_on_window(wnd, text, clr, fnt, font_size, x, y):" + ], "csharp": [ "public void Window.DrawText(string text, Color clr, Font fnt, int fontSize, double x, double y);", "public static void SplashKit.DrawTextOnWindow(Window wnd, string text, Color clr, Font fnt, int fontSize, double x, double y);" @@ -42210,12 +40887,12 @@ "self": "wnd" }, "signatures": { - "python": [ - "def draw_text_on_window_with_options(wnd, text, clr, fnt, font_size, x, y, opts):" - ], "cpp": [ "void draw_text_on_window(window wnd, const string &text, const color &clr, font fnt, int font_size, double x, double y, const drawing_options &opts)" ], + "python": [ + "def draw_text_on_window_with_options(wnd, text, clr, fnt, font_size, x, y, opts):" + ], "csharp": [ "public void Window.DrawText(string text, Color clr, Font fnt, int fontSize, double x, double y, DrawingOptions opts);", "public static void SplashKit.DrawTextOnWindow(Window wnd, string text, Color clr, Font fnt, int fontSize, double x, double y, DrawingOptions opts);" @@ -42276,12 +40953,12 @@ "static": "text" }, "signatures": { - "python": [ - "def font_has_size_name_as_string(name, font_size):" - ], "cpp": [ "bool font_has_size(const string &name, int font_size)" ], + "python": [ + "def font_has_size_name_as_string(name, font_size):" + ], "csharp": [ "public static bool SplashKit.FontHasSize(string name, int fontSize);" ], @@ -42343,12 +41020,12 @@ "static": "text" }, "signatures": { - "python": [ - "def font_has_size(fnt, font_size):" - ], "cpp": [ "bool font_has_size(font fnt, int font_size)" ], + "python": [ + "def font_has_size(fnt, font_size):" + ], "csharp": [ "public bool Font.HasSize(int fontSize);", "public static bool SplashKit.FontHasSize(Font fnt, int fontSize);" @@ -42409,12 +41086,12 @@ "static": "text" }, "signatures": { - "python": [ - "def font_load_size_name_as_string(name, font_size):" - ], "cpp": [ "void font_load_size(const string &name, int font_size)" ], + "python": [ + "def font_load_size_name_as_string(name, font_size):" + ], "csharp": [ "public static void SplashKit.FontLoadSize(string name, int fontSize);" ], @@ -42476,12 +41153,12 @@ "static": "text" }, "signatures": { - "python": [ - "def font_load_size(fnt, font_size):" - ], "cpp": [ "void font_load_size(font fnt, int font_size)" ], + "python": [ + "def font_load_size(fnt, font_size):" + ], "csharp": [ "public void Font.LoadSize(int fontSize);", "public static void SplashKit.FontLoadSize(Font fnt, int fontSize);" @@ -42528,12 +41205,12 @@ "static": "text" }, "signatures": { - "python": [ - "def font_named(name):" - ], "cpp": [ "font font_named(string name)" ], + "python": [ + "def font_named(name):" + ], "csharp": [ "public static Font SplashKit.FontNamed(string name);" ], @@ -42567,12 +41244,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def free_all_fonts():" - ], "cpp": [ "void free_all_fonts()" ], + "python": [ + "def free_all_fonts():" + ], "csharp": [ "public static void Text.FreeAll();", "public static void SplashKit.FreeAllFonts();" @@ -42623,12 +41300,12 @@ "static": "text" }, "signatures": { - "python": [ - "def free_font(fnt):" - ], "cpp": [ "void free_font(font fnt)" ], + "python": [ + "def free_font(fnt):" + ], "csharp": [ "public void Font.Free();", "public static void SplashKit.FreeFont(Font fnt);" @@ -42676,12 +41353,12 @@ "static": "text" }, "signatures": { - "python": [ - "def get_font_style_name_as_string(name):" - ], "cpp": [ "font_style get_font_style(const string &name)" ], + "python": [ + "def get_font_style_name_as_string(name):" + ], "csharp": [ "public static FontStyle SplashKit.GetFontStyle(string name);" ], @@ -42730,12 +41407,12 @@ "static": "text" }, "signatures": { - "python": [ - "def get_font_style(fnt):" - ], "cpp": [ "font_style get_font_style(font fnt)" ], + "python": [ + "def get_font_style(fnt):" + ], "csharp": [ "public FontStyle Font.Style { get }", "public static FontStyle SplashKit.GetFontStyle(Font fnt);" @@ -42769,12 +41446,12 @@ "static": "text" }, "signatures": { - "python": [ - "def get_system_font():" - ], "cpp": [ "font get_system_font()" ], + "python": [ + "def get_system_font():" + ], "csharp": [ "public static Font SplashKit.GetSystemFont();" ], @@ -42820,12 +41497,12 @@ "static": "text" }, "signatures": { - "python": [ - "def has_font(fnt):" - ], "cpp": [ "bool has_font(font fnt)" ], + "python": [ + "def has_font(fnt):" + ], "csharp": [ "public static bool SplashKit.HasFont(Font fnt);" ], @@ -42872,12 +41549,12 @@ "static": "text" }, "signatures": { - "python": [ - "def has_font_name_as_string(name):" - ], "cpp": [ "bool has_font(string name)" ], + "python": [ + "def has_font_name_as_string(name):" + ], "csharp": [ "public static bool SplashKit.HasFont(string name);" ], @@ -42938,12 +41615,12 @@ "static": "text" }, "signatures": { - "python": [ - "def load_font(name, filename):" - ], "cpp": [ "font load_font(const string &name, const string &filename)" ], + "python": [ + "def load_font(name, filename):" + ], "csharp": [ "public static Font SplashKit.LoadFont(string name, string filename);", "public Font(string name, string filename);" @@ -43004,12 +41681,12 @@ "static": "text" }, "signatures": { - "python": [ - "def set_font_style_name_as_string(name, style):" - ], "cpp": [ "void set_font_style(const string &name, font_style style)" ], + "python": [ + "def set_font_style_name_as_string(name, style):" + ], "csharp": [ "public static void SplashKit.SetFontStyle(string name, FontStyle style);" ], @@ -43071,12 +41748,12 @@ "static": "text" }, "signatures": { - "python": [ - "def set_font_style(fnt, style):" - ], "cpp": [ "void set_font_style(font fnt, font_style style)" ], + "python": [ + "def set_font_style(fnt, style):" + ], "csharp": [ "public void Font.Style { set }", "public static void SplashKit.SetFontStyle(Font fnt, FontStyle style);" @@ -43151,12 +41828,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def text_height_font_named(text, fnt, font_size):" - ], "cpp": [ "int text_height(const string &text, const string &fnt, int font_size)" ], + "python": [ + "def text_height_font_named(text, fnt, font_size):" + ], "csharp": [ "public static int Text.Height(string text, string fnt, int fontSize);", "public static int SplashKit.TextHeight(string text, string fnt, int fontSize);" @@ -43230,12 +41907,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def text_height(text, fnt, font_size):" - ], "cpp": [ "int text_height(const string &text, font fnt, int font_size)" ], + "python": [ + "def text_height(text, fnt, font_size):" + ], "csharp": [ "public static int Text.Height(string text, Font fnt, int fontSize);", "public static int SplashKit.TextHeight(string text, Font fnt, int fontSize);" @@ -43310,12 +41987,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def text_width_font_named(text, fnt, font_size):" - ], "cpp": [ "int text_width(const string &text, const string &fnt, int font_size)" ], + "python": [ + "def text_width_font_named(text, fnt, font_size):" + ], "csharp": [ "public static int Text.Width(string text, string fnt, int fontSize);", "public static int SplashKit.TextWidth(string text, string fnt, int fontSize);" @@ -43389,12 +42066,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def text_width(text, fnt, font_size):" - ], "cpp": [ "int text_width(const string &text, font fnt, int font_size)" ], + "python": [ + "def text_width(text, fnt, font_size):" + ], "csharp": [ "public static int Text.Width(string text, Font fnt, int fontSize);", "public static int SplashKit.TextWidth(string text, Font fnt, int fontSize);" @@ -43454,12 +42131,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_triangle_record(clr, tri):" - ], "cpp": [ "void draw_triangle(color clr, const triangle &tri)" ], + "python": [ + "def draw_triangle_record(clr, tri):" + ], "csharp": [ "public static void SplashKit.DrawTriangle(Color clr, Triangle tri);" ], @@ -43531,12 +42208,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_triangle_record_with_options(clr, tri, opts):" - ], "cpp": [ "void draw_triangle(color clr, const triangle &tri, drawing_options opts)" ], + "python": [ + "def draw_triangle_record_with_options(clr, tri, opts):" + ], "csharp": [ "public static void SplashKit.DrawTriangle(Color clr, Triangle tri, DrawingOptions opts);" ], @@ -43659,12 +42336,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_triangle(clr, x1, y1, x2, y2, x3, y3):" - ], "cpp": [ "void draw_triangle(color clr, double x1, double y1, double x2, double y2, double x3, double y3)" ], + "python": [ + "def draw_triangle(clr, x1, y1, x2, y2, x3, y3):" + ], "csharp": [ "public static void SplashKit.DrawTriangle(Color clr, double x1, double y1, double x2, double y2, double x3, double y3);" ], @@ -43801,12 +42478,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_triangle_with_options(clr, x1, y1, x2, y2, x3, y3, opts):" - ], "cpp": [ "void draw_triangle(color clr, double x1, double y1, double x2, double y2, double x3, double y3, drawing_options opts)" ], + "python": [ + "def draw_triangle_with_options(clr, x1, y1, x2, y2, x3, y3, opts):" + ], "csharp": [ "public static void SplashKit.DrawTriangle(Color clr, double x1, double y1, double x2, double y2, double x3, double y3, DrawingOptions opts);" ], @@ -43881,12 +42558,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_triangle_on_bitmap_record(destination, clr, tri):" - ], "cpp": [ "void draw_triangle_on_bitmap(bitmap destination, color clr, const triangle &tri)" ], + "python": [ + "def draw_triangle_on_bitmap_record(destination, clr, tri):" + ], "csharp": [ "public void Bitmap.DrawTriangle(Color clr, Triangle tri);", "public static void SplashKit.DrawTriangleOnBitmap(Bitmap destination, Color clr, Triangle tri);" @@ -43975,12 +42652,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_triangle_on_bitmap_record_with_options(destination, clr, tri, opts):" - ], "cpp": [ "void draw_triangle_on_bitmap(bitmap destination, color clr, const triangle &tri, drawing_options opts)" ], + "python": [ + "def draw_triangle_on_bitmap_record_with_options(destination, clr, tri, opts):" + ], "csharp": [ "public void Bitmap.DrawTriangle(Color clr, Triangle tri, DrawingOptions opts);", "public static void SplashKit.DrawTriangleOnBitmap(Bitmap destination, Color clr, Triangle tri, DrawingOptions opts);" @@ -44120,12 +42797,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_triangle_on_bitmap(destination, clr, x1, y1, x2, y2, x3, y3):" - ], "cpp": [ "void draw_triangle_on_bitmap(bitmap destination, color clr, double x1, double y1, double x2, double y2, double x3, double y3)" ], + "python": [ + "def draw_triangle_on_bitmap(destination, clr, x1, y1, x2, y2, x3, y3):" + ], "csharp": [ "public void Bitmap.DrawTriangle(Color clr, double x1, double y1, double x2, double y2, double x3, double y3);", "public static void SplashKit.DrawTriangleOnBitmap(Bitmap destination, Color clr, double x1, double y1, double x2, double y2, double x3, double y3);" @@ -44279,12 +42956,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_triangle_on_bitmap_with_options(destination, clr, x1, y1, x2, y2, x3, y3, opts):" - ], "cpp": [ "void draw_triangle_on_bitmap(bitmap destination, color clr, double x1, double y1, double x2, double y2, double x3, double y3, drawing_options opts)" ], + "python": [ + "def draw_triangle_on_bitmap_with_options(destination, clr, x1, y1, x2, y2, x3, y3, opts):" + ], "csharp": [ "public void Bitmap.DrawTriangle(Color clr, double x1, double y1, double x2, double y2, double x3, double y3, DrawingOptions opts);", "public static void SplashKit.DrawTriangleOnBitmap(Bitmap destination, Color clr, double x1, double y1, double x2, double y2, double x3, double y3, DrawingOptions opts);" @@ -44360,12 +43037,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_triangle_on_window_record(destination, clr, tri):" - ], "cpp": [ "void draw_triangle_on_window(window destination, color clr, const triangle &tri)" ], + "python": [ + "def draw_triangle_on_window_record(destination, clr, tri):" + ], "csharp": [ "public void Window.DrawTriangle(Color clr, Triangle tri);", "public static void SplashKit.DrawTriangleOnWindow(Window destination, Color clr, Triangle tri);" @@ -44454,12 +43131,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_triangle_on_window_record_with_options(destination, clr, tri, opts):" - ], "cpp": [ "void draw_triangle_on_window(window destination, color clr, const triangle &tri, drawing_options opts)" ], + "python": [ + "def draw_triangle_on_window_record_with_options(destination, clr, tri, opts):" + ], "csharp": [ "public void Window.DrawTriangle(Color clr, Triangle tri, DrawingOptions opts);", "public static void SplashKit.DrawTriangleOnWindow(Window destination, Color clr, Triangle tri, DrawingOptions opts);" @@ -44599,12 +43276,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_triangle_on_window(destination, clr, x1, y1, x2, y2, x3, y3):" - ], "cpp": [ "void draw_triangle_on_window(window destination, color clr, double x1, double y1, double x2, double y2, double x3, double y3)" ], + "python": [ + "def draw_triangle_on_window(destination, clr, x1, y1, x2, y2, x3, y3):" + ], "csharp": [ "public void Window.DrawTriangle(Color clr, double x1, double y1, double x2, double y2, double x3, double y3);", "public static void SplashKit.DrawTriangleOnWindow(Window destination, Color clr, double x1, double y1, double x2, double y2, double x3, double y3);" @@ -44758,12 +43435,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def draw_triangle_on_window_with_options(destination, clr, x1, y1, x2, y2, x3, y3, opts):" - ], "cpp": [ "void draw_triangle_on_window(window destination, color clr, double x1, double y1, double x2, double y2, double x3, double y3, drawing_options opts)" ], + "python": [ + "def draw_triangle_on_window_with_options(destination, clr, x1, y1, x2, y2, x3, y3, opts):" + ], "csharp": [ "public void Window.DrawTriangle(Color clr, double x1, double y1, double x2, double y2, double x3, double y3, DrawingOptions opts);", "public static void SplashKit.DrawTriangleOnWindow(Window destination, Color clr, double x1, double y1, double x2, double y2, double x3, double y3, DrawingOptions opts);" @@ -44823,12 +43500,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def fill_triangle_record(clr, tri):" - ], "cpp": [ "void fill_triangle(color clr, const triangle &tri)" ], + "python": [ + "def fill_triangle_record(clr, tri):" + ], "csharp": [ "public static void SplashKit.FillTriangle(Color clr, Triangle tri);" ], @@ -44900,12 +43577,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def fill_triangle_record_with_options(clr, tri, opts):" - ], "cpp": [ "void fill_triangle(color clr, const triangle &tri, drawing_options opts)" ], + "python": [ + "def fill_triangle_record_with_options(clr, tri, opts):" + ], "csharp": [ "public static void SplashKit.FillTriangle(Color clr, Triangle tri, DrawingOptions opts);" ], @@ -45028,12 +43705,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def fill_triangle(clr, x1, y1, x2, y2, x3, y3):" - ], "cpp": [ "void fill_triangle(color clr, double x1, double y1, double x2, double y2, double x3, double y3)" ], + "python": [ + "def fill_triangle(clr, x1, y1, x2, y2, x3, y3):" + ], "csharp": [ "public static void SplashKit.FillTriangle(Color clr, double x1, double y1, double x2, double y2, double x3, double y3);" ], @@ -45170,12 +43847,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def fill_triangle_with_options(clr, x1, y1, x2, y2, x3, y3, opts):" - ], "cpp": [ "void fill_triangle(color clr, double x1, double y1, double x2, double y2, double x3, double y3, drawing_options opts)" ], + "python": [ + "def fill_triangle_with_options(clr, x1, y1, x2, y2, x3, y3, opts):" + ], "csharp": [ "public static void SplashKit.FillTriangle(Color clr, double x1, double y1, double x2, double y2, double x3, double y3, DrawingOptions opts);" ], @@ -45250,12 +43927,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_triangle_on_bitmap_record(destination, clr, tri):" - ], "cpp": [ "void fill_triangle_on_bitmap(bitmap destination, color clr, const triangle &tri)" ], + "python": [ + "def fill_triangle_on_bitmap_record(destination, clr, tri):" + ], "csharp": [ "public void Bitmap.FillTriangle(Color clr, Triangle tri);", "public static void SplashKit.FillTriangleOnBitmap(Bitmap destination, Color clr, Triangle tri);" @@ -45344,12 +44021,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_triangle_on_bitmap_record_with_options(destination, clr, tri, opts):" - ], "cpp": [ "void fill_triangle_on_bitmap(bitmap destination, color clr, const triangle &tri, drawing_options opts)" ], + "python": [ + "def fill_triangle_on_bitmap_record_with_options(destination, clr, tri, opts):" + ], "csharp": [ "public void Bitmap.FillTriangle(Color clr, Triangle tri, DrawingOptions opts);", "public static void SplashKit.FillTriangleOnBitmap(Bitmap destination, Color clr, Triangle tri, DrawingOptions opts);" @@ -45489,12 +44166,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_triangle_on_bitmap(destination, clr, x1, y1, x2, y2, x3, y3):" - ], "cpp": [ "void fill_triangle_on_bitmap(bitmap destination, color clr, double x1, double y1, double x2, double y2, double x3, double y3)" ], + "python": [ + "def fill_triangle_on_bitmap(destination, clr, x1, y1, x2, y2, x3, y3):" + ], "csharp": [ "public void Bitmap.FillTriangle(Color clr, double x1, double y1, double x2, double y2, double x3, double y3);", "public static void SplashKit.FillTriangleOnBitmap(Bitmap destination, Color clr, double x1, double y1, double x2, double y2, double x3, double y3);" @@ -45648,12 +44325,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_triangle_on_bitmap_with_options(destination, clr, x1, y1, x2, y2, x3, y3, opts):" - ], "cpp": [ "void fill_triangle_on_bitmap(bitmap destination, color clr, double x1, double y1, double x2, double y2, double x3, double y3, drawing_options opts)" ], + "python": [ + "def fill_triangle_on_bitmap_with_options(destination, clr, x1, y1, x2, y2, x3, y3, opts):" + ], "csharp": [ "public void Bitmap.FillTriangle(Color clr, double x1, double y1, double x2, double y2, double x3, double y3, DrawingOptions opts);", "public static void SplashKit.FillTriangleOnBitmap(Bitmap destination, Color clr, double x1, double y1, double x2, double y2, double x3, double y3, DrawingOptions opts);" @@ -45729,12 +44406,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_triangle_on_window_record(destination, clr, tri):" - ], "cpp": [ "void fill_triangle_on_window(window destination, color clr, const triangle &tri)" ], + "python": [ + "def fill_triangle_on_window_record(destination, clr, tri):" + ], "csharp": [ "public void Window.FillTriangle(Color clr, Triangle tri);", "public static void SplashKit.FillTriangleOnWindow(Window destination, Color clr, Triangle tri);" @@ -45823,12 +44500,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_triangle_on_window_record_with_options(destination, clr, tri, opts):" - ], "cpp": [ "void fill_triangle_on_window(window destination, color clr, const triangle &tri, drawing_options opts)" ], + "python": [ + "def fill_triangle_on_window_record_with_options(destination, clr, tri, opts):" + ], "csharp": [ "public void Window.FillTriangle(Color clr, Triangle tri, DrawingOptions opts);", "public static void SplashKit.FillTriangleOnWindow(Window destination, Color clr, Triangle tri, DrawingOptions opts);" @@ -45968,12 +44645,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_triangle_on_window(destination, clr, x1, y1, x2, y2, x3, y3):" - ], "cpp": [ "void fill_triangle_on_window(window destination, color clr, double x1, double y1, double x2, double y2, double x3, double y3)" ], + "python": [ + "def fill_triangle_on_window(destination, clr, x1, y1, x2, y2, x3, y3):" + ], "csharp": [ "public void Window.FillTriangle(Color clr, double x1, double y1, double x2, double y2, double x3, double y3);", "public static void SplashKit.FillTriangleOnWindow(Window destination, Color clr, double x1, double y1, double x2, double y2, double x3, double y3);" @@ -46127,12 +44804,12 @@ "self": "destination" }, "signatures": { - "python": [ - "def fill_triangle_on_window_with_options(destination, clr, x1, y1, x2, y2, x3, y3, opts):" - ], "cpp": [ "void fill_triangle_on_window(window destination, color clr, double x1, double y1, double x2, double y2, double x3, double y3, drawing_options opts)" ], + "python": [ + "def fill_triangle_on_window_with_options(destination, clr, x1, y1, x2, y2, x3, y3, opts):" + ], "csharp": [ "public void Window.FillTriangle(Color clr, double x1, double y1, double x2, double y2, double x3, double y3, DrawingOptions opts);", "public static void SplashKit.FillTriangleOnWindow(Window destination, Color clr, double x1, double y1, double x2, double y2, double x3, double y3, DrawingOptions opts);" @@ -46184,12 +44861,12 @@ "static": "input" }, "signatures": { - "python": [ - "def process_events():" - ], "cpp": [ "void process_events()" ], + "python": [ + "def process_events():" + ], "csharp": [ "public static void SplashKit.ProcessEvents();" ], @@ -46222,12 +44899,12 @@ "static": "input" }, "signatures": { - "python": [ - "def quit_requested():" - ], "cpp": [ "bool quit_requested()" ], + "python": [ + "def quit_requested():" + ], "csharp": [ "public static bool SplashKit.QuitRequested();" ], @@ -46260,12 +44937,12 @@ "static": "input" }, "signatures": { - "python": [ - "def reset_quit():" - ], "cpp": [ "void reset_quit()" ], + "python": [ + "def reset_quit():" + ], "csharp": [ "public static void SplashKit.ResetQuit();" ], @@ -46297,12 +44974,12 @@ "group": "input" }, "signatures": { - "python": [ - "def any_key_pressed():" - ], "cpp": [ "bool any_key_pressed()" ], + "python": [ + "def any_key_pressed():" + ], "csharp": [ "public static bool SplashKit.AnyKeyPressed();" ], @@ -46347,12 +45024,12 @@ "group": "input" }, "signatures": { - "python": [ - "def deregister_callback_on_key_down(callback):" - ], "cpp": [ "void deregister_callback_on_key_down(key_callback *callback)" ], + "python": [ + "def deregister_callback_on_key_down(callback):" + ], "csharp": [ "public static void SplashKit.DeregisterCallbackOnKeyDown(KeyCallback callback);" ], @@ -46397,12 +45074,12 @@ "group": "input" }, "signatures": { - "python": [ - "def deregister_callback_on_key_typed(callback):" - ], "cpp": [ "void deregister_callback_on_key_typed(key_callback *callback)" ], + "python": [ + "def deregister_callback_on_key_typed(callback):" + ], "csharp": [ "public static void SplashKit.DeregisterCallbackOnKeyTyped(KeyCallback callback);" ], @@ -46447,12 +45124,12 @@ "group": "input" }, "signatures": { - "python": [ - "def deregister_callback_on_key_up(callback):" - ], "cpp": [ "void deregister_callback_on_key_up(key_callback *callback)" ], + "python": [ + "def deregister_callback_on_key_up(callback):" + ], "csharp": [ "public static void SplashKit.DeregisterCallbackOnKeyUp(KeyCallback callback);" ], @@ -46497,12 +45174,12 @@ "group": "input" }, "signatures": { - "python": [ - "def key_down(key):" - ], "cpp": [ "bool key_down(key_code key)" ], + "python": [ + "def key_down(key):" + ], "csharp": [ "public static bool SplashKit.KeyDown(KeyCode key);" ], @@ -46547,12 +45224,12 @@ "group": "input" }, "signatures": { - "python": [ - "def key_name(key):" - ], "cpp": [ "string key_name(key_code key)" ], + "python": [ + "def key_name(key):" + ], "csharp": [ "public static string SplashKit.KeyName(KeyCode key);" ], @@ -46597,12 +45274,12 @@ "group": "input" }, "signatures": { - "python": [ - "def key_released(key):" - ], "cpp": [ "bool key_released(key_code key)" ], + "python": [ + "def key_released(key):" + ], "csharp": [ "public static bool SplashKit.KeyReleased(KeyCode key);" ], @@ -46647,12 +45324,12 @@ "group": "input" }, "signatures": { - "python": [ - "def key_typed(key):" - ], "cpp": [ "bool key_typed(key_code key)" ], + "python": [ + "def key_typed(key):" + ], "csharp": [ "public static bool SplashKit.KeyTyped(KeyCode key);" ], @@ -46697,12 +45374,12 @@ "group": "input" }, "signatures": { - "python": [ - "def key_up(key):" - ], "cpp": [ "bool key_up(key_code key)" ], + "python": [ + "def key_up(key):" + ], "csharp": [ "public static bool SplashKit.KeyUp(KeyCode key);" ], @@ -46747,12 +45424,12 @@ "group": "input" }, "signatures": { - "python": [ - "def register_callback_on_key_down(callback):" - ], "cpp": [ "void register_callback_on_key_down(key_callback *callback)" ], + "python": [ + "def register_callback_on_key_down(callback):" + ], "csharp": [ "public static void SplashKit.RegisterCallbackOnKeyDown(KeyCallback callback);" ], @@ -46797,12 +45474,12 @@ "group": "input" }, "signatures": { - "python": [ - "def register_callback_on_key_typed(callback):" - ], "cpp": [ "void register_callback_on_key_typed(key_callback *callback)" ], + "python": [ + "def register_callback_on_key_typed(callback):" + ], "csharp": [ "public static void SplashKit.RegisterCallbackOnKeyTyped(KeyCallback callback);" ], @@ -46847,12 +45524,12 @@ "group": "input" }, "signatures": { - "python": [ - "def register_callback_on_key_up(callback):" - ], "cpp": [ "void register_callback_on_key_up(key_callback *callback)" ], + "python": [ + "def register_callback_on_key_up(callback):" + ], "csharp": [ "public static void SplashKit.RegisterCallbackOnKeyUp(KeyCallback callback);" ], @@ -46884,12 +45561,12 @@ "group": "input" }, "signatures": { - "python": [ - "def hide_mouse():" - ], "cpp": [ "void hide_mouse()" ], + "python": [ + "def hide_mouse():" + ], "csharp": [ "public static void SplashKit.HideMouse();" ], @@ -46934,12 +45611,12 @@ "group": "input" }, "signatures": { - "python": [ - "def mouse_clicked(button):" - ], "cpp": [ "bool mouse_clicked(mouse_button button)" ], + "python": [ + "def mouse_clicked(button):" + ], "csharp": [ "public static bool SplashKit.MouseClicked(MouseButton button);" ], @@ -46984,12 +45661,12 @@ "group": "input" }, "signatures": { - "python": [ - "def mouse_down(button):" - ], "cpp": [ "bool mouse_down(mouse_button button)" ], + "python": [ + "def mouse_down(button):" + ], "csharp": [ "public static bool SplashKit.MouseDown(MouseButton button);" ], @@ -47021,12 +45698,12 @@ "group": "input" }, "signatures": { - "python": [ - "def mouse_movement():" - ], "cpp": [ "vector_2d mouse_movement()" ], + "python": [ + "def mouse_movement():" + ], "csharp": [ "public static Vector2D SplashKit.MouseMovement();" ], @@ -47058,12 +45735,12 @@ "group": "input" }, "signatures": { - "python": [ - "def mouse_position():" - ], "cpp": [ "point_2d mouse_position()" ], + "python": [ + "def mouse_position():" + ], "csharp": [ "public static Point2D SplashKit.MousePosition();" ], @@ -47095,12 +45772,12 @@ "group": "input" }, "signatures": { - "python": [ - "def mouse_position_vector():" - ], "cpp": [ "vector_2d mouse_position_vector()" ], + "python": [ + "def mouse_position_vector():" + ], "csharp": [ "public static Vector2D SplashKit.MousePositionVector();" ], @@ -47132,12 +45809,12 @@ "group": "input" }, "signatures": { - "python": [ - "def mouse_shown():" - ], "cpp": [ "bool mouse_shown()" ], + "python": [ + "def mouse_shown():" + ], "csharp": [ "public static bool SplashKit.MouseShown();" ], @@ -47182,12 +45859,12 @@ "group": "input" }, "signatures": { - "python": [ - "def mouse_up(button):" - ], "cpp": [ "bool mouse_up(mouse_button button)" ], + "python": [ + "def mouse_up(button):" + ], "csharp": [ "public static bool SplashKit.MouseUp(MouseButton button);" ], @@ -47219,12 +45896,12 @@ "group": "input" }, "signatures": { - "python": [ - "def mouse_wheel_scroll():" - ], "cpp": [ "vector_2d mouse_wheel_scroll()" ], + "python": [ + "def mouse_wheel_scroll():" + ], "csharp": [ "public static Vector2D SplashKit.MouseWheelScroll();" ], @@ -47256,12 +45933,12 @@ "group": "input" }, "signatures": { - "python": [ - "def mouse_x():" - ], "cpp": [ "float mouse_x()" ], + "python": [ + "def mouse_x():" + ], "csharp": [ "public static float SplashKit.MouseX();" ], @@ -47293,12 +45970,12 @@ "group": "input" }, "signatures": { - "python": [ - "def mouse_y():" - ], "cpp": [ "float mouse_y()" ], + "python": [ + "def mouse_y():" + ], "csharp": [ "public static float SplashKit.MouseY();" ], @@ -47356,12 +46033,12 @@ "group": "input" }, "signatures": { - "python": [ - "def move_mouse(x, y):" - ], "cpp": [ "void move_mouse(double x, double y)" ], + "python": [ + "def move_mouse(x, y):" + ], "csharp": [ "public static void SplashKit.MoveMouse(double x, double y);" ], @@ -47407,12 +46084,12 @@ "group": "input" }, "signatures": { - "python": [ - "def move_mouse_to_point(point):" - ], "cpp": [ "void move_mouse(point_2d point)" ], + "python": [ + "def move_mouse_to_point(point):" + ], "csharp": [ "public static void SplashKit.MoveMouse(Point2D point);" ], @@ -47444,12 +46121,12 @@ "group": "input" }, "signatures": { - "python": [ - "def show_mouse():" - ], "cpp": [ "void show_mouse()" ], + "python": [ + "def show_mouse():" + ], "csharp": [ "public static void SplashKit.ShowMouse();" ], @@ -47495,12 +46172,12 @@ "group": "input" }, "signatures": { - "python": [ - "def show_mouse_with_boolean(show):" - ], "cpp": [ "void show_mouse(bool show)" ], + "python": [ + "def show_mouse_with_boolean(show):" + ], "csharp": [ "public static void SplashKit.ShowMouse(bool show);" ], @@ -47584,12 +46261,12 @@ "group": "input" }, "signatures": { - "python": [ - "def draw_collected_text(clr, fnt, font_size, opts):" - ], "cpp": [ "void draw_collected_text(color clr, font fnt, int font_size, const drawing_options &opts)" ], + "python": [ + "def draw_collected_text(clr, fnt, font_size, opts):" + ], "csharp": [ "public static void SplashKit.DrawCollectedText(Color clr, Font fnt, int fontSize, DrawingOptions opts);" ], @@ -47621,12 +46298,12 @@ "group": "input" }, "signatures": { - "python": [ - "def end_reading_text():" - ], "cpp": [ "void end_reading_text()" ], + "python": [ + "def end_reading_text():" + ], "csharp": [ "public static void SplashKit.EndReadingText();" ], @@ -47638,9 +46315,9 @@ { "signature": "void end_reading_text(window wind);", "name": "end_reading_text", - "method_name": "end_reading_text", + "method_name": null, "unique_global_name": "end_reading_text_in_window", - "unique_method_name": "window.end_reading_text_in_window", + "unique_method_name": null, "suffix_name": null, "description": "Ends reading text for the passed in window.", "brief": null, @@ -47668,21 +46345,17 @@ } }, "attributes": { - "class": "window", - "method": "end_reading_text", - "self": "wind", "suffix": "in_window", "group": "input" }, "signatures": { - "python": [ - "def end_reading_text_in_window(wind):" - ], "cpp": [ "void end_reading_text(window wind)" ], + "python": [ + "def end_reading_text_in_window(wind):" + ], "csharp": [ - "public void Window.EndReadingText();", "public static void SplashKit.EndReadingText(Window wind);" ], "pascal": [ @@ -47713,12 +46386,12 @@ "group": "input" }, "signatures": { - "python": [ - "def reading_text():" - ], "cpp": [ "bool reading_text()" ], + "python": [ + "def reading_text():" + ], "csharp": [ "public static bool SplashKit.ReadingText();" ], @@ -47730,9 +46403,9 @@ { "signature": "bool reading_text(window wind);", "name": "reading_text", - "method_name": "reading_text", + "method_name": null, "unique_global_name": "reading_text_in_window", - "unique_method_name": "window.reading_text_in_window", + "unique_method_name": null, "suffix_name": null, "description": "Returns true when the window is reading text.", "brief": null, @@ -47760,21 +46433,17 @@ } }, "attributes": { - "class": "window", - "method": "reading_text", - "self": "wind", "suffix": "in_window", "group": "input" }, "signatures": { - "python": [ - "def reading_text_in_window(wind):" - ], "cpp": [ "bool reading_text(window wind)" ], + "python": [ + "def reading_text_in_window(wind):" + ], "csharp": [ - "public bool Window.ReadingText();", "public static bool SplashKit.ReadingText(Window wind);" ], "pascal": [ @@ -47818,12 +46487,12 @@ "group": "input" }, "signatures": { - "python": [ - "def start_reading_text(rect):" - ], "cpp": [ "void start_reading_text(rectangle rect)" ], + "python": [ + "def start_reading_text(rect):" + ], "csharp": [ "public static void SplashKit.StartReadingText(Rectangle rect);" ], @@ -47882,12 +46551,12 @@ "group": "input" }, "signatures": { - "python": [ - "def start_reading_text_with_initial_text(rect, initial_text):" - ], "cpp": [ "void start_reading_text(rectangle rect, string initial_text)" ], + "python": [ + "def start_reading_text_with_initial_text(rect, initial_text):" + ], "csharp": [ "public static void SplashKit.StartReadingText(Rectangle rect, string initialText);" ], @@ -47899,9 +46568,9 @@ { "signature": "void start_reading_text(window wind,rectangle rect);", "name": "start_reading_text", - "method_name": "start_reading_text", + "method_name": null, "unique_global_name": "start_reading_text_in_window", - "unique_method_name": "window.start_reading_text_in_window", + "unique_method_name": null, "suffix_name": null, "description": "Start reading text in the window within the bounds of the\nsupplied rectangle.", "brief": null, @@ -47942,21 +46611,17 @@ } }, "attributes": { - "class": "window", - "method": "start_reading_text", - "self": "wind", "suffix": "in_window", "group": "input" }, "signatures": { - "python": [ - "def start_reading_text_in_window(wind, rect):" - ], "cpp": [ "void start_reading_text(window wind, rectangle rect)" ], + "python": [ + "def start_reading_text_in_window(wind, rect):" + ], "csharp": [ - "public void Window.StartReadingText(Rectangle rect);", "public static void SplashKit.StartReadingText(Window wind, Rectangle rect);" ], "pascal": [ @@ -47967,9 +46632,9 @@ { "signature": "void start_reading_text(window wind,rectangle rect,string initial_text);", "name": "start_reading_text", - "method_name": "start_reading_text", + "method_name": null, "unique_global_name": "start_reading_text_in_window_with_initial_text", - "unique_method_name": "window.start_reading_text_in_window_with_initial_text", + "unique_method_name": null, "suffix_name": null, "description": "Start reading text in the window within the bounds of the\nsupplied rectangle. The text will start with an initial value.", "brief": null, @@ -48023,21 +46688,17 @@ } }, "attributes": { - "class": "window", - "method": "start_reading_text", - "self": "wind", "suffix": "in_window_with_initial_text", "group": "input" }, "signatures": { - "python": [ - "def start_reading_text_in_window_with_initial_text(wind, rect, initial_text):" - ], "cpp": [ "void start_reading_text(window wind, rectangle rect, string initial_text)" ], + "python": [ + "def start_reading_text_in_window_with_initial_text(wind, rect, initial_text):" + ], "csharp": [ - "public void Window.StartReadingText(Rectangle rect, string initialText);", "public static void SplashKit.StartReadingText(Window wind, Rectangle rect, string initialText);" ], "pascal": [ @@ -48068,12 +46729,12 @@ "group": "input" }, "signatures": { - "python": [ - "def text_entry_cancelled():" - ], "cpp": [ "bool text_entry_cancelled()" ], + "python": [ + "def text_entry_cancelled():" + ], "csharp": [ "public static bool SplashKit.TextEntryCancelled();" ], @@ -48085,9 +46746,9 @@ { "signature": "bool text_entry_cancelled(window wind);", "name": "text_entry_cancelled", - "method_name": "text_entry_cancelled", + "method_name": null, "unique_global_name": "text_entry_cancelled_in_window", - "unique_method_name": "window.text_entry_cancelled_in_window", + "unique_method_name": null, "suffix_name": null, "description": "Did the user press escape and cancel the enterring of text?", "brief": null, @@ -48115,21 +46776,17 @@ } }, "attributes": { - "class": "window", - "method": "text_entry_cancelled", - "self": "wind", "suffix": "in_window", "group": "input" }, "signatures": { - "python": [ - "def text_entry_cancelled_in_window(wind):" - ], "cpp": [ "bool text_entry_cancelled(window wind)" ], + "python": [ + "def text_entry_cancelled_in_window(wind):" + ], "csharp": [ - "public bool Window.TextEntryCancelled();", "public static bool SplashKit.TextEntryCancelled(Window wind);" ], "pascal": [ @@ -48160,12 +46817,12 @@ "group": "input" }, "signatures": { - "python": [ - "def text_input():" - ], "cpp": [ "string text_input()" ], + "python": [ + "def text_input():" + ], "csharp": [ "public static string SplashKit.TextInput();" ], @@ -48177,9 +46834,9 @@ { "signature": "string text_input(window wind);", "name": "text_input", - "method_name": "text_input", + "method_name": null, "unique_global_name": "text_input_in_window", - "unique_method_name": "window.text_input_in_window", + "unique_method_name": null, "suffix_name": null, "description": "The text the user has currently enterred on the current window.", "brief": null, @@ -48207,21 +46864,17 @@ } }, "attributes": { - "class": "window", - "method": "text_input", - "self": "wind", "suffix": "in_window", "group": "input" }, "signatures": { - "python": [ - "def text_input_in_window(wind):" - ], "cpp": [ "string text_input(window wind)" ], + "python": [ + "def text_input_in_window(wind):" + ], "csharp": [ - "public string Window.TextInput();", "public static string SplashKit.TextInput(Window wind);" ], "pascal": [ @@ -48796,8 +47449,8 @@ "group": "input" }, "signatures": { - "python": "public enum {KeyCode.unknown_key = 0, KeyCode.backspace_key = 8, KeyCode.tab_key = 9, KeyCode.clear_key = 12, KeyCode.return_key = 13, KeyCode.pause_key = 19, KeyCode.escape_key = 27, KeyCode.space_key = 32, KeyCode.exclaim_key = 33, KeyCode.double_quote_key = 34, KeyCode.hash_key = 35, KeyCode.dollar_key = 36, KeyCode.ampersand_key = 38, KeyCode.quote_key = 39, KeyCode.left_paren_key = 40, KeyCode.right_paren_key = 41, KeyCode.asterisk_key = 42, KeyCode.plus_key = 43, KeyCode.comma_key = 44, KeyCode.minus_key = 45, KeyCode.period_key = 46, KeyCode.slash_key = 47, KeyCode.num_0_key = 48, KeyCode.num_1_key = 49, KeyCode.num_2_key = 50, KeyCode.num_3_key = 51, KeyCode.num_4_key = 52, KeyCode.num_5_key = 53, KeyCode.num_6_key = 54, KeyCode.num_7_key = 55, KeyCode.num_8_key = 56, KeyCode.num_9_key = 57, KeyCode.colon_key = 58, KeyCode.semi_colon_key = 59, KeyCode.less_key = 60, KeyCode.equals_key = 61, KeyCode.greater_key = 62, KeyCode.question_key = 63, KeyCode.at_key = 64, KeyCode.left_bracket_key = 91, KeyCode.backslash_key = 92, KeyCode.right_bracket_key = 93, KeyCode.caret_key = 94, KeyCode.underscore_key = 95, KeyCode.backquote_key = 96, KeyCode.a_key = 97, KeyCode.b_key = 98, KeyCode.c_key = 99, KeyCode.d_key = 100, KeyCode.e_key = 101, KeyCode.f_key = 102, KeyCode.g_key = 103, KeyCode.h_key = 104, KeyCode.i_key = 105, KeyCode.j_key = 106, KeyCode.k_key = 107, KeyCode.l_key = 108, KeyCode.m_key = 109, KeyCode.n_key = 110, KeyCode.o_key = 111, KeyCode.p_key = 112, KeyCode.q_key = 113, KeyCode.r_key = 114, KeyCode.s_key = 115, KeyCode.t_key = 116, KeyCode.u_key = 117, KeyCode.v_key = 118, KeyCode.w_key = 119, KeyCode.x_key = 120, KeyCode.y_key = 121, KeyCode.z_key = 122, KeyCode.delete_key = 127, KeyCode.keypad_0 = 256, KeyCode.keypad_1 = 257, KeyCode.keypad_2 = 258, KeyCode.keypad_3 = 259, KeyCode.keypad_4 = 260, KeyCode.keypad_5 = 261, KeyCode.keypad_6 = 262, KeyCode.keypad_7 = 263, KeyCode.keypad_8 = 264, KeyCode.keypad_9 = 265, KeyCode.keypad_period = 266, KeyCode.keypad_divide = 267, KeyCode.keypad_multiply = 268, KeyCode.keypad_minus = 269, KeyCode.keypad_plus = 270, KeyCode.keypad_enter = 271, KeyCode.keypad_equals = 272, KeyCode.up_key = 273, KeyCode.down_key = 274, KeyCode.right_key = 275, KeyCode.left_key = 276, KeyCode.insert_key = 277, KeyCode.home_key = 278, KeyCode.end_key = 279, KeyCode.page_up_key = 280, KeyCode.page_down_key = 281, KeyCode.f1_key = 282, KeyCode.f2_key = 283, KeyCode.f3_key = 284, KeyCode.f4_key = 285, KeyCode.f5_key = 286, KeyCode.f6_key = 287, KeyCode.f7_key = 288, KeyCode.f8_key = 289, KeyCode.f9_key = 290, KeyCode.f10_key = 291, KeyCode.f11_key = 292, KeyCode.f12_key = 293, KeyCode.f13_key = 294, KeyCode.f14_key = 295, KeyCode.f15_key = 296, KeyCode.num_lock_key = 300, KeyCode.caps_lock_key = 301, KeyCode.scroll_lock_key = 302, KeyCode.right_shift_key = 303, KeyCode.left_shift_key = 304, KeyCode.right_ctrl_key = 305, KeyCode.left_ctrl_key = 306, KeyCode.right_alt_key = 307, KeyCode.left_alt_key = 308, KeyCode.left_super_key = 311, KeyCode.right_super_key = 312, KeyCode.mode_key = 313, KeyCode.help_key = 315, KeyCode.sys_req_key = 317, KeyCode.menu_key = 319, KeyCode.power_key = 320}", "cpp": "class key_code {UNKNOWN_KEY = 0, BACKSPACE_KEY = 8, TAB_KEY = 9, CLEAR_KEY = 12, RETURN_KEY = 13, PAUSE_KEY = 19, ESCAPE_KEY = 27, SPACE_KEY = 32, EXCLAIM_KEY = 33, DOUBLE_QUOTE_KEY = 34, HASH_KEY = 35, DOLLAR_KEY = 36, AMPERSAND_KEY = 38, QUOTE_KEY = 39, LEFT_PAREN_KEY = 40, RIGHT_PAREN_KEY = 41, ASTERISK_KEY = 42, PLUS_KEY = 43, COMMA_KEY = 44, MINUS_KEY = 45, PERIOD_KEY = 46, SLASH_KEY = 47, NUM_0_KEY = 48, NUM_1_KEY = 49, NUM_2_KEY = 50, NUM_3_KEY = 51, NUM_4_KEY = 52, NUM_5_KEY = 53, NUM_6_KEY = 54, NUM_7_KEY = 55, NUM_8_KEY = 56, NUM_9_KEY = 57, COLON_KEY = 58, SEMI_COLON_KEY = 59, LESS_KEY = 60, EQUALS_KEY = 61, GREATER_KEY = 62, QUESTION_KEY = 63, AT_KEY = 64, LEFT_BRACKET_KEY = 91, BACKSLASH_KEY = 92, RIGHT_BRACKET_KEY = 93, CARET_KEY = 94, UNDERSCORE_KEY = 95, BACKQUOTE_KEY = 96, A_KEY = 97, B_KEY = 98, C_KEY = 99, D_KEY = 100, E_KEY = 101, F_KEY = 102, G_KEY = 103, H_KEY = 104, I_KEY = 105, J_KEY = 106, K_KEY = 107, L_KEY = 108, M_KEY = 109, N_KEY = 110, O_KEY = 111, P_KEY = 112, Q_KEY = 113, R_KEY = 114, S_KEY = 115, T_KEY = 116, U_KEY = 117, V_KEY = 118, W_KEY = 119, X_KEY = 120, Y_KEY = 121, Z_KEY = 122, DELETE_KEY = 127, KEYPAD_0 = 256, KEYPAD_1 = 257, KEYPAD_2 = 258, KEYPAD_3 = 259, KEYPAD_4 = 260, KEYPAD_5 = 261, KEYPAD_6 = 262, KEYPAD_7 = 263, KEYPAD_8 = 264, KEYPAD_9 = 265, KEYPAD_PERIOD = 266, KEYPAD_DIVIDE = 267, KEYPAD_MULTIPLY = 268, KEYPAD_MINUS = 269, KEYPAD_PLUS = 270, KEYPAD_ENTER = 271, KEYPAD_EQUALS = 272, UP_KEY = 273, DOWN_KEY = 274, RIGHT_KEY = 275, LEFT_KEY = 276, INSERT_KEY = 277, HOME_KEY = 278, END_KEY = 279, PAGE_UP_KEY = 280, PAGE_DOWN_KEY = 281, F1_KEY = 282, F2_KEY = 283, F3_KEY = 284, F4_KEY = 285, F5_KEY = 286, F6_KEY = 287, F7_KEY = 288, F8_KEY = 289, F9_KEY = 290, F10_KEY = 291, F11_KEY = 292, F12_KEY = 293, F13_KEY = 294, F14_KEY = 295, F15_KEY = 296, NUM_LOCK_KEY = 300, CAPS_LOCK_KEY = 301, SCROLL_LOCK_KEY = 302, RIGHT_SHIFT_KEY = 303, LEFT_SHIFT_KEY = 304, RIGHT_CTRL_KEY = 305, LEFT_CTRL_KEY = 306, RIGHT_ALT_KEY = 307, LEFT_ALT_KEY = 308, LEFT_SUPER_KEY = 311, RIGHT_SUPER_KEY = 312, MODE_KEY = 313, HELP_KEY = 315, SYS_REQ_KEY = 317, MENU_KEY = 319, POWER_KEY = 320};", + "python": "public enum {KeyCode.unknown_key = 0, KeyCode.backspace_key = 8, KeyCode.tab_key = 9, KeyCode.clear_key = 12, KeyCode.return_key = 13, KeyCode.pause_key = 19, KeyCode.escape_key = 27, KeyCode.space_key = 32, KeyCode.exclaim_key = 33, KeyCode.double_quote_key = 34, KeyCode.hash_key = 35, KeyCode.dollar_key = 36, KeyCode.ampersand_key = 38, KeyCode.quote_key = 39, KeyCode.left_paren_key = 40, KeyCode.right_paren_key = 41, KeyCode.asterisk_key = 42, KeyCode.plus_key = 43, KeyCode.comma_key = 44, KeyCode.minus_key = 45, KeyCode.period_key = 46, KeyCode.slash_key = 47, KeyCode.num_0_key = 48, KeyCode.num_1_key = 49, KeyCode.num_2_key = 50, KeyCode.num_3_key = 51, KeyCode.num_4_key = 52, KeyCode.num_5_key = 53, KeyCode.num_6_key = 54, KeyCode.num_7_key = 55, KeyCode.num_8_key = 56, KeyCode.num_9_key = 57, KeyCode.colon_key = 58, KeyCode.semi_colon_key = 59, KeyCode.less_key = 60, KeyCode.equals_key = 61, KeyCode.greater_key = 62, KeyCode.question_key = 63, KeyCode.at_key = 64, KeyCode.left_bracket_key = 91, KeyCode.backslash_key = 92, KeyCode.right_bracket_key = 93, KeyCode.caret_key = 94, KeyCode.underscore_key = 95, KeyCode.backquote_key = 96, KeyCode.a_key = 97, KeyCode.b_key = 98, KeyCode.c_key = 99, KeyCode.d_key = 100, KeyCode.e_key = 101, KeyCode.f_key = 102, KeyCode.g_key = 103, KeyCode.h_key = 104, KeyCode.i_key = 105, KeyCode.j_key = 106, KeyCode.k_key = 107, KeyCode.l_key = 108, KeyCode.m_key = 109, KeyCode.n_key = 110, KeyCode.o_key = 111, KeyCode.p_key = 112, KeyCode.q_key = 113, KeyCode.r_key = 114, KeyCode.s_key = 115, KeyCode.t_key = 116, KeyCode.u_key = 117, KeyCode.v_key = 118, KeyCode.w_key = 119, KeyCode.x_key = 120, KeyCode.y_key = 121, KeyCode.z_key = 122, KeyCode.delete_key = 127, KeyCode.keypad_0 = 256, KeyCode.keypad_1 = 257, KeyCode.keypad_2 = 258, KeyCode.keypad_3 = 259, KeyCode.keypad_4 = 260, KeyCode.keypad_5 = 261, KeyCode.keypad_6 = 262, KeyCode.keypad_7 = 263, KeyCode.keypad_8 = 264, KeyCode.keypad_9 = 265, KeyCode.keypad_period = 266, KeyCode.keypad_divide = 267, KeyCode.keypad_multiply = 268, KeyCode.keypad_minus = 269, KeyCode.keypad_plus = 270, KeyCode.keypad_enter = 271, KeyCode.keypad_equals = 272, KeyCode.up_key = 273, KeyCode.down_key = 274, KeyCode.right_key = 275, KeyCode.left_key = 276, KeyCode.insert_key = 277, KeyCode.home_key = 278, KeyCode.end_key = 279, KeyCode.page_up_key = 280, KeyCode.page_down_key = 281, KeyCode.f1_key = 282, KeyCode.f2_key = 283, KeyCode.f3_key = 284, KeyCode.f4_key = 285, KeyCode.f5_key = 286, KeyCode.f6_key = 287, KeyCode.f7_key = 288, KeyCode.f8_key = 289, KeyCode.f9_key = 290, KeyCode.f10_key = 291, KeyCode.f11_key = 292, KeyCode.f12_key = 293, KeyCode.f13_key = 294, KeyCode.f14_key = 295, KeyCode.f15_key = 296, KeyCode.num_lock_key = 300, KeyCode.caps_lock_key = 301, KeyCode.scroll_lock_key = 302, KeyCode.right_shift_key = 303, KeyCode.left_shift_key = 304, KeyCode.right_ctrl_key = 305, KeyCode.left_ctrl_key = 306, KeyCode.right_alt_key = 307, KeyCode.left_alt_key = 308, KeyCode.left_super_key = 311, KeyCode.right_super_key = 312, KeyCode.mode_key = 313, KeyCode.help_key = 315, KeyCode.sys_req_key = 317, KeyCode.menu_key = 319, KeyCode.power_key = 320}", "csharp": "public enum {KeyCode.UnknownKey = 0, KeyCode.BackspaceKey = 8, KeyCode.TabKey = 9, KeyCode.ClearKey = 12, KeyCode.ReturnKey = 13, KeyCode.PauseKey = 19, KeyCode.EscapeKey = 27, KeyCode.SpaceKey = 32, KeyCode.ExclaimKey = 33, KeyCode.DoubleQuoteKey = 34, KeyCode.HashKey = 35, KeyCode.DollarKey = 36, KeyCode.AmpersandKey = 38, KeyCode.QuoteKey = 39, KeyCode.LeftParenKey = 40, KeyCode.RightParenKey = 41, KeyCode.AsteriskKey = 42, KeyCode.PlusKey = 43, KeyCode.CommaKey = 44, KeyCode.MinusKey = 45, KeyCode.PeriodKey = 46, KeyCode.SlashKey = 47, KeyCode.Num0Key = 48, KeyCode.Num1Key = 49, KeyCode.Num2Key = 50, KeyCode.Num3Key = 51, KeyCode.Num4Key = 52, KeyCode.Num5Key = 53, KeyCode.Num6Key = 54, KeyCode.Num7Key = 55, KeyCode.Num8Key = 56, KeyCode.Num9Key = 57, KeyCode.ColonKey = 58, KeyCode.SemiColonKey = 59, KeyCode.LessKey = 60, KeyCode.EqualsKey = 61, KeyCode.GreaterKey = 62, KeyCode.QuestionKey = 63, KeyCode.AtKey = 64, KeyCode.LeftBracketKey = 91, KeyCode.BackslashKey = 92, KeyCode.RightBracketKey = 93, KeyCode.CaretKey = 94, KeyCode.UnderscoreKey = 95, KeyCode.BackquoteKey = 96, KeyCode.AKey = 97, KeyCode.BKey = 98, KeyCode.CKey = 99, KeyCode.DKey = 100, KeyCode.EKey = 101, KeyCode.FKey = 102, KeyCode.GKey = 103, KeyCode.HKey = 104, KeyCode.IKey = 105, KeyCode.JKey = 106, KeyCode.KKey = 107, KeyCode.LKey = 108, KeyCode.MKey = 109, KeyCode.NKey = 110, KeyCode.OKey = 111, KeyCode.PKey = 112, KeyCode.QKey = 113, KeyCode.RKey = 114, KeyCode.SKey = 115, KeyCode.TKey = 116, KeyCode.UKey = 117, KeyCode.VKey = 118, KeyCode.WKey = 119, KeyCode.XKey = 120, KeyCode.YKey = 121, KeyCode.ZKey = 122, KeyCode.DeleteKey = 127, KeyCode.Keypad0 = 256, KeyCode.Keypad1 = 257, KeyCode.Keypad2 = 258, KeyCode.Keypad3 = 259, KeyCode.Keypad4 = 260, KeyCode.Keypad5 = 261, KeyCode.Keypad6 = 262, KeyCode.Keypad7 = 263, KeyCode.Keypad8 = 264, KeyCode.Keypad9 = 265, KeyCode.KeypadPeriod = 266, KeyCode.KeypadDivide = 267, KeyCode.KeypadMultiply = 268, KeyCode.KeypadMinus = 269, KeyCode.KeypadPlus = 270, KeyCode.KeypadEnter = 271, KeyCode.KeypadEquals = 272, KeyCode.UpKey = 273, KeyCode.DownKey = 274, KeyCode.RightKey = 275, KeyCode.LeftKey = 276, KeyCode.InsertKey = 277, KeyCode.HomeKey = 278, KeyCode.EndKey = 279, KeyCode.PageUpKey = 280, KeyCode.PageDownKey = 281, KeyCode.F1Key = 282, KeyCode.F2Key = 283, KeyCode.F3Key = 284, KeyCode.F4Key = 285, KeyCode.F5Key = 286, KeyCode.F6Key = 287, KeyCode.F7Key = 288, KeyCode.F8Key = 289, KeyCode.F9Key = 290, KeyCode.F10Key = 291, KeyCode.F11Key = 292, KeyCode.F12Key = 293, KeyCode.F13Key = 294, KeyCode.F14Key = 295, KeyCode.F15Key = 296, KeyCode.NumLockKey = 300, KeyCode.CapsLockKey = 301, KeyCode.ScrollLockKey = 302, KeyCode.RightShiftKey = 303, KeyCode.LeftShiftKey = 304, KeyCode.RightCtrlKey = 305, KeyCode.LeftCtrlKey = 306, KeyCode.RightAltKey = 307, KeyCode.LeftAltKey = 308, KeyCode.LeftSuperKey = 311, KeyCode.RightSuperKey = 312, KeyCode.ModeKey = 313, KeyCode.HelpKey = 315, KeyCode.SysReqKey = 317, KeyCode.MenuKey = 319, KeyCode.PowerKey = 320}", "pascal": "public enum {KeyCode.UnknownKey = 0, KeyCode.BackspaceKey = 8, KeyCode.TabKey = 9, KeyCode.ClearKey = 12, KeyCode.ReturnKey = 13, KeyCode.PauseKey = 19, KeyCode.EscapeKey = 27, KeyCode.SpaceKey = 32, KeyCode.ExclaimKey = 33, KeyCode.DoubleQuoteKey = 34, KeyCode.HashKey = 35, KeyCode.DollarKey = 36, KeyCode.AmpersandKey = 38, KeyCode.QuoteKey = 39, KeyCode.LeftParenKey = 40, KeyCode.RightParenKey = 41, KeyCode.AsteriskKey = 42, KeyCode.PlusKey = 43, KeyCode.CommaKey = 44, KeyCode.MinusKey = 45, KeyCode.PeriodKey = 46, KeyCode.SlashKey = 47, KeyCode.Num0Key = 48, KeyCode.Num1Key = 49, KeyCode.Num2Key = 50, KeyCode.Num3Key = 51, KeyCode.Num4Key = 52, KeyCode.Num5Key = 53, KeyCode.Num6Key = 54, KeyCode.Num7Key = 55, KeyCode.Num8Key = 56, KeyCode.Num9Key = 57, KeyCode.ColonKey = 58, KeyCode.SemiColonKey = 59, KeyCode.LessKey = 60, KeyCode.EqualsKey = 61, KeyCode.GreaterKey = 62, KeyCode.QuestionKey = 63, KeyCode.AtKey = 64, KeyCode.LeftBracketKey = 91, KeyCode.BackslashKey = 92, KeyCode.RightBracketKey = 93, KeyCode.CaretKey = 94, KeyCode.UnderscoreKey = 95, KeyCode.BackquoteKey = 96, KeyCode.AKey = 97, KeyCode.BKey = 98, KeyCode.CKey = 99, KeyCode.DKey = 100, KeyCode.EKey = 101, KeyCode.FKey = 102, KeyCode.GKey = 103, KeyCode.HKey = 104, KeyCode.IKey = 105, KeyCode.JKey = 106, KeyCode.KKey = 107, KeyCode.LKey = 108, KeyCode.MKey = 109, KeyCode.NKey = 110, KeyCode.OKey = 111, KeyCode.PKey = 112, KeyCode.QKey = 113, KeyCode.RKey = 114, KeyCode.SKey = 115, KeyCode.TKey = 116, KeyCode.UKey = 117, KeyCode.VKey = 118, KeyCode.WKey = 119, KeyCode.XKey = 120, KeyCode.YKey = 121, KeyCode.ZKey = 122, KeyCode.DeleteKey = 127, KeyCode.Keypad0 = 256, KeyCode.Keypad1 = 257, KeyCode.Keypad2 = 258, KeyCode.Keypad3 = 259, KeyCode.Keypad4 = 260, KeyCode.Keypad5 = 261, KeyCode.Keypad6 = 262, KeyCode.Keypad7 = 263, KeyCode.Keypad8 = 264, KeyCode.Keypad9 = 265, KeyCode.KeypadPeriod = 266, KeyCode.KeypadDivide = 267, KeyCode.KeypadMultiply = 268, KeyCode.KeypadMinus = 269, KeyCode.KeypadPlus = 270, KeyCode.KeypadEnter = 271, KeyCode.KeypadEquals = 272, KeyCode.UpKey = 273, KeyCode.DownKey = 274, KeyCode.RightKey = 275, KeyCode.LeftKey = 276, KeyCode.InsertKey = 277, KeyCode.HomeKey = 278, KeyCode.EndKey = 279, KeyCode.PageUpKey = 280, KeyCode.PageDownKey = 281, KeyCode.F1Key = 282, KeyCode.F2Key = 283, KeyCode.F3Key = 284, KeyCode.F4Key = 285, KeyCode.F5Key = 286, KeyCode.F6Key = 287, KeyCode.F7Key = 288, KeyCode.F8Key = 289, KeyCode.F9Key = 290, KeyCode.F10Key = 291, KeyCode.F11Key = 292, KeyCode.F12Key = 293, KeyCode.F13Key = 294, KeyCode.F14Key = 295, KeyCode.F15Key = 296, KeyCode.NumLockKey = 300, KeyCode.CapsLockKey = 301, KeyCode.ScrollLockKey = 302, KeyCode.RightShiftKey = 303, KeyCode.LeftShiftKey = 304, KeyCode.RightCtrlKey = 305, KeyCode.LeftCtrlKey = 306, KeyCode.RightAltKey = 307, KeyCode.LeftAltKey = 308, KeyCode.LeftSuperKey = 311, KeyCode.RightSuperKey = 312, KeyCode.ModeKey = 313, KeyCode.HelpKey = 315, KeyCode.SysReqKey = 317, KeyCode.MenuKey = 319, KeyCode.PowerKey = 320}" } @@ -48831,8 +47484,8 @@ "group": "input" }, "signatures": { - "python": "public enum {MouseButton.no_button = 0, MouseButton.left_button = 0, MouseButton.middle_button = 0, MouseButton.right_button = 0, MouseButton.mouse_x1_button = 0, MouseButton.mouse_x2_button = 0}", "cpp": "class mouse_button {NO_BUTTON = 0, LEFT_BUTTON = 0, MIDDLE_BUTTON = 0, RIGHT_BUTTON = 0, MOUSE_X1_BUTTON = 0, MOUSE_X2_BUTTON = 0};", + "python": "public enum {MouseButton.no_button = 0, MouseButton.left_button = 0, MouseButton.middle_button = 0, MouseButton.right_button = 0, MouseButton.mouse_x1_button = 0, MouseButton.mouse_x2_button = 0}", "csharp": "public enum {MouseButton.NoButton = 0, MouseButton.LeftButton = 0, MouseButton.MiddleButton = 0, MouseButton.RightButton = 0, MouseButton.MouseX1Button = 0, MouseButton.MouseX2Button = 0}", "pascal": "public enum {MouseButton.NoButton = 0, MouseButton.LeftButton = 0, MouseButton.MiddleButton = 0, MouseButton.RightButton = 0, MouseButton.MouseX1Button = 0, MouseButton.MouseX2Button = 0}" } @@ -48883,1970 +47536,28 @@ "static": "interface" }, "signatures": { - "python": [ - "def add_column(width):" - ], "cpp": [ "void add_column(int width)" ], - "csharp": [ - "public static void SplashKit.AddColumn(int width);" - ], - "pascal": [ - "procedure AddColumn(width: Integer)" - ] - } - }, - { - "signature": "void add_column_relative(double width);", - "name": "add_column_relative", - "method_name": null, - "unique_global_name": "add_column_relative", - "unique_method_name": null, - "suffix_name": null, - "description": "Adds a column to the current layout with width `width` percentage of the container's width.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "width": { - "type": "double", - "description": "Percentage of the container's width (between 0 and 1)", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def add_column_relative(width):" - ], - "cpp": [ - "void add_column_relative(double width)" - ], - "csharp": [ - "public static void SplashKit.AddColumnRelative(double width);" - ], - "pascal": [ - "procedure AddColumnRelative(width: Double)" - ] - } - }, - { - "signature": "bool bitmap_button(bitmap bmp);", - "name": "bitmap_button", - "method_name": null, - "unique_global_name": "bitmap_button", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a button with a bitmap in it, and no label.\nReturns whether the button was clicked.", - "brief": null, - "return": { - "type": "bool", - "description": "Whether the button was clicked", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to show inside the button", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def bitmap_button(bmp):" - ], - "cpp": [ - "bool bitmap_button(bitmap bmp)" - ], - "csharp": [ - "public static bool SplashKit.BitmapButton(Bitmap bmp);" - ], - "pascal": [ - "function BitmapButton(bmp: Bitmap): Boolean" - ] - } - }, - { - "signature": "bool bitmap_button(bitmap bmp,const rectangle& rect);", - "name": "bitmap_button", - "method_name": null, - "unique_global_name": "bitmap_button_at_position", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a button with a bitmap in it at a specific position on screen.\nReturns whether the button was clicked.", - "brief": null, - "return": { - "type": "bool", - "description": "Whether the button was clicked", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to show inside the button", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "The rectangle to display the button in", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "at_position", - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def bitmap_button_at_position(bmp, rect):" - ], - "cpp": [ - "bool bitmap_button(bitmap bmp, const rectangle &rect)" - ], - "csharp": [ - "public static bool SplashKit.BitmapButton(Bitmap bmp, Rectangle rect);" - ], - "pascal": [ - "function BitmapButton(bmp: Bitmap; const rect: Rectangle): Boolean" - ] - } - }, - { - "signature": "bool bitmap_button(bitmap bmp,const rectangle& rect,drawing_options opts);", - "name": "bitmap_button", - "method_name": null, - "unique_global_name": "bitmap_button_at_position_with_options", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a button with a bitmap in it at a specific position on screen.\nReturns whether the button was clicked.", - "brief": null, - "return": { - "type": "bool", - "description": "Whether the button was clicked", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to show inside the button", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "The rectangle to display the button in", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "The drawing options", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "at_position_with_options", - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def bitmap_button_at_position_with_options(bmp, rect, opts):" - ], - "cpp": [ - "bool bitmap_button(bitmap bmp, const rectangle &rect, drawing_options opts)" - ], - "csharp": [ - "public static bool SplashKit.BitmapButton(Bitmap bmp, Rectangle rect, DrawingOptions opts);" - ], - "pascal": [ - "function BitmapButton(bmp: Bitmap; const rect: Rectangle; opts: DrawingOptions): Boolean" - ] - } - }, - { - "signature": "bool bitmap_button(bitmap bmp,drawing_options opts);", - "name": "bitmap_button", - "method_name": null, - "unique_global_name": "bitmap_button_with_options", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a button with a bitmap in it, and no label.\nReturns whether the button was clicked.", - "brief": null, - "return": { - "type": "bool", - "description": "Whether the button was clicked", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to show inside the button", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "The drawing options", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "with_options", - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def bitmap_button_with_options(bmp, opts):" - ], - "cpp": [ - "bool bitmap_button(bitmap bmp, drawing_options opts)" - ], - "csharp": [ - "public static bool SplashKit.BitmapButton(Bitmap bmp, DrawingOptions opts);" - ], - "pascal": [ - "function BitmapButton(bmp: Bitmap; opts: DrawingOptions): Boolean" - ] - } - }, - { - "signature": "bool bitmap_button(const string& label_text,bitmap bmp);", - "name": "bitmap_button", - "method_name": null, - "unique_global_name": "bitmap_button_labeled", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a button with a bitmap in it and a label.\nReturns whether the button was clicked.", - "brief": null, - "return": { - "type": "bool", - "description": "Whether the button was clicked", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "label_text": { - "type": "string", - "description": "The label to show in front of the button", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "bmp": { - "type": "bitmap", - "description": "The bitmap to show inside the button", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "labeled", - "group": "interface", - "static": "interface" - }, - "signatures": { "python": [ - "def bitmap_button_labeled(label_text, bmp):" - ], - "cpp": [ - "bool bitmap_button(const string &label_text, bitmap bmp)" + "def add_column(width):" ], "csharp": [ - "public static bool SplashKit.BitmapButton(string labelText, Bitmap bmp);" + "public static void SplashKit.AddColumn(int width);" ], "pascal": [ - "function BitmapButton(const labelText: String; bmp: Bitmap): Boolean" - ] - } - }, - { - "signature": "bool bitmap_button(const string& label_text,bitmap bmp,drawing_options opts);", - "name": "bitmap_button", - "method_name": null, - "unique_global_name": "bitmap_button_labeled_with_options", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a button with a bitmap in it and a label.\nReturns whether the button was clicked.", - "brief": null, - "return": { - "type": "bool", - "description": "Whether the button was clicked", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "label_text": { - "type": "string", - "description": "The label to show in front of the button", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "bmp": { - "type": "bitmap", - "description": "The bitmap to show inside the button", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "opts": { - "type": "drawing_options", - "description": "The drawing options", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "labeled_with_options", - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def bitmap_button_labeled_with_options(label_text, bmp, opts):" - ], - "cpp": [ - "bool bitmap_button(const string &label_text, bitmap bmp, drawing_options opts)" - ], - "csharp": [ - "public static bool SplashKit.BitmapButton(string labelText, Bitmap bmp, DrawingOptions opts);" - ], - "pascal": [ - "function BitmapButton(const labelText: String; bmp: Bitmap; opts: DrawingOptions): Boolean" - ] - } - }, - { - "signature": "bool button(const string& text,const rectangle& rect);", - "name": "button", - "method_name": null, - "unique_global_name": "button_at_position", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a button at a specific position on screen.\nReturns whether the button was clicked.", - "brief": null, - "return": { - "type": "bool", - "description": "Whether the button was clicked", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "text": { - "type": "string", - "description": "The text to show inside the button", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "The rectangle to display the button in", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "at_position", - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def button_at_position(text, rect):" - ], - "cpp": [ - "bool button(const string &text, const rectangle &rect)" - ], - "csharp": [ - "public static bool SplashKit.Button(string text, Rectangle rect);" - ], - "pascal": [ - "function Button(const text: String; const rect: Rectangle): Boolean" - ] - } - }, - { - "signature": "bool button(const string& text);", - "name": "button", - "method_name": null, - "unique_global_name": "button", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a button without a label.\nReturns whether the button was clicked.", - "brief": null, - "return": { - "type": "bool", - "description": "Whether the button was clicked", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "text": { - "type": "string", - "description": "The text to show inside the button", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def button(text):" - ], - "cpp": [ - "bool button(const string &text)" - ], - "csharp": [ - "public static bool SplashKit.Button(string text);" - ], - "pascal": [ - "function Button(const text: String): Boolean" - ] - } - }, - { - "signature": "bool button(const string& label_text,const string& text);", - "name": "button", - "method_name": null, - "unique_global_name": "button_labeled", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a button with a label.\nReturns whether the button was clicked.\n\nExample usage:\n```c++\n// Test if clicked:\nif (button(\"Button 1\", \"Click me!\"))\n{\n// do stuff..\n}\n```", - "brief": null, - "return": { - "type": "bool", - "description": "Whether the button was clicked", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "label_text": { - "type": "string", - "description": "The label to show in front of the button", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "text": { - "type": "string", - "description": "The text to show inside the button", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "labeled", - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def button_labeled(label_text, text):" - ], - "cpp": [ - "bool button(const string &label_text, const string &text)" - ], - "csharp": [ - "public static bool SplashKit.Button(string labelText, string text);" - ], - "pascal": [ - "function Button(const labelText: String; const text: String): Boolean" - ] - } - }, - { - "signature": "bool checkbox(const string& text,const bool& value,const rectangle& rect);", - "name": "checkbox", - "method_name": null, - "unique_global_name": "checkbox_at_position", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a checkbox at a specific position on screen.\nReturns the updated value of the checkbox.", - "brief": null, - "return": { - "type": "bool", - "description": "The updated value of the checkbox", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "text": { - "type": "string", - "description": "The text to show next to the checkbox", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "value": { - "type": "bool", - "description": "The current value of the checkbox", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "The rectangle to display the checkbox in", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "at_position", - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def checkbox_at_position(text, value, rect):" - ], - "cpp": [ - "bool checkbox(const string &text, const bool &value, const rectangle &rect)" - ], - "csharp": [ - "public static bool SplashKit.Checkbox(string text, bool value, Rectangle rect);" - ], - "pascal": [ - "function Checkbox(const text: String; const value: Boolean; const rect: Rectangle): Boolean" - ] - } - }, - { - "signature": "bool checkbox(const string& text,const bool& value);", - "name": "checkbox", - "method_name": null, - "unique_global_name": "checkbox", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a checkbox.\nReturns the updated value of the checkbox.", - "brief": null, - "return": { - "type": "bool", - "description": "The updated value of the checkbox", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "text": { - "type": "string", - "description": "The text to show next to the checkbox", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "value": { - "type": "bool", - "description": "The current value of the checkbox", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def checkbox(text, value):" - ], - "cpp": [ - "bool checkbox(const string &text, const bool &value)" - ], - "csharp": [ - "public static bool SplashKit.Checkbox(string text, bool value);" - ], - "pascal": [ - "function Checkbox(const text: String; const value: Boolean): Boolean" - ] - } - }, - { - "signature": "bool checkbox(const string& label_text,const string& text,const bool& value);", - "name": "checkbox", - "method_name": null, - "unique_global_name": "checkbox_labeled", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a checkbox with a label.\nReturns the updated value of the checkbox.\n\nExample usage:\n```c++\nmy_bool = checkbox(\"Checkbox 1\", \"Enabled?\", my_bool);\n```", - "brief": null, - "return": { - "type": "bool", - "description": "The updated value of the checkbox", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "label_text": { - "type": "string", - "description": "The label to show in front of the checkbox", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "text": { - "type": "string", - "description": "The text to show next to the checkbox", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "value": { - "type": "bool", - "description": "The current value of the checkbox", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "labeled", - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def checkbox_labeled(label_text, text, value):" - ], - "cpp": [ - "bool checkbox(const string &label_text, const string &text, const bool &value)" - ], - "csharp": [ - "public static bool SplashKit.Checkbox(string labelText, string text, bool value);" - ], - "pascal": [ - "function Checkbox(const labelText: String; const text: String; const value: Boolean): Boolean" - ] - } - }, - { - "signature": "color color_slider(const color& clr,const rectangle& rect);", - "name": "color_slider", - "method_name": null, - "unique_global_name": "color_slider_at_position", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a set of RGBA sliders to adjust a color, at a specific position on screen.\nReturns the updated color value of the slider.", - "brief": null, - "return": { - "type": "color", - "description": "The updated value of the slider", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "clr": { - "type": "color", - "description": "The current value of the color slider", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "The rectangle to display the slider in.", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "at_position", - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def color_slider_at_position(clr, rect):" - ], - "cpp": [ - "color color_slider(const color &clr, const rectangle &rect)" - ], - "csharp": [ - "public static Color SplashKit.ColorSlider(Color clr, Rectangle rect);" - ], - "pascal": [ - "function ColorSlider(const clr: Color; const rect: Rectangle): Color" - ] - } - }, - { - "signature": "color color_slider(const color& clr);", - "name": "color_slider", - "method_name": null, - "unique_global_name": "color_slider", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a set of RGBA sliders to adjust a color.\nReturns the updated color value of the slider.", - "brief": null, - "return": { - "type": "color", - "description": "The updated value of the slider", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "clr": { - "type": "color", - "description": "The current value of the color slider", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def color_slider(clr):" - ], - "cpp": [ - "color color_slider(const color &clr)" - ], - "csharp": [ - "public static Color SplashKit.ColorSlider(Color clr);" - ], - "pascal": [ - "function ColorSlider(const clr: Color): Color" - ] - } - }, - { - "signature": "color color_slider(const string& label_text,const color& clr);", - "name": "color_slider", - "method_name": null, - "unique_global_name": "color_slider_labeled", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a set of RGBA sliders to adjust a color, with a label.\nReturns the updated color value of the slider.\n\nExample usage:\n```c++\nmy_color = color_slider(\"Player Color\", my_color);\n```", - "brief": null, - "return": { - "type": "color", - "description": "The updated value of the slider", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "label_text": { - "type": "string", - "description": "The label to show in front of the slider", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The current value of the color slider", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "labeled", - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def color_slider_labeled(label_text, clr):" - ], - "cpp": [ - "color color_slider(const string &label_text, const color &clr)" - ], - "csharp": [ - "public static Color SplashKit.ColorSlider(string labelText, Color clr);" - ], - "pascal": [ - "function ColorSlider(const labelText: String; const clr: Color): Color" - ] - } - }, - { - "signature": "void disable_interface();", - "name": "disable_interface", - "method_name": null, - "unique_global_name": "disable_interface", - "unique_method_name": null, - "suffix_name": null, - "description": "Disables the interface temporarily. Elements created after this function will appear disabled and cannot be interacted with.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def disable_interface():" - ], - "cpp": [ - "void disable_interface()" - ], - "csharp": [ - "public static void SplashKit.DisableInterface();" - ], - "pascal": [ - "procedure DisableInterface()" - ] - } - }, - { - "signature": "void draw_interface();", - "name": "draw_interface", - "method_name": null, - "unique_global_name": "draw_interface", - "unique_method_name": null, - "suffix_name": null, - "description": "Draws the user interface that all the previous calls (such as `start_panel`, `button`, etc) have created.\n\n**Make sure to call this!** Without calling it, the interface won't be visible.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def draw_interface():" - ], - "cpp": [ - "void draw_interface()" - ], - "csharp": [ - "public static void SplashKit.DrawInterface();" - ], - "pascal": [ - "procedure DrawInterface()" - ] - } - }, - { - "signature": "void enable_interface();", - "name": "enable_interface", - "method_name": null, - "unique_global_name": "enable_interface", - "unique_method_name": null, - "suffix_name": null, - "description": "Re-enables the interface, reverses the effects of disabling the interface.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def enable_interface():" - ], - "cpp": [ - "void enable_interface()" - ], - "csharp": [ - "public static void SplashKit.EnableInterface();" - ], - "pascal": [ - "procedure EnableInterface()" - ] - } - }, - { - "signature": "void end_inset(const string& name);", - "name": "end_inset", - "method_name": null, - "unique_global_name": "end_inset", - "unique_method_name": null, - "suffix_name": null, - "description": "Finishes the creation of an inset area.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "name": { - "type": "string", - "description": "The area's name - must match with `start_inset`", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def end_inset(name):" - ], - "cpp": [ - "void end_inset(const string &name)" - ], - "csharp": [ - "public static void SplashKit.EndInset(string name);" - ], - "pascal": [ - "procedure EndInset(const name: String)" - ] - } - }, - { - "signature": "void end_panel(const string& name);", - "name": "end_panel", - "method_name": null, - "unique_global_name": "end_panel", - "unique_method_name": null, - "suffix_name": null, - "description": "Finishes the creation of a panel.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "name": { - "type": "string", - "description": "The name shown in the panel's titlebar - must match with `start_panel`", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def end_panel(name):" - ], - "cpp": [ - "void end_panel(const string &name)" - ], - "csharp": [ - "public static void SplashKit.EndPanel(string name);" - ], - "pascal": [ - "procedure EndPanel(const name: String)" - ] - } - }, - { - "signature": "void end_popup(const string& name);", - "name": "end_popup", - "method_name": null, - "unique_global_name": "end_popup", - "unique_method_name": null, - "suffix_name": null, - "description": "Finishes the creation of a popup.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "name": { - "type": "string", - "description": "The popup's name - must match with `start_popup`", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def end_popup(name):" - ], - "cpp": [ - "void end_popup(const string &name)" - ], - "csharp": [ - "public static void SplashKit.EndPopup(string name);" - ], - "pascal": [ - "procedure EndPopup(const name: String)" - ] - } - }, - { - "signature": "void end_treenode(const string& label_text);", - "name": "end_treenode", - "method_name": null, - "unique_global_name": "end_treenode", - "unique_method_name": null, - "suffix_name": null, - "description": "Finishes the creation of a tree node.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "label_text": { - "type": "string", - "description": "The node's name - must match with `start_treenode`", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def end_treenode(label_text):" - ], - "cpp": [ - "void end_treenode(const string &label_text)" - ], - "csharp": [ - "public static void SplashKit.EndTreenode(string labelText);" - ], - "pascal": [ - "procedure EndTreenode(const labelText: String)" - ] - } - }, - { - "signature": "void enter_column();", - "name": "enter_column", - "method_name": null, - "unique_global_name": "enter_column", - "unique_method_name": null, - "suffix_name": null, - "description": "Begins placing elements inside the current column. Must be paired with a call to `leave_column`.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def enter_column():" - ], - "cpp": [ - "void enter_column()" - ], - "csharp": [ - "public static void SplashKit.EnterColumn();" - ], - "pascal": [ - "procedure EnterColumn()" - ] - } - }, - { - "signature": "int get_interface_label_width();", - "name": "get_interface_label_width", - "method_name": null, - "unique_global_name": "get_interface_label_width", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns the width of element labels.\n\nDefault is 60 pixels.", - "brief": null, - "return": { - "type": "int", - "description": "The width of labels", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def get_interface_label_width():" - ], - "cpp": [ - "int get_interface_label_width()" - ], - "csharp": [ - "public static int SplashKit.GetInterfaceLabelWidth();" - ], - "pascal": [ - "function GetInterfaceLabelWidth(): Integer" - ] - } - }, - { - "signature": "bool header(const string& label_text);", - "name": "header", - "method_name": null, - "unique_global_name": "header", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a collapsable header with a label.\nReturns whether the header is expanded or not.\n\nNote: Unlike `start_panel` and other similar functions, there is\nno need to 'end' this one. Example usage:\n```c++\nif (header(\"Section A\"))\n{\n// elements inside header go here\n}\n```", - "brief": null, - "return": { - "type": "bool", - "description": "Whether the header is expanded or not", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "label_text": { - "type": "string", - "description": "The label to show in the header", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def header(label_text):" - ], - "cpp": [ - "bool header(const string &label_text)" - ], - "csharp": [ - "public static bool SplashKit.Header(string labelText);" - ], - "pascal": [ - "function Header(const labelText: String): Boolean" - ] - } - }, - { - "signature": "color hsb_color_slider(const color& clr,const rectangle& rect);", - "name": "hsb_color_slider", - "method_name": null, - "unique_global_name": "hsb_color_slider_at_position", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a set of HSBA (hue, saturation, brightness, alpha) sliders to adjust a color, at a specific position on screen.\nReturns the updated color value of the slider.", - "brief": null, - "return": { - "type": "color", - "description": "The updated value of the slider", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "clr": { - "type": "color", - "description": "The current value of the color slider", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "The rectangle to display the slider in.", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "at_position", - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def hsb_color_slider_at_position(clr, rect):" - ], - "cpp": [ - "color hsb_color_slider(const color &clr, const rectangle &rect)" - ], - "csharp": [ - "public static Color SplashKit.HSBColorSlider(Color clr, Rectangle rect);" - ], - "pascal": [ - "function HSBColorSlider(const clr: Color; const rect: Rectangle): Color" - ] - } - }, - { - "signature": "color hsb_color_slider(const color& clr);", - "name": "hsb_color_slider", - "method_name": null, - "unique_global_name": "hsb_color_slider", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a set of HSBA (hue, saturation, brightness, alpha) sliders to adjust a color.\nReturns the updated color value of the slider.", - "brief": null, - "return": { - "type": "color", - "description": "The updated value of the slider", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "clr": { - "type": "color", - "description": "The current value of the color slider", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def hsb_color_slider(clr):" - ], - "cpp": [ - "color hsb_color_slider(const color &clr)" - ], - "csharp": [ - "public static Color SplashKit.HSBColorSlider(Color clr);" - ], - "pascal": [ - "function HSBColorSlider(const clr: Color): Color" - ] - } - }, - { - "signature": "color hsb_color_slider(const string& label_text,const color& clr);", - "name": "hsb_color_slider", - "method_name": null, - "unique_global_name": "hsb_color_slider_labeled", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a set of HSBA (hue, saturation, brightness, alpha) sliders to adjust a color, with a label.\nReturns the updated color value of the slider.\n\nExample usage:\n```c++\nmy_color = hsb_color_slider(\"Player Color\", my_color);\n```", - "brief": null, - "return": { - "type": "color", - "description": "The updated value of the slider", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "label_text": { - "type": "string", - "description": "The label to show in front of the slider", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The current value of the color slider", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "labeled", - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def hsb_color_slider_labeled(label_text, clr):" - ], - "cpp": [ - "color hsb_color_slider(const string &label_text, const color &clr)" - ], - "csharp": [ - "public static Color SplashKit.HSBColorSlider(string labelText, Color clr);" - ], - "pascal": [ - "function HSBColorSlider(const labelText: String; const clr: Color): Color" - ] - } - }, - { - "signature": "bool interface_enabled();", - "name": "interface_enabled", - "method_name": null, - "unique_global_name": "interface_enabled", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns if the interface is currently enabled or not.", - "brief": null, - "return": { - "type": "bool", - "description": "Whether the interface is currently enabled or not", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def interface_enabled():" - ], - "cpp": [ - "bool interface_enabled()" - ], - "csharp": [ - "public static bool SplashKit.InterfaceEnabled();" - ], - "pascal": [ - "function InterfaceEnabled(): Boolean" - ] - } - }, - { - "signature": "void interface_style_panel(const rectangle& initial_rectangle);", - "name": "interface_style_panel", - "method_name": null, - "unique_global_name": "interface_style_panel", - "unique_method_name": null, - "suffix_name": null, - "description": "A utility function to show a 'Style Panel', which will allows you to experiment with different interface styles.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "initial_rectangle": { - "type": "rectangle", - "description": "The initial position/size the panel starts off in", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def interface_style_panel(initial_rectangle):" - ], - "cpp": [ - "void interface_style_panel(const rectangle &initial_rectangle)" - ], - "csharp": [ - "public static void SplashKit.InterfaceStylePanel(Rectangle initialRectangle);" - ], - "pascal": [ - "procedure InterfaceStylePanel(const initialRectangle: Rectangle)" - ] - } - }, - { - "signature": "void label_element(const string& text);", - "name": "label_element", - "method_name": null, - "unique_global_name": "label_element", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a label with the given text.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "text": { - "type": "string", - "description": "The label to show", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def label_element(text):" - ], - "cpp": [ - "void label_element(const string &text)" - ], - "csharp": [ - "public static void SplashKit.LabelElement(string text);" - ], - "pascal": [ - "procedure LabelElement(const text: String)" - ] - } - }, - { - "signature": "void label_element(const string& text,const rectangle& rect);", - "name": "label_element", - "method_name": null, - "unique_global_name": "label_element_at_position", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a label at a specific position on screen.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "text": { - "type": "string", - "description": "The label to show", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "The rectangle to display the label in", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "at_position", - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def label_element_at_position(text, rect):" - ], - "cpp": [ - "void label_element(const string &text, const rectangle &rect)" - ], - "csharp": [ - "public static void SplashKit.LabelElement(string text, Rectangle rect);" - ], - "pascal": [ - "procedure LabelElement(const text: String; const rect: Rectangle)" - ] - } - }, - { - "signature": "bool last_element_changed();", - "name": "last_element_changed", - "method_name": null, - "unique_global_name": "last_element_changed", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns if the last created element was changed at all (such as dragged, typed in, etc)", - "brief": null, - "return": { - "type": "bool", - "description": "Whether the last created element was changed", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def last_element_changed():" - ], - "cpp": [ - "bool last_element_changed()" - ], - "csharp": [ - "public static bool SplashKit.LastElementChanged();" - ], - "pascal": [ - "function LastElementChanged(): Boolean" - ] - } - }, - { - "signature": "bool last_element_confirmed();", - "name": "last_element_confirmed", - "method_name": null, - "unique_global_name": "last_element_confirmed", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns if the last created element was 'confirmed' (such as clicking a button, or hitting enter in a text box)", - "brief": null, - "return": { - "type": "bool", - "description": "Whether the last created element was confirmed", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def last_element_confirmed():" - ], - "cpp": [ - "bool last_element_confirmed()" - ], - "csharp": [ - "public static bool SplashKit.LastElementConfirmed();" - ], - "pascal": [ - "function LastElementConfirmed(): Boolean" + "procedure AddColumn(width: Integer)" ] } }, { - "signature": "void leave_column();", - "name": "leave_column", + "signature": "void add_column_relative(double width);", + "name": "add_column_relative", "method_name": null, - "unique_global_name": "leave_column", + "unique_global_name": "add_column_relative", "unique_method_name": null, "suffix_name": null, - "description": "Stops placing elements inside the current column and moves to the next one.", + "description": "Adds a column to the current layout with width `width` percentage of the container's width.", "brief": null, "return": { "type": "void", @@ -50857,128 +47568,114 @@ "type_parameter": null }, "parameters": { + "width": { + "type": "double", + "description": "Percentage of the container's width (between 0 and 1)", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def leave_column():" - ], "cpp": [ - "void leave_column()" + "void add_column_relative(double width)" + ], + "python": [ + "def add_column_relative(width):" ], "csharp": [ - "public static void SplashKit.LeaveColumn();" + "public static void SplashKit.AddColumnRelative(double width);" ], "pascal": [ - "procedure LeaveColumn()" + "procedure AddColumnRelative(width: Double)" ] } }, { - "signature": "float number_box(const float& value,float step,const rectangle& rect);", - "name": "number_box", + "signature": "bool bitmap_button(bitmap bmp);", + "name": "bitmap_button", "method_name": null, - "unique_global_name": "number_box_at_position", + "unique_global_name": "bitmap_button", "unique_method_name": null, "suffix_name": null, - "description": "Creates a number entry box at a specific position on screen.\nReturns the updated value of the number box.", + "description": "Creates a button with a bitmap in it, and no label.\nReturns whether the button was clicked.", "brief": null, "return": { - "type": "float", - "description": "The updated value of the slider", + "type": "bool", + "description": "Whether the button was clicked", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "value": { - "type": "float", - "description": "The current value of the number box", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "step": { - "type": "float", - "description": "The amount incremented when dragging on the box", + "bmp": { + "type": "bitmap", + "description": "The bitmap to show inside the button", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "The rectangle to display the slider in", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "suffix": "at_position", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def number_box_at_position(value, step, rect):" - ], "cpp": [ - "float number_box(const float &value, float step, const rectangle &rect)" + "bool bitmap_button(bitmap bmp)" + ], + "python": [ + "def bitmap_button(bmp):" ], "csharp": [ - "public static float SplashKit.NumberBox(float value, float step, Rectangle rect);" + "public static bool SplashKit.BitmapButton(Bitmap bmp);" ], "pascal": [ - "function NumberBox(const value: Single; step: Single; const rect: Rectangle): Single" + "function BitmapButton(bmp: Bitmap): Boolean" ] } }, { - "signature": "float number_box(const float& value,float step);", - "name": "number_box", + "signature": "bool bitmap_button(bitmap bmp,const rectangle& rect);", + "name": "bitmap_button", "method_name": null, - "unique_global_name": "number_box", + "unique_global_name": "bitmap_button_at_position", "unique_method_name": null, "suffix_name": null, - "description": "Creates a number entry box with a label.\nReturns the updated value of the number box.", + "description": "Creates a button with a bitmap in it at a specific position on screen.\nReturns whether the button was clicked.", "brief": null, "return": { - "type": "float", - "description": "The updated value of the slider", + "type": "bool", + "description": "Whether the button was clicked", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "value": { - "type": "float", - "description": "The current value of the number box", + "bmp": { + "type": "bitmap", + "description": "The bitmap to show inside the button", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -50986,12 +47683,12 @@ "is_vector": false, "type_parameter": null }, - "step": { - "type": "float", - "description": "The amount incremented when dragging on the box", + "rect": { + "type": "rectangle", + "description": "The rectangle to display the button in", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -51001,48 +47698,49 @@ } }, "attributes": { + "suffix": "at_position", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def number_box(value, step):" - ], "cpp": [ - "float number_box(const float &value, float step)" + "bool bitmap_button(bitmap bmp, const rectangle &rect)" + ], + "python": [ + "def bitmap_button_at_position(bmp, rect):" ], "csharp": [ - "public static float SplashKit.NumberBox(float value, float step);" + "public static bool SplashKit.BitmapButton(Bitmap bmp, Rectangle rect);" ], "pascal": [ - "function NumberBox(const value: Single; step: Single): Single" + "function BitmapButton(bmp: Bitmap; const rect: Rectangle): Boolean" ] } }, { - "signature": "float number_box(const string& label_text,const float& value,float step);", - "name": "number_box", + "signature": "bool bitmap_button(bitmap bmp,const rectangle& rect,drawing_options opts);", + "name": "bitmap_button", "method_name": null, - "unique_global_name": "number_box_labeled", + "unique_global_name": "bitmap_button_at_position_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Creates a number entry box with a label.\nReturns the updated value of the number box.\n\nExample usage:\n```c++\nmy_float = number_box(\"Percentage\", my_float, 1);\n```", + "description": "Creates a button with a bitmap in it at a specific position on screen.\nReturns whether the button was clicked.", "brief": null, "return": { - "type": "float", - "description": "The updated value of the slider", + "type": "bool", + "description": "Whether the button was clicked", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "label_text": { - "type": "string", - "description": "The label to show in front of the number box", + "bmp": { + "type": "bitmap", + "description": "The bitmap to show inside the button", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -51050,9 +47748,9 @@ "is_vector": false, "type_parameter": null }, - "value": { - "type": "float", - "description": "The current value of the number box", + "rect": { + "type": "rectangle", + "description": "The rectangle to display the button in", "is_pointer": false, "is_const": true, "is_reference": true, @@ -51063,9 +47761,9 @@ "is_vector": false, "type_parameter": null }, - "step": { - "type": "float", - "description": "The amount incremented when dragging on the box", + "opts": { + "type": "drawing_options", + "description": "The drawing options", "is_pointer": false, "is_const": false, "is_reference": false, @@ -51078,100 +47776,62 @@ } }, "attributes": { - "suffix": "labeled", + "suffix": "at_position_with_options", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def number_box_labeled(label_text, value, step):" - ], "cpp": [ - "float number_box(const string &label_text, const float &value, float step)" + "bool bitmap_button(bitmap bmp, const rectangle &rect, drawing_options opts)" + ], + "python": [ + "def bitmap_button_at_position_with_options(bmp, rect, opts):" ], "csharp": [ - "public static float SplashKit.NumberBox(string labelText, float value, float step);" + "public static bool SplashKit.BitmapButton(Bitmap bmp, Rectangle rect, DrawingOptions opts);" ], "pascal": [ - "function NumberBox(const labelText: String; const value: Single; step: Single): Single" + "function BitmapButton(bmp: Bitmap; const rect: Rectangle; opts: DrawingOptions): Boolean" ] } }, { - "signature": "void open_popup(const string& name);", - "name": "open_popup", + "signature": "bool bitmap_button(bitmap bmp,drawing_options opts);", + "name": "bitmap_button", "method_name": null, - "unique_global_name": "open_popup", + "unique_global_name": "bitmap_button_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Makes the popup named `name` open/popup at the cursor's position.", + "description": "Creates a button with a bitmap in it, and no label.\nReturns whether the button was clicked.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "Whether the button was clicked", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The popup's name. Must match with the same name used in `start_popup`", + "bmp": { + "type": "bitmap", + "description": "The bitmap to show inside the button", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { - "python": [ - "def open_popup(name):" - ], - "cpp": [ - "void open_popup(const string &name)" - ], - "csharp": [ - "public static void SplashKit.OpenPopup(string name);" - ], - "pascal": [ - "procedure OpenPopup(const name: String)" - ] - } - }, - { - "signature": "void paragraph(const string& text);", - "name": "paragraph", - "method_name": null, - "unique_global_name": "paragraph", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a paragraph of text that auto-wraps.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "text": { - "type": "string", - "description": "The text to show", + }, + "opts": { + "type": "drawing_options", + "description": "The drawing options", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -51181,45 +47841,46 @@ } }, "attributes": { + "suffix": "with_options", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def paragraph(text):" - ], "cpp": [ - "void paragraph(const string &text)" + "bool bitmap_button(bitmap bmp, drawing_options opts)" + ], + "python": [ + "def bitmap_button_with_options(bmp, opts):" ], "csharp": [ - "public static void SplashKit.Paragraph(string text);" + "public static bool SplashKit.BitmapButton(Bitmap bmp, DrawingOptions opts);" ], "pascal": [ - "procedure Paragraph(const text: String)" + "function BitmapButton(bmp: Bitmap; opts: DrawingOptions): Boolean" ] } }, { - "signature": "void paragraph(const string& text,const rectangle& rect);", - "name": "paragraph", + "signature": "bool bitmap_button(const string& label_text,bitmap bmp);", + "name": "bitmap_button", "method_name": null, - "unique_global_name": "paragraph_at_position", + "unique_global_name": "bitmap_button_labeled", "unique_method_name": null, "suffix_name": null, - "description": "Creates a paragraph of text that auto-wraps at a specific position on screen.", + "description": "Creates a button with a bitmap in it and a label.\nReturns whether the button was clicked.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "Whether the button was clicked", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "text": { + "label_text": { "type": "string", - "description": "The text to show", + "description": "The label to show in front of the button", "is_pointer": false, "is_const": true, "is_reference": true, @@ -51230,12 +47891,12 @@ "is_vector": false, "type_parameter": null }, - "rect": { - "type": "rectangle", - "description": "The rectangle to display the label in", + "bmp": { + "type": "bitmap", + "description": "The bitmap to show inside the button", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -51245,84 +47906,59 @@ } }, "attributes": { - "suffix": "at_position", + "suffix": "labeled", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def paragraph_at_position(text, rect):" - ], "cpp": [ - "void paragraph(const string &text, const rectangle &rect)" - ], - "csharp": [ - "public static void SplashKit.Paragraph(string text, Rectangle rect);" + "bool bitmap_button(const string &label_text, bitmap bmp)" ], - "pascal": [ - "procedure Paragraph(const text: String; const rect: Rectangle)" - ] - } - }, - { - "signature": "void reset_layout();", - "name": "reset_layout", - "method_name": null, - "unique_global_name": "reset_layout", - "unique_method_name": null, - "suffix_name": null, - "description": "Resets to the default layout of a single column with default height.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { "python": [ - "def reset_layout():" - ], - "cpp": [ - "void reset_layout()" + "def bitmap_button_labeled(label_text, bmp):" ], "csharp": [ - "public static void SplashKit.ResetLayout();" + "public static bool SplashKit.BitmapButton(string labelText, Bitmap bmp);" ], "pascal": [ - "procedure ResetLayout()" + "function BitmapButton(const labelText: String; bmp: Bitmap): Boolean" ] } }, { - "signature": "void set_interface_accent_color(color clr,float contrast);", - "name": "set_interface_accent_color", + "signature": "bool bitmap_button(const string& label_text,bitmap bmp,drawing_options opts);", + "name": "bitmap_button", "method_name": null, - "unique_global_name": "set_interface_accent_color", + "unique_global_name": "bitmap_button_labeled_with_options", "unique_method_name": null, "suffix_name": null, - "description": "Sets the color of accents in the interface, and the contrast of how strongly they appear when hovering/interacting.", + "description": "Creates a button with a bitmap in it and a label.\nReturns whether the button was clicked.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "Whether the button was clicked", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color of accents", + "label_text": { + "type": "string", + "description": "The label to show in front of the button", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "bmp": { + "type": "bitmap", + "description": "The bitmap to show inside the button", "is_pointer": false, "is_const": false, "is_reference": false, @@ -51333,9 +47969,9 @@ "is_vector": false, "type_parameter": null }, - "contrast": { - "type": "float", - "description": "The strength of how much the accents show (between 0 and 1)", + "opts": { + "type": "drawing_options", + "description": "The drawing options", "is_pointer": false, "is_const": false, "is_reference": false, @@ -51348,48 +47984,62 @@ } }, "attributes": { + "suffix": "labeled_with_options", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def set_interface_accent_color(clr, contrast):" - ], "cpp": [ - "void set_interface_accent_color(color clr, float contrast)" + "bool bitmap_button(const string &label_text, bitmap bmp, drawing_options opts)" + ], + "python": [ + "def bitmap_button_labeled_with_options(label_text, bmp, opts):" ], "csharp": [ - "public static void SplashKit.SetInterfaceAccentColor(Color clr, float contrast);" + "public static bool SplashKit.BitmapButton(string labelText, Bitmap bmp, DrawingOptions opts);" ], "pascal": [ - "procedure SetInterfaceAccentColor(clr: Color; contrast: Single)" + "function BitmapButton(const labelText: String; bmp: Bitmap; opts: DrawingOptions): Boolean" ] } }, { - "signature": "void set_interface_border_color(color clr);", - "name": "set_interface_border_color", + "signature": "bool button(const string& text,const rectangle& rect);", + "name": "button", "method_name": null, - "unique_global_name": "set_interface_border_color", + "unique_global_name": "button_at_position", "unique_method_name": null, "suffix_name": null, - "description": "Sets the interface's border color.", + "description": "Creates a button at a specific position on screen.\nReturns whether the button was clicked.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "Whether the button was clicked", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color to set borders to", + "text": { + "type": "string", + "description": "The text to show inside the button", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect": { + "type": "rectangle", + "description": "The rectangle to display the button in", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -51399,100 +48049,49 @@ } }, "attributes": { + "suffix": "at_position", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def set_interface_border_color(clr):" - ], "cpp": [ - "void set_interface_border_color(color clr)" + "bool button(const string &text, const rectangle &rect)" + ], + "python": [ + "def button_at_position(text, rect):" ], "csharp": [ - "public static void SplashKit.SetInterfaceBorderColor(Color clr);" + "public static bool SplashKit.Button(string text, Rectangle rect);" ], "pascal": [ - "procedure SetInterfaceBorderColor(clr: Color)" + "function Button(const text: String; const rect: Rectangle): Boolean" ] } }, { - "signature": "void set_interface_colors_auto(color main_clr,color accent_clr,float contrast,float accent_contrast,float border_contrast);", - "name": "set_interface_colors_auto", - "method_name": null, - "unique_global_name": "set_interface_colors_auto", - "unique_method_name": null, - "suffix_name": null, - "description": "A convenience function to set the majority of the interface's colors in one go.\nSome colors will be automatically chosen based on the parameters (such as text color).", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "main_clr": { - "type": "color", - "description": "The main color of the interface - also decides if the interface is light or dark mode", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "accent_clr": { - "type": "color", - "description": "The color used to accent the interface - this will appear in highlighted areas", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "contrast": { - "type": "float", - "description": "The contrast between the frames of elements/containers and their internal elements", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "accent_contrast": { - "type": "float", - "description": "How strongly the accent color is used, for instance when highlighting elements", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "border_contrast": { - "type": "float", - "description": "Simply the opacity of the borders", + "signature": "bool button(const string& text);", + "name": "button", + "method_name": null, + "unique_global_name": "button", + "unique_method_name": null, + "suffix_name": null, + "description": "Creates a button without a label.\nReturns whether the button was clicked.", + "brief": null, + "return": { + "type": "bool", + "description": "Whether the button was clicked", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "text": { + "type": "string", + "description": "The text to show inside the button", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -51506,44 +48105,44 @@ "static": "interface" }, "signatures": { - "python": [ - "def set_interface_colors_auto(main_clr, accent_clr, contrast, accent_contrast, border_contrast):" - ], "cpp": [ - "void set_interface_colors_auto(color main_clr, color accent_clr, float contrast, float accent_contrast, float border_contrast)" + "bool button(const string &text)" + ], + "python": [ + "def button(text):" ], "csharp": [ - "public static void SplashKit.SetInterfaceColorsAuto(Color mainClr, Color accentClr, float contrast, float accentContrast, float borderContrast);" + "public static bool SplashKit.Button(string text);" ], "pascal": [ - "procedure SetInterfaceColorsAuto(mainClr: Color; accentClr: Color; contrast: Single; accentContrast: Single; borderContrast: Single)" + "function Button(const text: String): Boolean" ] } }, { - "signature": "void set_interface_element_color(color clr,float contrast);", - "name": "set_interface_element_color", + "signature": "bool button(const string& label_text,const string& text);", + "name": "button", "method_name": null, - "unique_global_name": "set_interface_element_color", + "unique_global_name": "button_labeled", "unique_method_name": null, "suffix_name": null, - "description": "Sets the main color of elements in the interface, and the contrast between their frame and internal pieces.", + "description": "Creates a button with a label.\nReturns whether the button was clicked.\n\nExample usage:\n```c++\n// Test if clicked:\nif (button(\"Button 1\", \"Click me!\"))\n{\n// do stuff..\n}\n```", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "Whether the button was clicked", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color of elements", + "label_text": { + "type": "string", + "description": "The label to show in front of the button", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -51551,12 +48150,12 @@ "is_vector": false, "type_parameter": null }, - "contrast": { - "type": "float", - "description": "The contrast between the frame of elements and their internal pieces (between 0 and 1)", + "text": { + "type": "string", + "description": "The text to show inside the button", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -51566,48 +48165,49 @@ } }, "attributes": { + "suffix": "labeled", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def set_interface_element_color(clr, contrast):" - ], "cpp": [ - "void set_interface_element_color(color clr, float contrast)" + "bool button(const string &label_text, const string &text)" + ], + "python": [ + "def button_labeled(label_text, text):" ], "csharp": [ - "public static void SplashKit.SetInterfaceElementColor(Color clr, float contrast);" + "public static bool SplashKit.Button(string labelText, string text);" ], "pascal": [ - "procedure SetInterfaceElementColor(clr: Color; contrast: Single)" + "function Button(const labelText: String; const text: String): Boolean" ] } }, { - "signature": "void set_interface_element_shadows(int radius,color clr,point_2d offset);", - "name": "set_interface_element_shadows", + "signature": "bool checkbox(const string& text,const bool& value,const rectangle& rect);", + "name": "checkbox", "method_name": null, - "unique_global_name": "set_interface_element_shadows", + "unique_global_name": "checkbox_at_position", "unique_method_name": null, "suffix_name": null, - "description": "Sets the style of element's shadows. Use a fully transparent color to disable them.", + "description": "Creates a checkbox at a specific position on screen.\nReturns the updated value of the checkbox.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "The updated value of the checkbox", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "radius": { - "type": "int", - "description": "The radius of the shadow's blur", + "text": { + "type": "string", + "description": "The text to show next to the checkbox", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -51615,12 +48215,12 @@ "is_vector": false, "type_parameter": null }, - "clr": { - "type": "color", - "description": "The color of the shadows (commonly black, but can do coloured and semi-transparent too)", + "value": { + "type": "bool", + "description": "The current value of the checkbox", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -51628,12 +48228,12 @@ "is_vector": false, "type_parameter": null }, - "offset": { - "type": "point_2d", - "description": "The offset in x/y coordinates of the shadows from their casting elements", + "rect": { + "type": "rectangle", + "description": "The rectangle to display the checkbox in", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -51643,45 +48243,59 @@ } }, "attributes": { + "suffix": "at_position", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def set_interface_element_shadows(radius, clr, offset):" - ], "cpp": [ - "void set_interface_element_shadows(int radius, color clr, point_2d offset)" + "bool checkbox(const string &text, const bool &value, const rectangle &rect)" + ], + "python": [ + "def checkbox_at_position(text, value, rect):" ], "csharp": [ - "public static void SplashKit.SetInterfaceElementShadows(int radius, Color clr, Point2D offset);" + "public static bool SplashKit.Checkbox(string text, bool value, Rectangle rect);" ], "pascal": [ - "procedure SetInterfaceElementShadows(radius: Integer; clr: Color; offset: Point2D)" + "function Checkbox(const text: String; const value: Boolean; const rect: Rectangle): Boolean" ] } }, { - "signature": "void set_interface_font(const string& fnt);", - "name": "set_interface_font", + "signature": "bool checkbox(const string& text,const bool& value);", + "name": "checkbox", "method_name": null, - "unique_global_name": "set_interface_font_font_as_string", + "unique_global_name": "checkbox", "unique_method_name": null, "suffix_name": null, - "description": "Sets the interface's font.", + "description": "Creates a checkbox.\nReturns the updated value of the checkbox.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "The updated value of the checkbox", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "fnt": { + "text": { "type": "string", - "description": "The name of the font to be used", + "description": "The text to show next to the checkbox", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "value": { + "type": "bool", + "description": "The current value of the checkbox", "is_pointer": false, "is_const": true, "is_reference": true, @@ -51694,49 +48308,74 @@ } }, "attributes": { - "suffix": "font_as_string", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def set_interface_font_font_as_string(fnt):" - ], "cpp": [ - "void set_interface_font(const string &fnt)" + "bool checkbox(const string &text, const bool &value)" + ], + "python": [ + "def checkbox(text, value):" ], "csharp": [ - "public static void SplashKit.SetInterfaceFont(string fnt);" + "public static bool SplashKit.Checkbox(string text, bool value);" ], "pascal": [ - "procedure SetInterfaceFont(const fnt: String)" + "function Checkbox(const text: String; const value: Boolean): Boolean" ] } }, { - "signature": "void set_interface_font(font fnt);", - "name": "set_interface_font", + "signature": "bool checkbox(const string& label_text,const string& text,const bool& value);", + "name": "checkbox", "method_name": null, - "unique_global_name": "set_interface_font", + "unique_global_name": "checkbox_labeled", "unique_method_name": null, "suffix_name": null, - "description": "Sets the interface's font.", + "description": "Creates a checkbox with a label.\nReturns the updated value of the checkbox.\n\nExample usage:\n```c++\nmy_bool = checkbox(\"Checkbox 1\", \"Enabled?\", my_bool);\n```", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "The updated value of the checkbox", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "fnt": { - "type": "font", - "description": "The font to be used", + "label_text": { + "type": "string", + "description": "The label to show in front of the checkbox", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "text": { + "type": "string", + "description": "The text to show next to the checkbox", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "value": { + "type": "bool", + "description": "The current value of the checkbox", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -51746,48 +48385,62 @@ } }, "attributes": { + "suffix": "labeled", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def set_interface_font(fnt):" - ], "cpp": [ - "void set_interface_font(font fnt)" + "bool checkbox(const string &label_text, const string &text, const bool &value)" + ], + "python": [ + "def checkbox_labeled(label_text, text, value):" ], "csharp": [ - "public static void SplashKit.SetInterfaceFont(Font fnt);" + "public static bool SplashKit.Checkbox(string labelText, string text, bool value);" ], "pascal": [ - "procedure SetInterfaceFont(fnt: Font)" + "function Checkbox(const labelText: String; const text: String; const value: Boolean): Boolean" ] } }, { - "signature": "void set_interface_font_size(int size);", - "name": "set_interface_font_size", + "signature": "color color_slider(const color& clr,const rectangle& rect);", + "name": "color_slider", "method_name": null, - "unique_global_name": "set_interface_font_size", + "unique_global_name": "color_slider_at_position", "unique_method_name": null, "suffix_name": null, - "description": "Sets the interface's font size.", + "description": "Creates a set of RGBA sliders to adjust a color, at a specific position on screen.\nReturns the updated color value of the slider.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "color", + "description": "The updated value of the slider", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "size": { - "type": "int", - "description": "The font size to be used", + "clr": { + "type": "color", + "description": "The current value of the color slider", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect": { + "type": "rectangle", + "description": "The rectangle to display the slider in.", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -51797,48 +48450,49 @@ } }, "attributes": { + "suffix": "at_position", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def set_interface_font_size(size):" - ], "cpp": [ - "void set_interface_font_size(int size)" + "color color_slider(const color &clr, const rectangle &rect)" + ], + "python": [ + "def color_slider_at_position(clr, rect):" ], "csharp": [ - "public static void SplashKit.SetInterfaceFontSize(int size);" + "public static Color SplashKit.ColorSlider(Color clr, Rectangle rect);" ], "pascal": [ - "procedure SetInterfaceFontSize(size: Integer)" + "function ColorSlider(const clr: Color; const rect: Rectangle): Color" ] } }, { - "signature": "void set_interface_label_width(int width);", - "name": "set_interface_label_width", + "signature": "color color_slider(const color& clr);", + "name": "color_slider", "method_name": null, - "unique_global_name": "set_interface_label_width", + "unique_global_name": "color_slider", "unique_method_name": null, "suffix_name": null, - "description": "Sets the width of element labels. This is the maximum width\nin pixels that a label can span in front of an element.\n\nDefault is 60 pixels.", + "description": "Creates a set of RGBA sliders to adjust a color.\nReturns the updated color value of the slider.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "color", + "description": "The updated value of the slider", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "width": { - "type": "int", - "description": "The width of labels", + "clr": { + "type": "color", + "description": "The current value of the color slider", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -51852,44 +48506,44 @@ "static": "interface" }, "signatures": { - "python": [ - "def set_interface_label_width(width):" - ], "cpp": [ - "void set_interface_label_width(int width)" + "color color_slider(const color &clr)" + ], + "python": [ + "def color_slider(clr):" ], "csharp": [ - "public static void SplashKit.SetInterfaceLabelWidth(int width);" + "public static Color SplashKit.ColorSlider(Color clr);" ], "pascal": [ - "procedure SetInterfaceLabelWidth(width: Integer)" + "function ColorSlider(const clr: Color): Color" ] } }, { - "signature": "void set_interface_panel_shadows(int radius,color clr,point_2d offset);", - "name": "set_interface_panel_shadows", + "signature": "color color_slider(const string& label_text,const color& clr);", + "name": "color_slider", "method_name": null, - "unique_global_name": "set_interface_panel_shadows", + "unique_global_name": "color_slider_labeled", "unique_method_name": null, "suffix_name": null, - "description": "Sets the style of panel's shadows. Use a fully transparent color to disable them.", + "description": "Creates a set of RGBA sliders to adjust a color, with a label.\nReturns the updated color value of the slider.\n\nExample usage:\n```c++\nmy_color = color_slider(\"Player Color\", my_color);\n```", "brief": null, "return": { - "type": "void", - "description": null, + "type": "color", + "description": "The updated value of the slider", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "radius": { - "type": "int", - "description": "The radius of the shadow's blur", + "label_text": { + "type": "string", + "description": "The label to show in front of the slider", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -51899,23 +48553,10 @@ }, "clr": { "type": "color", - "description": "The color of the shadows (commonly black, but can do coloured and semi-transparent too)", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "offset": { - "type": "point_2d", - "description": "The offset in x/y coordinates of the shadows from their casting elements", + "description": "The current value of the color slider", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -51925,32 +48566,33 @@ } }, "attributes": { + "suffix": "labeled", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def set_interface_panel_shadows(radius, clr, offset):" - ], "cpp": [ - "void set_interface_panel_shadows(int radius, color clr, point_2d offset)" + "color color_slider(const string &label_text, const color &clr)" + ], + "python": [ + "def color_slider_labeled(label_text, clr):" ], "csharp": [ - "public static void SplashKit.SetInterfacePanelShadows(int radius, Color clr, Point2D offset);" + "public static Color SplashKit.ColorSlider(string labelText, Color clr);" ], "pascal": [ - "procedure SetInterfacePanelShadows(radius: Integer; clr: Color; offset: Point2D)" + "function ColorSlider(const labelText: String; const clr: Color): Color" ] } }, { - "signature": "void set_interface_root_text_color(color clr);", - "name": "set_interface_root_text_color", + "signature": "void disable_interface();", + "name": "disable_interface", "method_name": null, - "unique_global_name": "set_interface_root_text_color", + "unique_global_name": "disable_interface", "unique_method_name": null, "suffix_name": null, - "description": "Sets color of text drawn directly onto the main window", + "description": "Disables the interface temporarily. Elements created after this function will appear disabled and cannot be interacted with.", "brief": null, "return": { "type": "void", @@ -51961,47 +48603,34 @@ "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color to set text drawn on the main window to", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def set_interface_root_text_color(clr):" - ], "cpp": [ - "void set_interface_root_text_color(color clr)" + "void disable_interface()" + ], + "python": [ + "def disable_interface():" ], "csharp": [ - "public static void SplashKit.SetInterfaceRootTextColor(Color clr);" + "public static void SplashKit.DisableInterface();" ], "pascal": [ - "procedure SetInterfaceRootTextColor(clr: Color)" + "procedure DisableInterface()" ] } }, { - "signature": "void set_interface_shadows(int radius,color clr,point_2d offset);", - "name": "set_interface_shadows", + "signature": "void draw_interface();", + "name": "draw_interface", "method_name": null, - "unique_global_name": "set_interface_shadows", + "unique_global_name": "draw_interface", "unique_method_name": null, "suffix_name": null, - "description": "Sets the style of all interface shadows. Use a fully transparent color to disable them.", + "description": "Draws the user interface that all the previous calls (such as `start_panel`, `button`, etc) have created.\n\n**Make sure to call this!** Without calling it, the interface won't be visible.", "brief": null, "return": { "type": "void", @@ -52012,73 +48641,34 @@ "type_parameter": null }, "parameters": { - "radius": { - "type": "int", - "description": "The radius of the shadow's blur", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color of the shadows (commonly black, but can do coloured and semi-transparent too)", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "offset": { - "type": "point_2d", - "description": "The offset in x/y coordinates of the shadows from their casting elements", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def set_interface_shadows(radius, clr, offset):" - ], "cpp": [ - "void set_interface_shadows(int radius, color clr, point_2d offset)" + "void draw_interface()" + ], + "python": [ + "def draw_interface():" ], "csharp": [ - "public static void SplashKit.SetInterfaceShadows(int radius, Color clr, Point2D offset);" + "public static void SplashKit.DrawInterface();" ], "pascal": [ - "procedure SetInterfaceShadows(radius: Integer; clr: Color; offset: Point2D)" + "procedure DrawInterface()" ] } }, { - "signature": "void set_interface_spacing(int spacing,int padding);", - "name": "set_interface_spacing", + "signature": "void enable_interface();", + "name": "enable_interface", "method_name": null, - "unique_global_name": "set_interface_spacing", + "unique_global_name": "enable_interface", "unique_method_name": null, "suffix_name": null, - "description": "Sets the spacing within the interface.", + "description": "Re-enables the interface, reverses the effects of disabling the interface.", "brief": null, "return": { "type": "void", @@ -52089,60 +48679,34 @@ "type_parameter": null }, "parameters": { - "spacing": { - "type": "int", - "description": "The distance between elements", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "padding": { - "type": "int", - "description": "The padding within elements", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def set_interface_spacing(spacing, padding):" - ], "cpp": [ - "void set_interface_spacing(int spacing, int padding)" + "void enable_interface()" + ], + "python": [ + "def enable_interface():" ], "csharp": [ - "public static void SplashKit.SetInterfaceSpacing(int spacing, int padding);" + "public static void SplashKit.EnableInterface();" ], "pascal": [ - "procedure SetInterfaceSpacing(spacing: Integer; padding: Integer)" + "procedure EnableInterface()" ] } }, { - "signature": "void set_interface_style(interface_style style);", - "name": "set_interface_style", + "signature": "void end_inset(const string& name);", + "name": "end_inset", "method_name": null, - "unique_global_name": "set_interface_style", + "unique_global_name": "end_inset", "unique_method_name": null, "suffix_name": null, - "description": "Sets the interface style to one of the presets in the interface_style enum.", + "description": "Finishes the creation of an inset area.", "brief": null, "return": { "type": "void", @@ -52153,12 +48717,12 @@ "type_parameter": null }, "parameters": { - "style": { - "type": "interface_style", - "description": "The preset style to use", + "name": { + "type": "string", + "description": "The area's name - must match with `start_inset`", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -52172,28 +48736,28 @@ "static": "interface" }, "signatures": { - "python": [ - "def set_interface_style(style):" - ], "cpp": [ - "void set_interface_style(interface_style style)" + "void end_inset(const string &name)" + ], + "python": [ + "def end_inset(name):" ], "csharp": [ - "public static void SplashKit.SetInterfaceStyle(InterfaceStyle style);" + "public static void SplashKit.EndInset(string name);" ], "pascal": [ - "procedure SetInterfaceStyle(style: InterfaceStyle)" + "procedure EndInset(const name: String)" ] } }, { - "signature": "void set_interface_style(interface_style style,color clr);", - "name": "set_interface_style", + "signature": "void end_panel(const string& name);", + "name": "end_panel", "method_name": null, - "unique_global_name": "set_interface_style_with_color", + "unique_global_name": "end_panel", "unique_method_name": null, "suffix_name": null, - "description": "Sets the interface style to one of the presets in the interface_style enum.\nAlso accepts a color used to customize the interface.", + "description": "Finishes the creation of a panel.", "brief": null, "return": { "type": "void", @@ -52204,25 +48768,12 @@ "type_parameter": null }, "parameters": { - "style": { - "type": "interface_style", - "description": "The preset style to use", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "clr": { - "type": "color", - "description": "The color to style the interface after", + "name": { + "type": "string", + "description": "The name shown in the panel's titlebar - must match with `start_panel`", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -52232,33 +48783,32 @@ } }, "attributes": { - "suffix": "with_color", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def set_interface_style_with_color(style, clr):" - ], "cpp": [ - "void set_interface_style(interface_style style, color clr)" + "void end_panel(const string &name)" + ], + "python": [ + "def end_panel(name):" ], "csharp": [ - "public static void SplashKit.SetInterfaceStyle(InterfaceStyle style, Color clr);" + "public static void SplashKit.EndPanel(string name);" ], "pascal": [ - "procedure SetInterfaceStyle(style: InterfaceStyle; clr: Color)" + "procedure EndPanel(const name: String)" ] } }, { - "signature": "void set_interface_text_color(color clr);", - "name": "set_interface_text_color", + "signature": "void end_popup(const string& name);", + "name": "end_popup", "method_name": null, - "unique_global_name": "set_interface_text_color", + "unique_global_name": "end_popup", "unique_method_name": null, "suffix_name": null, - "description": "Sets the interface's text color.", + "description": "Finishes the creation of a popup.", "brief": null, "return": { "type": "void", @@ -52269,12 +48819,12 @@ "type_parameter": null }, "parameters": { - "clr": { - "type": "color", - "description": "The color to set text to", + "name": { + "type": "string", + "description": "The popup's name - must match with `start_popup`", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -52288,28 +48838,28 @@ "static": "interface" }, "signatures": { - "python": [ - "def set_interface_text_color(clr):" - ], "cpp": [ - "void set_interface_text_color(color clr)" + "void end_popup(const string &name)" + ], + "python": [ + "def end_popup(name):" ], "csharp": [ - "public static void SplashKit.SetInterfaceTextColor(Color clr);" + "public static void SplashKit.EndPopup(string name);" ], "pascal": [ - "procedure SetInterfaceTextColor(clr: Color)" + "procedure EndPopup(const name: String)" ] } }, { - "signature": "void set_layout_height(int height);", - "name": "set_layout_height", + "signature": "void end_treenode(const string& label_text);", + "name": "end_treenode", "method_name": null, - "unique_global_name": "set_layout_height", + "unique_global_name": "end_treenode", "unique_method_name": null, "suffix_name": null, - "description": "Sets the height of each row in the interface in pixels.\n0 resets to default.", + "description": "Finishes the creation of a tree node.", "brief": null, "return": { "type": "void", @@ -52320,12 +48870,12 @@ "type_parameter": null }, "parameters": { - "height": { - "type": "int", - "description": "Height of rows in pixels", + "label_text": { + "type": "string", + "description": "The node's name - must match with `start_treenode`", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -52339,28 +48889,28 @@ "static": "interface" }, "signatures": { - "python": [ - "def set_layout_height(height):" - ], "cpp": [ - "void set_layout_height(int height)" + "void end_treenode(const string &label_text)" + ], + "python": [ + "def end_treenode(label_text):" ], "csharp": [ - "public static void SplashKit.SetLayoutHeight(int height);" + "public static void SplashKit.EndTreenode(string labelText);" ], "pascal": [ - "procedure SetLayoutHeight(height: Integer)" + "procedure EndTreenode(const labelText: String)" ] } }, { - "signature": "void single_line_layout();", - "name": "single_line_layout", + "signature": "void enter_column();", + "name": "enter_column", "method_name": null, - "unique_global_name": "single_line_layout", + "unique_global_name": "enter_column", "unique_method_name": null, "suffix_name": null, - "description": "Starts layouting all elements onto a single row. Reset with `reset_layout()`.", + "description": "Begins placing elements inside the current column. Must be paired with a call to `leave_column`.", "brief": null, "return": { "type": "void", @@ -52377,164 +48927,85 @@ "static": "interface" }, "signatures": { - "python": [ - "def single_line_layout():" - ], "cpp": [ - "void single_line_layout()" + "void enter_column()" + ], + "python": [ + "def enter_column():" ], "csharp": [ - "public static void SplashKit.SingleLineLayout();" + "public static void SplashKit.EnterColumn();" ], "pascal": [ - "procedure SingleLineLayout()" + "procedure EnterColumn()" ] } }, { - "signature": "float slider(const float& value,float min_value,float max_value,const rectangle& rect);", - "name": "slider", + "signature": "int get_interface_label_width();", + "name": "get_interface_label_width", "method_name": null, - "unique_global_name": "slider_at_position", + "unique_global_name": "get_interface_label_width", "unique_method_name": null, "suffix_name": null, - "description": "Creates a slider at a specific position on screen.\nReturns the updated value of the slider.", + "description": "Returns the width of element labels.\n\nDefault is 60 pixels.", "brief": null, "return": { - "type": "float", - "description": "The updated value of the slider", + "type": "int", + "description": "The width of labels", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "value": { - "type": "float", - "description": "The current value of the slider", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "min_value": { - "type": "float", - "description": "The minimum value of the slider", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "max_value": { - "type": "float", - "description": "The maximum value of the slider", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "The rectangle to display the slider in", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { - "suffix": "at_position", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def slider_at_position(value, min_value, max_value, rect):" - ], "cpp": [ - "float slider(const float &value, float min_value, float max_value, const rectangle &rect)" + "int get_interface_label_width()" + ], + "python": [ + "def get_interface_label_width():" ], "csharp": [ - "public static float SplashKit.Slider(float value, float minValue, float maxValue, Rectangle rect);" + "public static int SplashKit.GetInterfaceLabelWidth();" ], "pascal": [ - "function Slider(const value: Single; minValue: Single; maxValue: Single; const rect: Rectangle): Single" + "function GetInterfaceLabelWidth(): Integer" ] } }, { - "signature": "float slider(const float& value,float min_value,float max_value);", - "name": "slider", + "signature": "bool header(const string& label_text);", + "name": "header", "method_name": null, - "unique_global_name": "slider", + "unique_global_name": "header", "unique_method_name": null, "suffix_name": null, - "description": "Creates a slider without a label.\nReturns the updated value of the slider.", + "description": "Creates a collapsable header with a label.\nReturns whether the header is expanded or not.\n\nNote: Unlike `start_panel` and other similar functions, there is\nno need to 'end' this one. Example usage:\n```c++\nif (header(\"Section A\"))\n{\n// elements inside header go here\n}\n```", "brief": null, "return": { - "type": "float", - "description": "The updated value of the slider", + "type": "bool", + "description": "Whether the header is expanded or not", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "value": { - "type": "float", - "description": "The current value of the slider", + "label_text": { + "type": "string", + "description": "The label to show in the header", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "min_value": { - "type": "float", - "description": "The minimum value of the slider", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "max_value": { - "type": "float", - "description": "The maximum value of the slider", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null @@ -52545,31 +49016,31 @@ "static": "interface" }, "signatures": { - "python": [ - "def slider(value, min_value, max_value):" - ], "cpp": [ - "float slider(const float &value, float min_value, float max_value)" + "bool header(const string &label_text)" + ], + "python": [ + "def header(label_text):" ], "csharp": [ - "public static float SplashKit.Slider(float value, float minValue, float maxValue);" + "public static bool SplashKit.Header(string labelText);" ], "pascal": [ - "function Slider(const value: Single; minValue: Single; maxValue: Single): Single" + "function Header(const labelText: String): Boolean" ] } }, { - "signature": "float slider(const string& label_text,const float& value,float min_value,float max_value);", - "name": "slider", + "signature": "color hsb_color_slider(const color& clr,const rectangle& rect);", + "name": "hsb_color_slider", "method_name": null, - "unique_global_name": "slider_labeled", + "unique_global_name": "hsb_color_slider_at_position", "unique_method_name": null, "suffix_name": null, - "description": "Creates a slider with a label.\nReturns the updated value of the slider.\n\nExample usage:\n```c++\nmy_float = slider(\"Percentage\", my_float, 0, 100);\n```", + "description": "Creates a set of HSBA (hue, saturation, brightness, alpha) sliders to adjust a color, at a specific position on screen.\nReturns the updated color value of the slider.", "brief": null, "return": { - "type": "float", + "type": "color", "description": "The updated value of the slider", "is_pointer": false, "is_reference": false, @@ -52577,9 +49048,9 @@ "type_parameter": null }, "parameters": { - "label_text": { - "type": "string", - "description": "The label to show in front of the slider", + "clr": { + "type": "color", + "description": "The current value of the color slider", "is_pointer": false, "is_const": true, "is_reference": true, @@ -52590,154 +49061,64 @@ "is_vector": false, "type_parameter": null }, - "value": { - "type": "float", - "description": "The current value of the slider", + "rect": { + "type": "rectangle", + "description": "The rectangle to display the slider in.", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "min_value": { - "type": "float", - "description": "The minimum value of the slider", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "max_value": { - "type": "float", - "description": "The maximum value of the slider", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "suffix": "labeled", + "suffix": "at_position", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def slider_labeled(label_text, value, min_value, max_value):" - ], "cpp": [ - "float slider(const string &label_text, const float &value, float min_value, float max_value)" - ], - "csharp": [ - "public static float SplashKit.Slider(string labelText, float value, float minValue, float maxValue);" + "color hsb_color_slider(const color &clr, const rectangle &rect)" ], - "pascal": [ - "function Slider(const labelText: String; const value: Single; minValue: Single; maxValue: Single): Single" - ] - } - }, - { - "signature": "void split_into_columns(int count);", - "name": "split_into_columns", - "method_name": null, - "unique_global_name": "split_into_columns", - "unique_method_name": null, - "suffix_name": null, - "description": "Adds `count` columns to the current layout, with equal widths", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "count": { - "type": "int", - "description": "Number of columns to add", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "interface", - "static": "interface" - }, - "signatures": { "python": [ - "def split_into_columns(count):" - ], - "cpp": [ - "void split_into_columns(int count)" + "def hsb_color_slider_at_position(clr, rect):" ], "csharp": [ - "public static void SplashKit.SplitIntoColumns(int count);" + "public static Color SplashKit.HSBColorSlider(Color clr, Rectangle rect);" ], "pascal": [ - "procedure SplitIntoColumns(count: Integer)" + "function HSBColorSlider(const clr: Color; const rect: Rectangle): Color" ] } }, { - "signature": "void split_into_columns(int count,int last_width);", - "name": "split_into_columns", + "signature": "color hsb_color_slider(const color& clr);", + "name": "hsb_color_slider", "method_name": null, - "unique_global_name": "split_into_columns_with_last_width", + "unique_global_name": "hsb_color_slider", "unique_method_name": null, "suffix_name": null, - "description": "Adds `count` columns to the current layout, with equal widths.\nHas extra parameter `last_width`, which lets you specify a specific\nwidth (in pixels) for the last column.", + "description": "Creates a set of HSBA (hue, saturation, brightness, alpha) sliders to adjust a color.\nReturns the updated color value of the slider.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "color", + "description": "The updated value of the slider", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "count": { - "type": "int", - "description": "Number of columns to add", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "last_width": { - "type": "int", - "description": "The width of the last column in pixels", + "clr": { + "type": "color", + "description": "The current value of the color slider", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -52747,49 +49128,48 @@ } }, "attributes": { - "suffix": "with_last_width", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def split_into_columns_with_last_width(count, last_width):" - ], "cpp": [ - "void split_into_columns(int count, int last_width)" + "color hsb_color_slider(const color &clr)" + ], + "python": [ + "def hsb_color_slider(clr):" ], "csharp": [ - "public static void SplashKit.SplitIntoColumns(int count, int lastWidth);" + "public static Color SplashKit.HSBColorSlider(Color clr);" ], "pascal": [ - "procedure SplitIntoColumns(count: Integer; lastWidth: Integer)" + "function HSBColorSlider(const clr: Color): Color" ] } }, { - "signature": "void split_into_columns_relative(int count,double last_width);", - "name": "split_into_columns_relative", + "signature": "color hsb_color_slider(const string& label_text,const color& clr);", + "name": "hsb_color_slider", "method_name": null, - "unique_global_name": "split_into_columns_relative_with_last_width", + "unique_global_name": "hsb_color_slider_labeled", "unique_method_name": null, "suffix_name": null, - "description": "Adds `count` columns to the current layout, with equal widths.\nHas extra parameter `last_width`, which lets you specify a specific\nwidth (relative to the width of the container, between 0 and 1) for the last column.", + "description": "Creates a set of HSBA (hue, saturation, brightness, alpha) sliders to adjust a color, with a label.\nReturns the updated color value of the slider.\n\nExample usage:\n```c++\nmy_color = hsb_color_slider(\"Player Color\", my_color);\n```", "brief": null, "return": { - "type": "void", - "description": null, + "type": "color", + "description": "The updated value of the slider", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "count": { - "type": "int", - "description": "Number of columns to add", + "label_text": { + "type": "string", + "description": "The label to show in front of the slider", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -52797,12 +49177,12 @@ "is_vector": false, "type_parameter": null }, - "last_width": { - "type": "double", - "description": "The width of the last column as percentage of the container's width (between 0 and 1)", + "clr": { + "type": "color", + "description": "The current value of the color slider", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -52812,37 +49192,37 @@ } }, "attributes": { - "suffix": "with_last_width", + "suffix": "labeled", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def split_into_columns_relative_with_last_width(count, last_width):" - ], "cpp": [ - "void split_into_columns_relative(int count, double last_width)" + "color hsb_color_slider(const string &label_text, const color &clr)" + ], + "python": [ + "def hsb_color_slider_labeled(label_text, clr):" ], "csharp": [ - "public static void SplashKit.SplitIntoColumnsRelative(int count, double lastWidth);" + "public static Color SplashKit.HSBColorSlider(string labelText, Color clr);" ], "pascal": [ - "procedure SplitIntoColumnsRelative(count: Integer; lastWidth: Double)" + "function HSBColorSlider(const labelText: String; const clr: Color): Color" ] } }, { - "signature": "void start_custom_layout();", - "name": "start_custom_layout", + "signature": "bool interface_enabled();", + "name": "interface_enabled", "method_name": null, - "unique_global_name": "start_custom_layout", + "unique_global_name": "interface_enabled", "unique_method_name": null, "suffix_name": null, - "description": "Clears the default layout so that a custom layout can be made.", + "description": "Returns if the interface is currently enabled or not.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "Whether the interface is currently enabled or not", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -52855,28 +49235,28 @@ "static": "interface" }, "signatures": { - "python": [ - "def start_custom_layout():" - ], "cpp": [ - "void start_custom_layout()" + "bool interface_enabled()" + ], + "python": [ + "def interface_enabled():" ], "csharp": [ - "public static void SplashKit.StartCustomLayout();" + "public static bool SplashKit.InterfaceEnabled();" ], "pascal": [ - "procedure StartCustomLayout()" + "function InterfaceEnabled(): Boolean" ] } }, { - "signature": "void start_inset(const string& name,const rectangle& rect);", - "name": "start_inset", + "signature": "void interface_style_panel(const rectangle& initial_rectangle);", + "name": "interface_style_panel", "method_name": null, - "unique_global_name": "start_inset_at_position", + "unique_global_name": "interface_style_panel", "unique_method_name": null, "suffix_name": null, - "description": "Starts the creation of an inset area inside an arbitrary rectangle.\n\nThe function **must** be accompanied by a call to `end_inset`\nwith the same name.", + "description": "A utility function to show a 'Style Panel', which will allows you to experiment with different interface styles.", "brief": null, "return": { "type": "void", @@ -52887,22 +49267,9 @@ "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name of the area", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { + "initial_rectangle": { "type": "rectangle", - "description": "The rectangle for the inset", + "description": "The initial position/size the panel starts off in", "is_pointer": false, "is_const": true, "is_reference": true, @@ -52915,33 +49282,32 @@ } }, "attributes": { - "suffix": "at_position", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def start_inset_at_position(name, rect):" - ], "cpp": [ - "void start_inset(const string &name, const rectangle &rect)" + "void interface_style_panel(const rectangle &initial_rectangle)" + ], + "python": [ + "def interface_style_panel(initial_rectangle):" ], "csharp": [ - "public static void SplashKit.StartInset(string name, Rectangle rect);" + "public static void SplashKit.InterfaceStylePanel(Rectangle initialRectangle);" ], "pascal": [ - "procedure StartInset(const name: String; const rect: Rectangle)" + "procedure InterfaceStylePanel(const initialRectangle: Rectangle)" ] } }, { - "signature": "void start_inset(const string& name,int height);", - "name": "start_inset", + "signature": "void label_element(const string& text);", + "name": "label_element", "method_name": null, - "unique_global_name": "start_inset", + "unique_global_name": "label_element", "unique_method_name": null, "suffix_name": null, - "description": "Starts the creation of an inset area inside a panel/popup.\n\nUse as follows:\n```c++\nstart_inset(\"Inset area\", 60);\n// elements inside area goes here\nend_inset(\"Inset area\");\n\n```\nThe function **must** be accompanied by a call to `end_inset`\nwith the same name.", + "description": "Creates a label with the given text.", "brief": null, "return": { "type": "void", @@ -52952,28 +49318,15 @@ "type_parameter": null }, "parameters": { - "name": { + "text": { "type": "string", - "description": "The name of the area", + "description": "The label to show", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "height": { - "type": "int", - "description": "Height of the inset area in pixels. -1 fills entire space. Use negative heights to fill _up to_ `height` away from the bottom", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null @@ -52984,41 +49337,41 @@ "static": "interface" }, "signatures": { - "python": [ - "def start_inset(name, height):" - ], "cpp": [ - "void start_inset(const string &name, int height)" + "void label_element(const string &text)" + ], + "python": [ + "def label_element(text):" ], "csharp": [ - "public static void SplashKit.StartInset(string name, int height);" + "public static void SplashKit.LabelElement(string text);" ], "pascal": [ - "procedure StartInset(const name: String; height: Integer)" + "procedure LabelElement(const text: String)" ] } }, { - "signature": "bool start_panel(const string& name,rectangle initial_rectangle);", - "name": "start_panel", + "signature": "void label_element(const string& text,const rectangle& rect);", + "name": "label_element", "method_name": null, - "unique_global_name": "start_panel", + "unique_global_name": "label_element_at_position", "unique_method_name": null, "suffix_name": null, - "description": "Starts the creation of a draggable panel with a title bar.\nReturns whether the panel is visible or not.\n\nUse as follows:\n```c++\nif (start_panel(\"My panel\", rectangle_from(0,0,100,100)))\n{\n// Rest of interface goes here\nend_panel(\"My panel\");\n}\n```\nAfter calling this, you can then call functions to\nadd elements such as buttons and text boxes inside the panel.\nThe function **must** be accompanied by a call to `end_panel`,\nthat is only called if the panel is visible, and is passed the same `name`.", + "description": "Creates a label at a specific position on screen.", "brief": null, "return": { - "type": "bool", - "description": "Whether the panel is visible or not", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { + "text": { "type": "string", - "description": "The name shown in the panel's titlebar", + "description": "The label to show", "is_pointer": false, "is_const": true, "is_reference": true, @@ -53029,12 +49382,12 @@ "is_vector": false, "type_parameter": null }, - "initial_rectangle": { + "rect": { "type": "rectangle", - "description": "The initial position/size the panel starts off in", + "description": "The rectangle to display the label in", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -53044,189 +49397,151 @@ } }, "attributes": { + "suffix": "at_position", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def start_panel(name, initial_rectangle):" - ], "cpp": [ - "bool start_panel(const string &name, rectangle initial_rectangle)" + "void label_element(const string &text, const rectangle &rect)" + ], + "python": [ + "def label_element_at_position(text, rect):" ], "csharp": [ - "public static bool SplashKit.StartPanel(string name, Rectangle initialRectangle);" + "public static void SplashKit.LabelElement(string text, Rectangle rect);" ], "pascal": [ - "function StartPanel(const name: String; initialRectangle: Rectangle): Boolean" + "procedure LabelElement(const text: String; const rect: Rectangle)" ] } }, { - "signature": "bool start_popup(const string& name);", - "name": "start_popup", + "signature": "bool last_element_changed();", + "name": "last_element_changed", "method_name": null, - "unique_global_name": "start_popup", + "unique_global_name": "last_element_changed", "unique_method_name": null, "suffix_name": null, - "description": "Starts the creation of a popup.\nReturns whether the popup is visible or not.\n\nUsage is the same as `start_panel`, other than the 'starting rectangle' will be automatically calculated.\nThe function **must** be accompanied by a call to `end_popup`\nwith the same name.", + "description": "Returns if the last created element was changed at all (such as dragged, typed in, etc)", "brief": null, "return": { "type": "bool", - "description": "Whether the popup is visible or not", + "description": "Whether the last created element was changed", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name of the popup", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def start_popup(name):" - ], "cpp": [ - "bool start_popup(const string &name)" + "bool last_element_changed()" + ], + "python": [ + "def last_element_changed():" ], "csharp": [ - "public static bool SplashKit.StartPopup(string name);" + "public static bool SplashKit.LastElementChanged();" ], "pascal": [ - "function StartPopup(const name: String): Boolean" + "function LastElementChanged(): Boolean" ] } }, { - "signature": "bool start_treenode(const string& label_text);", - "name": "start_treenode", + "signature": "bool last_element_confirmed();", + "name": "last_element_confirmed", "method_name": null, - "unique_global_name": "start_treenode", + "unique_global_name": "last_element_confirmed", "unique_method_name": null, "suffix_name": null, - "description": "Starts the creation of a tree node (such as those in a file tree view).\nReturns whether the tree node is expanded or not.\n\nUsage is the same as `start_panel`.\nThe function **must** be accompanied by a call to `end_treenode`\nwith the same name.", + "description": "Returns if the last created element was 'confirmed' (such as clicking a button, or hitting enter in a text box)", "brief": null, "return": { "type": "bool", - "description": "Whether the tree node is expanded or not", + "description": "Whether the last created element was confirmed", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "label_text": { - "type": "string", - "description": "The name of the node", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def start_treenode(label_text):" - ], "cpp": [ - "bool start_treenode(const string &label_text)" + "bool last_element_confirmed()" + ], + "python": [ + "def last_element_confirmed():" ], "csharp": [ - "public static bool SplashKit.StartTreenode(string labelText);" + "public static bool SplashKit.LastElementConfirmed();" ], "pascal": [ - "function StartTreenode(const labelText: String): Boolean" + "function LastElementConfirmed(): Boolean" ] } }, { - "signature": "string text_box(const string& value);", - "name": "text_box", + "signature": "void leave_column();", + "name": "leave_column", "method_name": null, - "unique_global_name": "text_box", + "unique_global_name": "leave_column", "unique_method_name": null, "suffix_name": null, - "description": "Creates a text entry box with a label.\nReturns the updated value of the text box.", + "description": "Stops placing elements inside the current column and moves to the next one.", "brief": null, "return": { - "type": "string", - "description": "The updated value of the text box", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "value": { - "type": "string", - "description": "The current value of the text box", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def text_box(value):" - ], "cpp": [ - "string text_box(const string &value)" + "void leave_column()" + ], + "python": [ + "def leave_column():" ], "csharp": [ - "public static string SplashKit.TextBox(string value);" + "public static void SplashKit.LeaveColumn();" ], "pascal": [ - "function TextBox(const value: String): String" + "procedure LeaveColumn()" ] } }, { - "signature": "string text_box(const string& value,const rectangle& rect);", - "name": "text_box", + "signature": "float number_box(const float& value,float step,const rectangle& rect);", + "name": "number_box", "method_name": null, - "unique_global_name": "text_box_at_position", + "unique_global_name": "number_box_at_position", "unique_method_name": null, "suffix_name": null, - "description": "Creates a text entry box at a specific position on screen.\nReturns the updated value of the text box.\n\nExample usage:\n```c++\nmy_string = text_box(\"Name\", my_string);\n```", + "description": "Creates a number entry box at a specific position on screen.\nReturns the updated value of the number box.", "brief": null, "return": { - "type": "string", - "description": "The updated value of the text box", + "type": "float", + "description": "The updated value of the slider", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -53234,8 +49549,8 @@ }, "parameters": { "value": { - "type": "string", - "description": "The current value of the text box", + "type": "float", + "description": "The current value of the number box", "is_pointer": false, "is_const": true, "is_reference": true, @@ -53246,9 +49561,22 @@ "is_vector": false, "type_parameter": null }, + "step": { + "type": "float", + "description": "The amount incremented when dragging on the box", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "rect": { "type": "rectangle", - "description": "The rectangle to display the button in", + "description": "The rectangle to display the slider in", "is_pointer": false, "is_const": true, "is_reference": true, @@ -53266,41 +49594,41 @@ "static": "interface" }, "signatures": { - "python": [ - "def text_box_at_position(value, rect):" - ], "cpp": [ - "string text_box(const string &value, const rectangle &rect)" + "float number_box(const float &value, float step, const rectangle &rect)" + ], + "python": [ + "def number_box_at_position(value, step, rect):" ], "csharp": [ - "public static string SplashKit.TextBox(string value, Rectangle rect);" + "public static float SplashKit.NumberBox(float value, float step, Rectangle rect);" ], "pascal": [ - "function TextBox(const value: String; const rect: Rectangle): String" + "function NumberBox(const value: Single; step: Single; const rect: Rectangle): Single" ] } }, { - "signature": "string text_box(const string& label_text,const string& value);", - "name": "text_box", + "signature": "float number_box(const float& value,float step);", + "name": "number_box", "method_name": null, - "unique_global_name": "text_box_labeled", + "unique_global_name": "number_box", "unique_method_name": null, "suffix_name": null, - "description": "Creates a text entry box with a label.\nReturns the updated value of the text box.\n\nExample usage:\n```c++\nmy_string = text_box(\"Name\", my_string);\n```", + "description": "Creates a number entry box with a label.\nReturns the updated value of the number box.", "brief": null, "return": { - "type": "string", - "description": "The updated value of the text box", + "type": "float", + "description": "The updated value of the slider", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "label_text": { - "type": "string", - "description": "The label to show in front of the text box", + "value": { + "type": "float", + "description": "The current value of the number box", "is_pointer": false, "is_const": true, "is_reference": true, @@ -53311,12 +49639,12 @@ "is_vector": false, "type_parameter": null }, - "value": { - "type": "string", - "description": "The current value of the text box", + "step": { + "type": "float", + "description": "The amount incremented when dragging on the box", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -53326,108 +49654,126 @@ } }, "attributes": { - "suffix": "labeled", "group": "interface", "static": "interface" }, "signatures": { - "python": [ - "def text_box_labeled(label_text, value):" - ], "cpp": [ - "string text_box(const string &label_text, const string &value)" + "float number_box(const float &value, float step)" + ], + "python": [ + "def number_box(value, step):" ], "csharp": [ - "public static string SplashKit.TextBox(string labelText, string value);" + "public static float SplashKit.NumberBox(float value, float step);" ], "pascal": [ - "function TextBox(const labelText: String; const value: String): String" + "function NumberBox(const value: Single; step: Single): Single" ] } - } - ], - "typedefs": [ - - ], - "structs": [ - - ], - "enums": [ - - ], - "defines": [ - - ] - }, - "json": { - "brief": "SplashKit Json allows you to create and read JSON objects.", - "description": "Splashkit's JSON library allows you to easily create or read JSON objects and\nmanipulate them to/from a JSON string or from a file containing a JSON\nstring. Create a new JSON object with a call to `create_json()` and\nread or write data to it by calling methods like\n`json_add_string(json j, string key, string value)` and\n`json_read_string(json j, string key)`.", - "functions": [ + }, { - "signature": "json create_json();", - "name": "create_json", + "signature": "float number_box(const string& label_text,const float& value,float step);", + "name": "number_box", "method_name": null, - "unique_global_name": "create_json", + "unique_global_name": "number_box_labeled", "unique_method_name": null, "suffix_name": null, - "description": "The empty `json` object returned can be filled with data and read by the\nfunctions and procedures prefixed with `json_add_` and `json_read_`", - "brief": "Creates an empty `json` object.", + "description": "Creates a number entry box with a label.\nReturns the updated value of the number box.\n\nExample usage:\n```c++\nmy_float = number_box(\"Percentage\", my_float, 1);\n```", + "brief": null, "return": { - "type": "json", - "description": "Returns an empty `json` object.", + "type": "float", + "description": "The updated value of the slider", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "label_text": { + "type": "string", + "description": "The label to show in front of the number box", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "value": { + "type": "float", + "description": "The current value of the number box", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "step": { + "type": "float", + "description": "The amount incremented when dragging on the box", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { - "class": "json", - "constructor": true, - "group": "json", - "static": "json" + "suffix": "labeled", + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def create_json():" - ], "cpp": [ - "json create_json()" + "float number_box(const string &label_text, const float &value, float step)" + ], + "python": [ + "def number_box_labeled(label_text, value, step):" ], "csharp": [ - "public static Json SplashKit.CreateJson();", - "public Json();" + "public static float SplashKit.NumberBox(string labelText, float value, float step);" ], "pascal": [ - "function CreateJson(): Json" + "function NumberBox(const labelText: String; const value: Single; step: Single): Single" ] } }, { - "signature": "json create_json(string json_string);", - "name": "create_json", + "signature": "void open_popup(const string& name);", + "name": "open_popup", "method_name": null, - "unique_global_name": "create_json_from_string", + "unique_global_name": "open_popup", "unique_method_name": null, "suffix_name": null, - "description": "`string json_string` must be valid JSON.\nThe `json` object returned can be filled with data and read by the functions\nand procedures prefixed with `json_add_` and `json_read_`", - "brief": "Creates a `json` object filled with JSON fields from `json_string`.", + "description": "Makes the popup named `name` open/popup at the cursor's position.", + "brief": null, "return": { - "type": "json", - "description": "Returns a `json` object filled with data from the parameter `string`.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "json_string": { + "name": { "type": "string", - "description": "The JSON formatted `string` to be converted to a `json` object.", + "description": "The popup's name. Must match with the same name used in `start_popup`", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -53437,36 +49783,32 @@ } }, "attributes": { - "class": "json", - "constructor": true, - "suffix": "from_string", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def create_json_from_string(json_string):" - ], "cpp": [ - "json create_json(string json_string)" + "void open_popup(const string &name)" + ], + "python": [ + "def open_popup(name):" ], "csharp": [ - "public static Json SplashKit.CreateJson(string jsonString);", - "public Json(string jsonString);" + "public static void SplashKit.OpenPopup(string name);" ], "pascal": [ - "function CreateJson(jsonString: String): Json" + "procedure OpenPopup(const name: String)" ] } }, { - "signature": "void free_all_json();", - "name": "free_all_json", - "method_name": "free_all", - "unique_global_name": "free_all_json", - "unique_method_name": ".free_all", + "signature": "void paragraph(const string& text);", + "name": "paragraph", + "method_name": null, + "unique_global_name": "paragraph", + "unique_method_name": null, "suffix_name": null, - "description": "Releases all of the `json` objects which have been loaded.", + "description": "Creates a paragraph of text that auto-wraps.", "brief": null, "return": { "type": "void", @@ -53477,36 +49819,47 @@ "type_parameter": null }, "parameters": { + "text": { + "type": "string", + "description": "The text to show", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { - "method": "free_all", - "static": "json", - "group": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def free_all_json():" - ], "cpp": [ - "void free_all_json()" + "void paragraph(const string &text)" + ], + "python": [ + "def paragraph(text):" ], "csharp": [ - "public static void Json.FreeAll();", - "public static void SplashKit.FreeAllJson();" + "public static void SplashKit.Paragraph(string text);" ], "pascal": [ - "procedure FreeAllJson()" + "procedure Paragraph(const text: String)" ] } }, { - "signature": "void free_json(json j);", - "name": "free_json", - "method_name": "free", - "unique_global_name": "free_json", - "unique_method_name": "json.free", + "signature": "void paragraph(const string& text,const rectangle& rect);", + "name": "paragraph", + "method_name": null, + "unique_global_name": "paragraph_at_position", + "unique_method_name": null, "suffix_name": null, - "description": "Frees the SplashKit resources associated with the `json` object.", + "description": "Creates a paragraph of text that auto-wraps at a specific position on screen.", "brief": null, "return": { "type": "void", @@ -53517,12 +49870,25 @@ "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object whose resources should be released.", + "text": { + "type": "string", + "description": "The text to show", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect": { + "type": "rectangle", + "description": "The rectangle to display the label in", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -53531,97 +49897,76 @@ "type_parameter": null } }, - "attributes": { - "class": "json", - "destructor": true, - "method": "free", - "self": "j", - "group": "json", - "static": "json" - }, + "attributes": { + "suffix": "at_position", + "group": "interface", + "static": "interface" + }, "signatures": { - "python": [ - "def free_json(j):" - ], "cpp": [ - "void free_json(json j)" + "void paragraph(const string &text, const rectangle &rect)" + ], + "python": [ + "def paragraph_at_position(text, rect):" ], "csharp": [ - "public void Json.Free();", - "public static void SplashKit.FreeJson(Json j);" + "public static void SplashKit.Paragraph(string text, Rectangle rect);" ], "pascal": [ - "procedure FreeJson(j: Json)" + "procedure Paragraph(const text: String; const rect: Rectangle)" ] } }, { - "signature": "int json_count_keys(json j);", - "name": "json_count_keys", - "method_name": "count_keys", - "unique_global_name": "json_count_keys", - "unique_method_name": "json.count_keys", + "signature": "void reset_layout();", + "name": "reset_layout", + "method_name": null, + "unique_global_name": "reset_layout", + "unique_method_name": null, "suffix_name": null, - "description": "Returns the count of keys in the top-level `json` object.", + "description": "Resets to the default layout of a single column with default height.", "brief": null, "return": { - "type": "int", - "description": "The count of keys in the top-level `json` object.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object to count keys.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { - "class": "json", - "method": "count_keys", - "self": "j", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_count_keys(j):" - ], "cpp": [ - "int json_count_keys(json j)" + "void reset_layout()" + ], + "python": [ + "def reset_layout():" ], "csharp": [ - "public int Json.CountKeys();", - "public static int SplashKit.JsonCountKeys(Json j);" + "public static void SplashKit.ResetLayout();" ], "pascal": [ - "function JsonCountKeys(j: Json): Integer" + "procedure ResetLayout()" ] } }, { - "signature": "json json_from_color(color clr);", - "name": "json_from_color", + "signature": "void set_interface_accent_color(color clr,float contrast);", + "name": "set_interface_accent_color", "method_name": null, - "unique_global_name": "json_from_color", + "unique_global_name": "set_interface_accent_color", "unique_method_name": null, "suffix_name": null, - "description": "Converts a `color` to a `json` object.", + "description": "Sets the color of accents in the interface, and the contrast of how strongly they appear when hovering/interacting.", "brief": null, "return": { - "type": "json", - "description": "The `color` serialized into a `json` object.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, @@ -53630,7 +49975,20 @@ "parameters": { "clr": { "type": "color", - "description": "The `color` to convert to `json`.", + "description": "The color of accents", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "contrast": { + "type": "float", + "description": "The strength of how much the accents show (between 0 and 1)", "is_pointer": false, "is_const": false, "is_reference": false, @@ -53643,48 +50001,48 @@ } }, "attributes": { - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_from_color(clr):" - ], "cpp": [ - "json json_from_color(color clr)" + "void set_interface_accent_color(color clr, float contrast)" + ], + "python": [ + "def set_interface_accent_color(clr, contrast):" ], "csharp": [ - "public static Json SplashKit.JsonFromColor(Color clr);" + "public static void SplashKit.SetInterfaceAccentColor(Color clr, float contrast);" ], "pascal": [ - "function JsonFromColor(clr: Color): Json" + "procedure SetInterfaceAccentColor(clr: Color; contrast: Single)" ] } }, { - "signature": "json json_from_file(const string& filename);", - "name": "json_from_file", - "method_name": "from_file", - "unique_global_name": "json_from_file", - "unique_method_name": ".from_file", + "signature": "void set_interface_border_color(color clr);", + "name": "set_interface_border_color", + "method_name": null, + "unique_global_name": "set_interface_border_color", + "unique_method_name": null, "suffix_name": null, - "description": "Reads a `json` object from a JSON string stored in `Resources/json/filename`\nand loads the data into the returned `json` object.", + "description": "Sets the interface's border color.", "brief": null, "return": { - "type": "json", - "description": "Returns the `json` object loaded from the JSON file in `filename`.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "filename": { - "type": "string", - "description": "The filename of the file to be written to `Resources/json/`.", + "clr": { + "type": "color", + "description": "The color to set borders to", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -53694,50 +50052,100 @@ } }, "attributes": { - "method": "from_file", - "static": "json", - "group": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_from_file(filename):" - ], "cpp": [ - "json json_from_file(const string &filename)" + "void set_interface_border_color(color clr)" + ], + "python": [ + "def set_interface_border_color(clr):" ], "csharp": [ - "public static Json Json.FromFile(string filename);", - "public static Json SplashKit.JsonFromFile(string filename);" + "public static void SplashKit.SetInterfaceBorderColor(Color clr);" ], "pascal": [ - "function JsonFromFile(const filename: String): Json" + "procedure SetInterfaceBorderColor(clr: Color)" ] } }, { - "signature": "json json_from_string(const string &j_string);", - "name": "json_from_string", - "method_name": "from_json_string", - "unique_global_name": "json_from_string", - "unique_method_name": ".from_json_string", + "signature": "void set_interface_colors_auto(color main_clr,color accent_clr,float contrast,float accent_contrast,float border_contrast);", + "name": "set_interface_colors_auto", + "method_name": null, + "unique_global_name": "set_interface_colors_auto", + "unique_method_name": null, "suffix_name": null, - "description": "Reads a `json` object from a `string` in the JSON format.", + "description": "A convenience function to set the majority of the interface's colors in one go.\nSome colors will be automatically chosen based on the parameters (such as text color).", "brief": null, "return": { - "type": "json", - "description": "Returns a `json` object loaded with data from `string j_string`.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j_string": { - "type": "string", - "description": "A `string` in the JSON format.", + "main_clr": { + "type": "color", + "description": "The main color of the interface - also decides if the interface is light or dark mode", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "accent_clr": { + "type": "color", + "description": "The color used to accent the interface - this will appear in highlighted areas", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "contrast": { + "type": "float", + "description": "The contrast between the frames of elements/containers and their internal elements", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "accent_contrast": { + "type": "float", + "description": "How strongly the accent color is used, for instance when highlighting elements", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "border_contrast": { + "type": "float", + "description": "Simply the opacity of the borders", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -53747,47 +50155,45 @@ } }, "attributes": { - "method": "from_json_string", - "static": "json", - "group": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_from_string(j_string):" - ], "cpp": [ - "json json_from_string(const string &j_string)" + "void set_interface_colors_auto(color main_clr, color accent_clr, float contrast, float accent_contrast, float border_contrast)" + ], + "python": [ + "def set_interface_colors_auto(main_clr, accent_clr, contrast, accent_contrast, border_contrast):" ], "csharp": [ - "public static Json Json.FromJsonString(string jString);", - "public static Json SplashKit.JsonFromString(string jString);" + "public static void SplashKit.SetInterfaceColorsAuto(Color mainClr, Color accentClr, float contrast, float accentContrast, float borderContrast);" ], "pascal": [ - "function JsonFromString(const jString: String): Json" + "procedure SetInterfaceColorsAuto(mainClr: Color; accentClr: Color; contrast: Single; accentContrast: Single; borderContrast: Single)" ] } }, { - "signature": "bool json_has_key(json j,string key);", - "name": "json_has_key", - "method_name": "has_key", - "unique_global_name": "json_has_key", - "unique_method_name": "json.has_key", + "signature": "void set_interface_element_color(color clr,float contrast);", + "name": "set_interface_element_color", + "method_name": null, + "unique_global_name": "set_interface_element_color", + "unique_method_name": null, "suffix_name": null, - "description": "Checks if the `json` object contains the given `string` key.", + "description": "Sets the main color of elements in the interface, and the contrast between their frame and internal pieces.", "brief": null, "return": { - "type": "bool", - "description": "Returns `true` if the `json j` object contains a key for `string` key.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object to check for the given key.", + "clr": { + "type": "color", + "description": "The color of elements", "is_pointer": false, "is_const": false, "is_reference": false, @@ -53798,9 +50204,9 @@ "is_vector": false, "type_parameter": null }, - "key": { - "type": "string", - "description": "The `string` key to be checked.", + "contrast": { + "type": "float", + "description": "The contrast between the frame of elements and their internal pieces (between 0 and 1)", "is_pointer": false, "is_const": false, "is_reference": false, @@ -53813,36 +50219,32 @@ } }, "attributes": { - "class": "json", - "method": "has_key", - "self": "j", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_has_key(j, key):" - ], "cpp": [ - "bool json_has_key(json j, string key)" + "void set_interface_element_color(color clr, float contrast)" + ], + "python": [ + "def set_interface_element_color(clr, contrast):" ], "csharp": [ - "public bool Json.HasKey(string key);", - "public static bool SplashKit.JsonHasKey(Json j, string key);" + "public static void SplashKit.SetInterfaceElementColor(Color clr, float contrast);" ], "pascal": [ - "function JsonHasKey(j: Json; key: String): Boolean" + "procedure SetInterfaceElementColor(clr: Color; contrast: Single)" ] } }, { - "signature": "void json_read_array(json j,string key,vector &out_result);", - "name": "json_read_array", - "method_name": "read_array", - "unique_global_name": "json_read_array_of_double", - "unique_method_name": "json.read_array_of_double", + "signature": "void set_interface_element_shadows(int radius,color clr,point_2d offset);", + "name": "set_interface_element_shadows", + "method_name": null, + "unique_global_name": "set_interface_element_shadows", + "unique_method_name": null, "suffix_name": null, - "description": "Reads an array of `double` values from the `json` object for\nthe given `string` key.", + "description": "Sets the style of element's shadows. Use a fully transparent color to disable them.", "brief": null, "return": { "type": "void", @@ -53853,9 +50255,9 @@ "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object from which data will be returned for the given key.", + "radius": { + "type": "int", + "description": "The radius of the shadow's blur", "is_pointer": false, "is_const": false, "is_reference": false, @@ -53866,9 +50268,9 @@ "is_vector": false, "type_parameter": null }, - "key": { - "type": "string", - "description": "The `string` key used to find data in the `json` object.", + "clr": { + "type": "color", + "description": "The color of the shadows (commonly black, but can do coloured and semi-transparent too)", "is_pointer": false, "is_const": false, "is_reference": false, @@ -53879,52 +50281,47 @@ "is_vector": false, "type_parameter": null }, - "out_result": { - "type": "vector", - "description": "The array which will be filled with the data stored for `string` key.", + "offset": { + "type": "point_2d", + "description": "The offset in x/y coordinates of the shadows from their casting elements", "is_pointer": false, "is_const": false, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ ], - "is_vector": true, - "type_parameter": "double" + "is_vector": false, + "type_parameter": null } }, "attributes": { - "class": "json", - "method": "read_array", - "self": "j", - "suffix": "of_double", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_read_array_of_double(j, key, out_result):" - ], "cpp": [ - "void json_read_array(json j, string key, vector &out_result)" + "void set_interface_element_shadows(int radius, color clr, point_2d offset)" + ], + "python": [ + "def set_interface_element_shadows(radius, clr, offset):" ], "csharp": [ - "public void Json.ReadArray(string key, ref List outResult);", - "public static void SplashKit.JsonReadArray(Json j, string key, ref List outResult);" + "public static void SplashKit.SetInterfaceElementShadows(int radius, Color clr, Point2D offset);" ], "pascal": [ - "procedure JsonReadArray(j: Json; key: String; var outResult: ArrayOfDouble)" + "procedure SetInterfaceElementShadows(radius: Integer; clr: Color; offset: Point2D)" ] } }, { - "signature": "void json_read_array(json j,string key,vector &out_result);", - "name": "json_read_array", - "method_name": "read_array", - "unique_global_name": "json_read_array_of_json", - "unique_method_name": "json.read_array_of_json", + "signature": "void set_interface_font(const string& fnt);", + "name": "set_interface_font", + "method_name": null, + "unique_global_name": "set_interface_font_font_as_string", + "unique_method_name": null, "suffix_name": null, - "description": "Reads an array of `json` object values from the `json` object for\nthe given `string` key.", + "description": "Sets the interface's font.", "brief": null, "return": { "type": "void", @@ -53935,78 +50332,48 @@ "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object from which data will be returned for the given key.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "key": { + "fnt": { "type": "string", - "description": "The `string` key used to find data in the `json` object.", + "description": "The name of the font to be used", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - }, - "out_result": { - "type": "vector", - "description": "The array which will be filled with the data stored for `string` key.", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": true, - "type_parameter": "json" } }, "attributes": { - "class": "json", - "method": "read_array", - "self": "j", - "suffix": "of_json", - "group": "json", - "static": "json" + "suffix": "font_as_string", + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_read_array_of_json(j, key, out_result):" - ], "cpp": [ - "void json_read_array(json j, string key, vector &out_result)" + "void set_interface_font(const string &fnt)" + ], + "python": [ + "def set_interface_font_font_as_string(fnt):" ], "csharp": [ - "public void Json.ReadArray(string key, ref List outResult);", - "public static void SplashKit.JsonReadArray(Json j, string key, ref List outResult);" + "public static void SplashKit.SetInterfaceFont(string fnt);" ], "pascal": [ - "procedure JsonReadArray(j: Json; key: String; var outResult: ArrayOfJson)" + "procedure SetInterfaceFont(const fnt: String)" ] } }, { - "signature": "void json_read_array(json j,string key,vector &out_result);", - "name": "json_read_array", - "method_name": "read_array", - "unique_global_name": "json_read_array_of_string", - "unique_method_name": "json.read_array_of_string", + "signature": "void set_interface_font(font fnt);", + "name": "set_interface_font", + "method_name": null, + "unique_global_name": "set_interface_font", + "unique_method_name": null, "suffix_name": null, - "description": "Reads an array of `string` values from the `json` object for\nthe given `string` key.", + "description": "Sets the interface's font.", "brief": null, "return": { "type": "void", @@ -54017,9 +50384,9 @@ "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object from which data will be returned for the given key.", + "fnt": { + "type": "font", + "description": "The font to be used", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54029,10 +50396,48 @@ ], "is_vector": false, "type_parameter": null - }, - "key": { - "type": "string", - "description": "The `string` key used to find data in the `json` object.", + } + }, + "attributes": { + "group": "interface", + "static": "interface" + }, + "signatures": { + "cpp": [ + "void set_interface_font(font fnt)" + ], + "python": [ + "def set_interface_font(fnt):" + ], + "csharp": [ + "public static void SplashKit.SetInterfaceFont(Font fnt);" + ], + "pascal": [ + "procedure SetInterfaceFont(fnt: Font)" + ] + } + }, + { + "signature": "void set_interface_font_size(int size);", + "name": "set_interface_font_size", + "method_name": null, + "unique_global_name": "set_interface_font_size", + "unique_method_name": null, + "suffix_name": null, + "description": "Sets the interface's font size.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "size": { + "type": "int", + "description": "The font size to be used", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54042,53 +50447,35 @@ ], "is_vector": false, "type_parameter": null - }, - "out_result": { - "type": "vector", - "description": "The array which will be filled with the data stored for `string` key.", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": true, - "type_parameter": "string" } }, "attributes": { - "class": "json", - "method": "read_array", - "self": "j", - "suffix": "of_string", - "group": "json", - "static": "json" - }, - "signatures": { - "python": [ - "def json_read_array_of_string(j, key, out_result):" - ], + "group": "interface", + "static": "interface" + }, + "signatures": { "cpp": [ - "void json_read_array(json j, string key, vector &out_result)" + "void set_interface_font_size(int size)" + ], + "python": [ + "def set_interface_font_size(size):" ], "csharp": [ - "public void Json.ReadArray(string key, ref List outResult);", - "public static void SplashKit.JsonReadArray(Json j, string key, ref List outResult);" + "public static void SplashKit.SetInterfaceFontSize(int size);" ], "pascal": [ - "procedure JsonReadArray(j: Json; key: String; var outResult: ArrayOfString)" + "procedure SetInterfaceFontSize(size: Integer)" ] } }, { - "signature": "void json_read_array(json j,string key,vector &out_result);", - "name": "json_read_array", - "method_name": "read_array", - "unique_global_name": "json_read_array_of_bool", - "unique_method_name": "json.read_array_of_bool", + "signature": "void set_interface_label_width(int width);", + "name": "set_interface_label_width", + "method_name": null, + "unique_global_name": "set_interface_label_width", + "unique_method_name": null, "suffix_name": null, - "description": "Reads an array of `bool` values from the `json` object for\nthe given `string` key.", + "description": "Sets the width of element labels. This is the maximum width\nin pixels that a label can span in front of an element.\n\nDefault is 60 pixels.", "brief": null, "return": { "type": "void", @@ -54099,22 +50486,9 @@ "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object from which data will be returned for the given key.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "key": { - "type": "string", - "description": "The `string` key used to find data in the `json` object.", + "width": { + "type": "int", + "description": "The width of labels", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54124,66 +50498,48 @@ ], "is_vector": false, "type_parameter": null - }, - "out_result": { - "type": "vector", - "description": "The array which will be filled with the data stored for `string` key.", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": true, - "type_parameter": "bool" } }, "attributes": { - "class": "json", - "method": "read_array", - "self": "j", - "suffix": "of_bool", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_read_array_of_bool(j, key, out_result):" - ], "cpp": [ - "void json_read_array(json j, string key, vector &out_result)" + "void set_interface_label_width(int width)" + ], + "python": [ + "def set_interface_label_width(width):" ], "csharp": [ - "public void Json.ReadArray(string key, ref List outResult);", - "public static void SplashKit.JsonReadArray(Json j, string key, ref List outResult);" + "public static void SplashKit.SetInterfaceLabelWidth(int width);" ], "pascal": [ - "procedure JsonReadArray(j: Json; key: String; var outResult: ArrayOfBoolean)" + "procedure SetInterfaceLabelWidth(width: Integer)" ] } }, { - "signature": "bool json_read_bool(json j,string key);", - "name": "json_read_bool", - "method_name": "read_bool", - "unique_global_name": "json_read_bool", - "unique_method_name": "json.read_bool", + "signature": "void set_interface_panel_shadows(int radius,color clr,point_2d offset);", + "name": "set_interface_panel_shadows", + "method_name": null, + "unique_global_name": "set_interface_panel_shadows", + "unique_method_name": null, "suffix_name": null, - "description": "Reads a `bool` value from the `json` object for the given `string` key.", + "description": "Sets the style of panel's shadows. Use a fully transparent color to disable them.", "brief": null, "return": { - "type": "bool", - "description": "Returns the `bool` value stored at the `string` key.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object from which data will be returned for the given key.", + "radius": { + "type": "int", + "description": "The radius of the shadow's blur", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54194,9 +50550,22 @@ "is_vector": false, "type_parameter": null }, - "key": { - "type": "string", - "description": "The `string` key used to find data in the `json` object.", + "clr": { + "type": "color", + "description": "The color of the shadows (commonly black, but can do coloured and semi-transparent too)", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "offset": { + "type": "point_2d", + "description": "The offset in x/y coordinates of the shadows from their casting elements", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54209,62 +50578,45 @@ } }, "attributes": { - "class": "json", - "method": "read_bool", - "self": "j", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_read_bool(j, key):" - ], "cpp": [ - "bool json_read_bool(json j, string key)" + "void set_interface_panel_shadows(int radius, color clr, point_2d offset)" + ], + "python": [ + "def set_interface_panel_shadows(radius, clr, offset):" ], "csharp": [ - "public bool Json.ReadBool(string key);", - "public static bool SplashKit.JsonReadBool(Json j, string key);" + "public static void SplashKit.SetInterfacePanelShadows(int radius, Color clr, Point2D offset);" ], "pascal": [ - "function JsonReadBool(j: Json; key: String): Boolean" + "procedure SetInterfacePanelShadows(radius: Integer; clr: Color; offset: Point2D)" ] } }, { - "signature": "float json_read_number(json j,string key);", - "name": "json_read_number", - "method_name": "read_number", - "unique_global_name": "json_read_number", - "unique_method_name": "json.read_number", + "signature": "void set_interface_root_text_color(color clr);", + "name": "set_interface_root_text_color", + "method_name": null, + "unique_global_name": "set_interface_root_text_color", + "unique_method_name": null, "suffix_name": null, - "description": "Reads a `float` value from the `json` object for the given `string` key.", + "description": "Sets color of text drawn directly onto the main window", "brief": null, "return": { - "type": "float", - "description": "Returns the `float` value stored at the `string` key.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object from which data will be returned for the given key.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "key": { - "type": "string", - "description": "The `string` key used to find data in the `json` object.", + "clr": { + "type": "color", + "description": "The color to set text drawn on the main window to", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54277,49 +50629,45 @@ } }, "attributes": { - "class": "json", - "method": "read_number", - "self": "j", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_read_number(j, key):" - ], "cpp": [ - "float json_read_number(json j, string key)" + "void set_interface_root_text_color(color clr)" + ], + "python": [ + "def set_interface_root_text_color(clr):" ], "csharp": [ - "public float Json.ReadNumber(string key);", - "public static float SplashKit.JsonReadNumber(Json j, string key);" + "public static void SplashKit.SetInterfaceRootTextColor(Color clr);" ], "pascal": [ - "function JsonReadNumber(j: Json; key: String): Single" + "procedure SetInterfaceRootTextColor(clr: Color)" ] } }, { - "signature": "double json_read_number_as_double(json j,string key);", - "name": "json_read_number_as_double", - "method_name": "read_double", - "unique_global_name": "json_read_number_as_double", - "unique_method_name": "json.read_double", + "signature": "void set_interface_shadows(int radius,color clr,point_2d offset);", + "name": "set_interface_shadows", + "method_name": null, + "unique_global_name": "set_interface_shadows", + "unique_method_name": null, "suffix_name": null, - "description": "Reads a `double` value from the `json` object for the given `string` key.", + "description": "Sets the style of all interface shadows. Use a fully transparent color to disable them.", "brief": null, "return": { - "type": "double", - "description": "Returns the `double` value stored at the `string` key.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object from which data will be returned for the given key.", + "radius": { + "type": "int", + "description": "The radius of the shadow's blur", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54330,9 +50678,22 @@ "is_vector": false, "type_parameter": null }, - "key": { - "type": "string", - "description": "The `string` key used to find data in the `json` object.", + "clr": { + "type": "color", + "description": "The color of the shadows (commonly black, but can do coloured and semi-transparent too)", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "offset": { + "type": "point_2d", + "description": "The offset in x/y coordinates of the shadows from their casting elements", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54345,49 +50706,45 @@ } }, "attributes": { - "class": "json", - "method": "read_double", - "self": "j", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_read_number_as_double(j, key):" - ], "cpp": [ - "double json_read_number_as_double(json j, string key)" + "void set_interface_shadows(int radius, color clr, point_2d offset)" + ], + "python": [ + "def set_interface_shadows(radius, clr, offset):" ], "csharp": [ - "public double Json.ReadDouble(string key);", - "public static double SplashKit.JsonReadNumberAsDouble(Json j, string key);" + "public static void SplashKit.SetInterfaceShadows(int radius, Color clr, Point2D offset);" ], "pascal": [ - "function JsonReadNumberAsDouble(j: Json; key: String): Double" + "procedure SetInterfaceShadows(radius: Integer; clr: Color; offset: Point2D)" ] } }, { - "signature": "int json_read_number_as_int(json j,string key);", - "name": "json_read_number_as_int", - "method_name": "read_integer", - "unique_global_name": "json_read_number_as_int", - "unique_method_name": "json.read_integer", + "signature": "void set_interface_spacing(int spacing,int padding);", + "name": "set_interface_spacing", + "method_name": null, + "unique_global_name": "set_interface_spacing", + "unique_method_name": null, "suffix_name": null, - "description": "Reads a `integer` value from the `json` object for the given `string` key.", + "description": "Sets the spacing within the interface.", "brief": null, "return": { - "type": "int", - "description": "Returns the `integer` value stored at the `string` key.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object from which data will be returned for the given key.", + "spacing": { + "type": "int", + "description": "The distance between elements", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54398,9 +50755,9 @@ "is_vector": false, "type_parameter": null }, - "key": { - "type": "string", - "description": "The `string` key used to find data in the `json` object.", + "padding": { + "type": "int", + "description": "The padding within elements", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54413,62 +50770,45 @@ } }, "attributes": { - "class": "json", - "method": "read_integer", - "self": "j", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_read_number_as_int(j, key):" - ], "cpp": [ - "int json_read_number_as_int(json j, string key)" + "void set_interface_spacing(int spacing, int padding)" + ], + "python": [ + "def set_interface_spacing(spacing, padding):" ], "csharp": [ - "public int Json.ReadInteger(string key);", - "public static int SplashKit.JsonReadNumberAsInt(Json j, string key);" + "public static void SplashKit.SetInterfaceSpacing(int spacing, int padding);" ], "pascal": [ - "function JsonReadNumberAsInt(j: Json; key: String): Integer" + "procedure SetInterfaceSpacing(spacing: Integer; padding: Integer)" ] } }, { - "signature": "json json_read_object(json j,string key);", - "name": "json_read_object", - "method_name": "read_object", - "unique_global_name": "json_read_object", - "unique_method_name": "json.read_object", + "signature": "void set_interface_style(interface_style style);", + "name": "set_interface_style", + "method_name": null, + "unique_global_name": "set_interface_style", + "unique_method_name": null, "suffix_name": null, - "description": "Reads a `json` object value from the `json` object for the given `string` key.", + "description": "Sets the interface style to one of the presets in the interface_style enum.", "brief": null, "return": { - "type": "json", - "description": "Returns the `json` object value stored at the `string` key.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object from which data will be returned for the given key.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "key": { - "type": "string", - "description": "The `string` key used to find data in the `json` object.", + "style": { + "type": "interface_style", + "description": "The preset style to use", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54481,49 +50821,45 @@ } }, "attributes": { - "class": "json", - "method": "read_object", - "self": "j", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_read_object(j, key):" - ], "cpp": [ - "json json_read_object(json j, string key)" + "void set_interface_style(interface_style style)" + ], + "python": [ + "def set_interface_style(style):" ], "csharp": [ - "public Json Json.ReadObject(string key);", - "public static Json SplashKit.JsonReadObject(Json j, string key);" + "public static void SplashKit.SetInterfaceStyle(InterfaceStyle style);" ], "pascal": [ - "function JsonReadObject(j: Json; key: String): Json" + "procedure SetInterfaceStyle(style: InterfaceStyle)" ] } }, { - "signature": "string json_read_string(json j,string key);", - "name": "json_read_string", - "method_name": "read_string", - "unique_global_name": "json_read_string", - "unique_method_name": "json.read_string", + "signature": "void set_interface_style(interface_style style,color clr);", + "name": "set_interface_style", + "method_name": null, + "unique_global_name": "set_interface_style_with_color", + "unique_method_name": null, "suffix_name": null, - "description": "Reads a `string` value from the `json` object for the given `string` key.", + "description": "Sets the interface style to one of the presets in the interface_style enum.\nAlso accepts a color used to customize the interface.", "brief": null, "return": { - "type": "string", - "description": "Returns the `string` value stored at the `string` key.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object from which data will be returned for the given key.", + "style": { + "type": "interface_style", + "description": "The preset style to use", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54534,9 +50870,9 @@ "is_vector": false, "type_parameter": null }, - "key": { - "type": "string", - "description": "The `string` key used to find data in the `json` object.", + "clr": { + "type": "color", + "description": "The color to style the interface after", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54549,36 +50885,33 @@ } }, "attributes": { - "class": "json", - "method": "read_string", - "self": "j", - "group": "json", - "static": "json" + "suffix": "with_color", + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_read_string(j, key):" - ], "cpp": [ - "string json_read_string(json j, string key)" + "void set_interface_style(interface_style style, color clr)" + ], + "python": [ + "def set_interface_style_with_color(style, clr):" ], "csharp": [ - "public string Json.ReadString(string key);", - "public static string SplashKit.JsonReadString(Json j, string key);" + "public static void SplashKit.SetInterfaceStyle(InterfaceStyle style, Color clr);" ], "pascal": [ - "function JsonReadString(j: Json; key: String): String" + "procedure SetInterfaceStyle(style: InterfaceStyle; clr: Color)" ] } }, { - "signature": "void json_set_array(json j,string key,vector value);", - "name": "json_set_array", - "method_name": "add_array", - "unique_global_name": "json_set_array_of_string", - "unique_method_name": "json.add_array_of_string", + "signature": "void set_interface_text_color(color clr);", + "name": "set_interface_text_color", + "method_name": null, + "unique_global_name": "set_interface_text_color", + "unique_method_name": null, "suffix_name": null, - "description": "Adds an array of `string` values to the `json` object for\nthe given `string` key.", + "description": "Sets the interface's text color.", "brief": null, "return": { "type": "void", @@ -54589,22 +50922,9 @@ "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object where data will be inserted for the given key.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "key": { - "type": "string", - "description": "The `string` key where data will be stored in the `json` object.", + "clr": { + "type": "color", + "description": "The color to set text to", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54614,53 +50934,35 @@ ], "is_vector": false, "type_parameter": null - }, - "value": { - "type": "vector", - "description": "The value to be inserted into the `json` object.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": true, - "type_parameter": "string" } }, "attributes": { - "class": "json", - "method": "add_array", - "self": "j", - "suffix": "of_string", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_set_array_of_string(j, key, value):" - ], "cpp": [ - "void json_set_array(json j, string key, vector value)" + "void set_interface_text_color(color clr)" + ], + "python": [ + "def set_interface_text_color(clr):" ], "csharp": [ - "public void Json.AddArray(string key, List value);", - "public static void SplashKit.JsonSetArray(Json j, string key, List value);" + "public static void SplashKit.SetInterfaceTextColor(Color clr);" ], "pascal": [ - "procedure JsonSetArray(j: Json; key: String; value: ArrayOfString)" + "procedure SetInterfaceTextColor(clr: Color)" ] } }, { - "signature": "void json_set_array(json j,string key,vector value);", - "name": "json_set_array", - "method_name": "add_array", - "unique_global_name": "json_set_array_of_double", - "unique_method_name": "json.add_array_of_double", + "signature": "void set_layout_height(int height);", + "name": "set_layout_height", + "method_name": null, + "unique_global_name": "set_layout_height", + "unique_method_name": null, "suffix_name": null, - "description": "Adds an array of `double` values to the `json` object for\nthe given `string` key.", + "description": "Sets the height of each row in the interface in pixels.\n0 resets to default.", "brief": null, "return": { "type": "void", @@ -54671,35 +50973,9 @@ "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object where data will be inserted for the given key.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "key": { - "type": "string", - "description": "The `string` key where data will be stored in the `json` object.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "value": { - "type": "vector", - "description": "The value to be inserted into the `json` object.", + "height": { + "type": "int", + "description": "Height of rows in pixels", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54707,42 +50983,37 @@ "array_dimension_sizes": [ ], - "is_vector": true, - "type_parameter": "double" + "is_vector": false, + "type_parameter": null } }, "attributes": { - "class": "json", - "method": "add_array", - "self": "j", - "suffix": "of_double", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_set_array_of_double(j, key, value):" - ], "cpp": [ - "void json_set_array(json j, string key, vector value)" + "void set_layout_height(int height)" + ], + "python": [ + "def set_layout_height(height):" ], "csharp": [ - "public void Json.AddArray(string key, List value);", - "public static void SplashKit.JsonSetArray(Json j, string key, List value);" + "public static void SplashKit.SetLayoutHeight(int height);" ], "pascal": [ - "procedure JsonSetArray(j: Json; key: String; value: ArrayOfDouble)" + "procedure SetLayoutHeight(height: Integer)" ] } }, { - "signature": "void json_set_array(json j,string key,vector value);", - "name": "json_set_array", - "method_name": "add_array", - "unique_global_name": "json_set_array_of_bool", - "unique_method_name": "json.add_array_of_bool", + "signature": "void single_line_layout();", + "name": "single_line_layout", + "method_name": null, + "unique_global_name": "single_line_layout", + "unique_method_name": null, "suffix_name": null, - "description": "Adds an array of `bool` values to the `json` object for\nthe given `string` key.", + "description": "Starts layouting all elements onto a single row. Reset with `reset_layout()`.", "brief": null, "return": { "type": "void", @@ -54753,94 +51024,50 @@ "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object where data will be inserted for the given key.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "key": { - "type": "string", - "description": "The `string` key where data will be stored in the `json` object.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "value": { - "type": "vector", - "description": "The value to be inserted into the `json` object.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": true, - "type_parameter": "bool" - } }, "attributes": { - "class": "json", - "method": "add_array", - "self": "j", - "suffix": "of_bool", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_set_array_of_bool(j, key, value):" - ], "cpp": [ - "void json_set_array(json j, string key, vector value)" + "void single_line_layout()" + ], + "python": [ + "def single_line_layout():" ], "csharp": [ - "public void Json.AddArray(string key, List value);", - "public static void SplashKit.JsonSetArray(Json j, string key, List value);" + "public static void SplashKit.SingleLineLayout();" ], "pascal": [ - "procedure JsonSetArray(j: Json; key: String; value: ArrayOfBoolean)" + "procedure SingleLineLayout()" ] } }, { - "signature": "void json_set_array(json j,string key,vector value);", - "name": "json_set_array", - "method_name": "add_array", - "unique_global_name": "json_set_array_of_json", - "unique_method_name": "json.add_array_of_json", + "signature": "float slider(const float& value,float min_value,float max_value,const rectangle& rect);", + "name": "slider", + "method_name": null, + "unique_global_name": "slider_at_position", + "unique_method_name": null, "suffix_name": null, - "description": "Adds an array of `json` object values to the `json` object for\nthe given `string` key.", + "description": "Creates a slider at a specific position on screen.\nReturns the updated value of the slider.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "float", + "description": "The updated value of the slider", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object where data will be inserted for the given key.", + "value": { + "type": "float", + "description": "The current value of the slider", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -54848,9 +51075,9 @@ "is_vector": false, "type_parameter": null }, - "key": { - "type": "string", - "description": "The `string` key where data will be stored in the `json` object.", + "min_value": { + "type": "float", + "description": "The minimum value of the slider", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54861,9 +51088,9 @@ "is_vector": false, "type_parameter": null }, - "value": { - "type": "vector", - "description": "The value to be inserted into the `json` object.", + "max_value": { + "type": "float", + "description": "The maximum value of the slider", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54871,58 +51098,67 @@ "array_dimension_sizes": [ ], - "is_vector": true, - "type_parameter": "json" + "is_vector": false, + "type_parameter": null + }, + "rect": { + "type": "rectangle", + "description": "The rectangle to display the slider in", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null } }, "attributes": { - "class": "json", - "method": "add_array", - "self": "j", - "suffix": "of_json", - "group": "json", - "static": "json" + "suffix": "at_position", + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_set_array_of_json(j, key, value):" - ], "cpp": [ - "void json_set_array(json j, string key, vector value)" + "float slider(const float &value, float min_value, float max_value, const rectangle &rect)" + ], + "python": [ + "def slider_at_position(value, min_value, max_value, rect):" ], "csharp": [ - "public void Json.AddArray(string key, List value);", - "public static void SplashKit.JsonSetArray(Json j, string key, List value);" + "public static float SplashKit.Slider(float value, float minValue, float maxValue, Rectangle rect);" ], "pascal": [ - "procedure JsonSetArray(j: Json; key: String; value: ArrayOfJson)" + "function Slider(const value: Single; minValue: Single; maxValue: Single; const rect: Rectangle): Single" ] } }, { - "signature": "void json_set_bool(json j,string key,bool value);", - "name": "json_set_bool", - "method_name": "add_bool", - "unique_global_name": "json_set_bool", - "unique_method_name": "json.add_bool", + "signature": "float slider(const float& value,float min_value,float max_value);", + "name": "slider", + "method_name": null, + "unique_global_name": "slider", + "unique_method_name": null, "suffix_name": null, - "description": "Adds a `bool` value to the `json` object for the given `string` key.", + "description": "Creates a slider without a label.\nReturns the updated value of the slider.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "float", + "description": "The updated value of the slider", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object where data will be inserted for the given key.", + "value": { + "type": "float", + "description": "The current value of the slider", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -54930,9 +51166,9 @@ "is_vector": false, "type_parameter": null }, - "key": { - "type": "string", - "description": "The `string` key where data will be stored in the `json` object.", + "min_value": { + "type": "float", + "description": "The minimum value of the slider", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54943,9 +51179,9 @@ "is_vector": false, "type_parameter": null }, - "value": { - "type": "bool", - "description": "The value to be inserted into the `json` object.", + "max_value": { + "type": "float", + "description": "The maximum value of the slider", "is_pointer": false, "is_const": false, "is_reference": false, @@ -54958,52 +51194,48 @@ } }, "attributes": { - "class": "json", - "method": "add_bool", - "self": "j", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_set_bool(j, key, value):" - ], "cpp": [ - "void json_set_bool(json j, string key, bool value)" + "float slider(const float &value, float min_value, float max_value)" + ], + "python": [ + "def slider(value, min_value, max_value):" ], "csharp": [ - "public void Json.AddBool(string key, bool value);", - "public static void SplashKit.JsonSetBool(Json j, string key, bool value);" + "public static float SplashKit.Slider(float value, float minValue, float maxValue);" ], "pascal": [ - "procedure JsonSetBool(j: Json; key: String; value: Boolean)" + "function Slider(const value: Single; minValue: Single; maxValue: Single): Single" ] } }, { - "signature": "void json_set_number(json j,string key,int value);", - "name": "json_set_number", - "method_name": "add_number", - "unique_global_name": "json_set_number_integer", - "unique_method_name": "json.add_number_integer", + "signature": "float slider(const string& label_text,const float& value,float min_value,float max_value);", + "name": "slider", + "method_name": null, + "unique_global_name": "slider_labeled", + "unique_method_name": null, "suffix_name": null, - "description": "Adds an `int` value to the `json` object for the given `string` key.", + "description": "Creates a slider with a label.\nReturns the updated value of the slider.\n\nExample usage:\n```c++\nmy_float = slider(\"Percentage\", my_float, 0, 100);\n```", "brief": null, "return": { - "type": "void", - "description": null, + "type": "float", + "description": "The updated value of the slider", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object where data will be inserted for the given key.", + "label_text": { + "type": "string", + "description": "The label to show in front of the slider", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -55011,9 +51243,22 @@ "is_vector": false, "type_parameter": null }, - "key": { - "type": "string", - "description": "The `string` key where data will be stored in the `json` object.", + "value": { + "type": "float", + "description": "The current value of the slider", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "min_value": { + "type": "float", + "description": "The minimum value of the slider", "is_pointer": false, "is_const": false, "is_reference": false, @@ -55024,9 +51269,9 @@ "is_vector": false, "type_parameter": null }, - "value": { - "type": "int", - "description": "The value to be inserted into the `json` object.", + "max_value": { + "type": "float", + "description": "The maximum value of the slider", "is_pointer": false, "is_const": false, "is_reference": false, @@ -55039,37 +51284,33 @@ } }, "attributes": { - "class": "json", - "method": "add_number", - "self": "j", - "suffix": "integer", - "group": "json", - "static": "json" + "suffix": "labeled", + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_set_number_integer(j, key, value):" - ], "cpp": [ - "void json_set_number(json j, string key, int value)" + "float slider(const string &label_text, const float &value, float min_value, float max_value)" + ], + "python": [ + "def slider_labeled(label_text, value, min_value, max_value):" ], "csharp": [ - "public void Json.AddNumber(string key, int value);", - "public static void SplashKit.JsonSetNumber(Json j, string key, int value);" + "public static float SplashKit.Slider(string labelText, float value, float minValue, float maxValue);" ], "pascal": [ - "procedure JsonSetNumber(j: Json; key: String; value: Integer)" + "function Slider(const labelText: String; const value: Single; minValue: Single; maxValue: Single): Single" ] } }, { - "signature": "void json_set_number(json j,string key,double value);", - "name": "json_set_number", - "method_name": "add_number", - "unique_global_name": "json_set_number_double", - "unique_method_name": "json.add_number_double", + "signature": "void split_into_columns(int count);", + "name": "split_into_columns", + "method_name": null, + "unique_global_name": "split_into_columns", + "unique_method_name": null, "suffix_name": null, - "description": "Adds a `double` value to the `json` object for the given `string` key.", + "description": "Adds `count` columns to the current layout, with equal widths", "brief": null, "return": { "type": "void", @@ -55080,35 +51321,9 @@ "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object where data will be inserted for the given key.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "key": { - "type": "string", - "description": "The `string` key where data will be stored in the `json` object.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "value": { - "type": "double", - "description": "The value to be inserted into the `json` object.", + "count": { + "type": "int", + "description": "Number of columns to add", "is_pointer": false, "is_const": false, "is_reference": false, @@ -55121,37 +51336,32 @@ } }, "attributes": { - "class": "json", - "method": "add_number", - "self": "j", - "suffix": "double", - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_set_number_double(j, key, value):" - ], "cpp": [ - "void json_set_number(json j, string key, double value)" + "void split_into_columns(int count)" + ], + "python": [ + "def split_into_columns(count):" ], "csharp": [ - "public void Json.AddNumber(string key, double value);", - "public static void SplashKit.JsonSetNumber(Json j, string key, double value);" + "public static void SplashKit.SplitIntoColumns(int count);" ], "pascal": [ - "procedure JsonSetNumber(j: Json; key: String; value: Double)" + "procedure SplitIntoColumns(count: Integer)" ] } }, { - "signature": "void json_set_number(json j,string key,float value);", - "name": "json_set_number", - "method_name": "add_number", - "unique_global_name": "json_set_number_float", - "unique_method_name": "json.add_number_float", + "signature": "void split_into_columns(int count,int last_width);", + "name": "split_into_columns", + "method_name": null, + "unique_global_name": "split_into_columns_with_last_width", + "unique_method_name": null, "suffix_name": null, - "description": "Adds a `float` value to the `json` object for the given `string` key.", + "description": "Adds `count` columns to the current layout, with equal widths.\nHas extra parameter `last_width`, which lets you specify a specific\nwidth (in pixels) for the last column.", "brief": null, "return": { "type": "void", @@ -55162,22 +51372,9 @@ "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object where data will be inserted for the given key.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "key": { - "type": "string", - "description": "The `string` key where data will be stored in the `json` object.", + "count": { + "type": "int", + "description": "Number of columns to add", "is_pointer": false, "is_const": false, "is_reference": false, @@ -55188,9 +51385,9 @@ "is_vector": false, "type_parameter": null }, - "value": { - "type": "float", - "description": "The value to be inserted into the `json` object.", + "last_width": { + "type": "int", + "description": "The width of the last column in pixels", "is_pointer": false, "is_const": false, "is_reference": false, @@ -55203,37 +51400,33 @@ } }, "attributes": { - "class": "json", - "method": "add_number", - "self": "j", - "suffix": "float", - "group": "json", - "static": "json" + "suffix": "with_last_width", + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_set_number_float(j, key, value):" - ], "cpp": [ - "void json_set_number(json j, string key, float value)" + "void split_into_columns(int count, int last_width)" + ], + "python": [ + "def split_into_columns_with_last_width(count, last_width):" ], "csharp": [ - "public void Json.AddNumber(string key, float value);", - "public static void SplashKit.JsonSetNumber(Json j, string key, float value);" + "public static void SplashKit.SplitIntoColumns(int count, int lastWidth);" ], "pascal": [ - "procedure JsonSetNumber(j: Json; key: String; value: Single)" + "procedure SplitIntoColumns(count: Integer; lastWidth: Integer)" ] } }, { - "signature": "void json_set_object(json j,string key,json obj);", - "name": "json_set_object", - "method_name": "add_object", - "unique_global_name": "json_set_object", - "unique_method_name": "json.add_object", + "signature": "void split_into_columns_relative(int count,double last_width);", + "name": "split_into_columns_relative", + "method_name": null, + "unique_global_name": "split_into_columns_relative_with_last_width", + "unique_method_name": null, "suffix_name": null, - "description": "Adds a `json` object to the `json` object for the given `string` key.", + "description": "Adds `count` columns to the current layout, with equal widths.\nHas extra parameter `last_width`, which lets you specify a specific\nwidth (relative to the width of the container, between 0 and 1) for the last column.", "brief": null, "return": { "type": "void", @@ -55244,22 +51437,9 @@ "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object where data will be inserted for the given key.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "key": { - "type": "string", - "description": "The `string` key where data will be stored in the `json` object.", + "count": { + "type": "int", + "description": "Number of columns to add", "is_pointer": false, "is_const": false, "is_reference": false, @@ -55270,9 +51450,9 @@ "is_vector": false, "type_parameter": null }, - "obj": { - "type": "json", - "description": "The value to be inserted into the `json` object.", + "last_width": { + "type": "double", + "description": "The width of the last column as percentage of the container's width (between 0 and 1)", "is_pointer": false, "is_const": false, "is_reference": false, @@ -55285,36 +51465,71 @@ } }, "attributes": { - "class": "json", - "method": "add_object", - "self": "j", - "group": "json", - "static": "json" + "suffix": "with_last_width", + "group": "interface", + "static": "interface" }, "signatures": { + "cpp": [ + "void split_into_columns_relative(int count, double last_width)" + ], "python": [ - "def json_set_object(j, key, obj):" + "def split_into_columns_relative_with_last_width(count, last_width):" + ], + "csharp": [ + "public static void SplashKit.SplitIntoColumnsRelative(int count, double lastWidth);" ], + "pascal": [ + "procedure SplitIntoColumnsRelative(count: Integer; lastWidth: Double)" + ] + } + }, + { + "signature": "void start_custom_layout();", + "name": "start_custom_layout", + "method_name": null, + "unique_global_name": "start_custom_layout", + "unique_method_name": null, + "suffix_name": null, + "description": "Clears the default layout so that a custom layout can be made.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + }, + "attributes": { + "group": "interface", + "static": "interface" + }, + "signatures": { "cpp": [ - "void json_set_object(json j, string key, json obj)" + "void start_custom_layout()" + ], + "python": [ + "def start_custom_layout():" ], "csharp": [ - "public void Json.AddObject(string key, Json obj);", - "public static void SplashKit.JsonSetObject(Json j, string key, Json obj);" + "public static void SplashKit.StartCustomLayout();" ], "pascal": [ - "procedure JsonSetObject(j: Json; key: String; obj: Json)" + "procedure StartCustomLayout()" ] } }, { - "signature": "void json_set_string(json j,string key,string value);", - "name": "json_set_string", - "method_name": "add_string", - "unique_global_name": "json_set_string", - "unique_method_name": "json.add_string", + "signature": "void start_inset(const string& name,const rectangle& rect);", + "name": "start_inset", + "method_name": null, + "unique_global_name": "start_inset_at_position", + "unique_method_name": null, "suffix_name": null, - "description": "Adds a `string` value to the `json` object for the given `string` key.", + "description": "Starts the creation of an inset area inside an arbitrary rectangle.\n\nThe function **must** be accompanied by a call to `end_inset`\nwith the same name.", "brief": null, "return": { "type": "void", @@ -55325,25 +51540,12 @@ "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object where data will be inserted for the given key.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "key": { + "name": { "type": "string", - "description": "The `string` key where data will be stored in the `json` object.", + "description": "The name of the area", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -55351,12 +51553,12 @@ "is_vector": false, "type_parameter": null }, - "value": { - "type": "string", - "description": "The value to be inserted into the `json` object.", + "rect": { + "type": "rectangle", + "description": "The rectangle for the inset", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -55366,49 +51568,59 @@ } }, "attributes": { - "class": "json", - "method": "add_string", - "self": "j", - "group": "json", - "static": "json" + "suffix": "at_position", + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_set_string(j, key, value):" - ], "cpp": [ - "void json_set_string(json j, string key, string value)" + "void start_inset(const string &name, const rectangle &rect)" + ], + "python": [ + "def start_inset_at_position(name, rect):" ], "csharp": [ - "public void Json.AddString(string key, string value);", - "public static void SplashKit.JsonSetString(Json j, string key, string value);" + "public static void SplashKit.StartInset(string name, Rectangle rect);" ], "pascal": [ - "procedure JsonSetString(j: Json; key: String; value: String)" + "procedure StartInset(const name: String; const rect: Rectangle)" ] } }, { - "signature": "color json_to_color(json j);", - "name": "json_to_color", + "signature": "void start_inset(const string& name,int height);", + "name": "start_inset", "method_name": null, - "unique_global_name": "json_to_color", + "unique_global_name": "start_inset", "unique_method_name": null, "suffix_name": null, - "description": "Converts a `json` object to a `color` object.", + "description": "Starts the creation of an inset area inside a panel/popup.\n\nUse as follows:\n```c++\nstart_inset(\"Inset area\", 60);\n// elements inside area goes here\nend_inset(\"Inset area\");\n\n```\nThe function **must** be accompanied by a call to `end_inset`\nwith the same name.", "brief": null, "return": { - "type": "color", - "description": "The `color` deserialized from the `json` object.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` to convert to a `color`.", + "name": { + "type": "string", + "description": "The name of the area", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "height": { + "type": "int", + "description": "Height of the inset area in pixels. -1 fills entire space. Use negative heights to fill _up to_ `height` away from the bottom", "is_pointer": false, "is_const": false, "is_reference": false, @@ -55421,48 +51633,48 @@ } }, "attributes": { - "group": "json", - "static": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_to_color(j):" - ], "cpp": [ - "color json_to_color(json j)" + "void start_inset(const string &name, int height)" + ], + "python": [ + "def start_inset(name, height):" ], "csharp": [ - "public static Color SplashKit.JsonToColor(Json j);" + "public static void SplashKit.StartInset(string name, int height);" ], "pascal": [ - "function JsonToColor(j: Json): Color" + "procedure StartInset(const name: String; height: Integer)" ] } }, { - "signature": "void json_to_file(json j,const string& filename);", - "name": "json_to_file", - "method_name": "to_file", - "unique_global_name": "json_to_file", - "unique_method_name": ".to_file", + "signature": "bool start_panel(const string& name,rectangle initial_rectangle);", + "name": "start_panel", + "method_name": null, + "unique_global_name": "start_panel", + "unique_method_name": null, "suffix_name": null, - "description": "Writes the `json` object to a JSON string stored in `Resources/json/filename`.", + "description": "Starts the creation of a draggable panel with a title bar.\nReturns whether the panel is visible or not.\n\nUse as follows:\n```c++\nif (start_panel(\"My panel\", rectangle_from(0,0,100,100)))\n{\n// Rest of interface goes here\nend_panel(\"My panel\");\n}\n```\nAfter calling this, you can then call functions to\nadd elements such as buttons and text boxes inside the panel.\nThe function **must** be accompanied by a call to `end_panel`,\nthat is only called if the panel is visible, and is passed the same `name`.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "Whether the panel is visible or not", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object to be written to file.", + "name": { + "type": "string", + "description": "The name shown in the panel's titlebar", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -55470,12 +51682,12 @@ "is_vector": false, "type_parameter": null }, - "filename": { - "type": "string", - "description": "The filename of the file to be stored in `Resources/json/`", + "initial_rectangle": { + "type": "rectangle", + "description": "The initial position/size the panel starts off in", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -55485,50 +51697,48 @@ } }, "attributes": { - "method": "to_file", - "static": "json", - "group": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_to_file(j, filename):" - ], "cpp": [ - "void json_to_file(json j, const string &filename)" + "bool start_panel(const string &name, rectangle initial_rectangle)" + ], + "python": [ + "def start_panel(name, initial_rectangle):" ], "csharp": [ - "public static void Json.ToFile(Json j, string filename);", - "public static void SplashKit.JsonToFile(Json j, string filename);" + "public static bool SplashKit.StartPanel(string name, Rectangle initialRectangle);" ], "pascal": [ - "procedure JsonToFile(j: Json; const filename: String)" + "function StartPanel(const name: String; initialRectangle: Rectangle): Boolean" ] } }, { - "signature": "string json_to_string(json j);", - "name": "json_to_string", - "method_name": "to_json_string", - "unique_global_name": "json_to_string", - "unique_method_name": ".to_json_string", + "signature": "bool start_popup(const string& name);", + "name": "start_popup", + "method_name": null, + "unique_global_name": "start_popup", + "unique_method_name": null, "suffix_name": null, - "description": "Converts and returns the `json` object as a `string`.", + "description": "Starts the creation of a popup.\nReturns whether the popup is visible or not.\n\nUsage is the same as `start_panel`, other than the 'starting rectangle' will be automatically calculated.\nThe function **must** be accompanied by a call to `end_popup`\nwith the same name.", "brief": null, "return": { - "type": "string", - "description": "Returns the `json` object as a `string`.", + "type": "bool", + "description": "Whether the popup is visible or not", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "j": { - "type": "json", - "description": "The `json` object to be converted to a `string`.", + "name": { + "type": "string", + "description": "The name of the popup", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -55538,121 +51748,48 @@ } }, "attributes": { - "method": "to_json_string", - "static": "json", - "group": "json" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def json_to_string(j):" - ], "cpp": [ - "string json_to_string(json j)" - ], - "csharp": [ - "public static string Json.ToJsonString(Json j);", - "public static string SplashKit.JsonToString(Json j);" + "bool start_popup(const string &name)" ], - "pascal": [ - "function JsonToString(j: Json): String" - ] - } - } - ], - "typedefs": [ - { - "signature": "typedef struct sk_json *json;", - "name": "json", - "description": "The `json` type is used to refer to objects in the JSON format that can be\nmanipulated by the SplashKit `json` functions and procedures.\n\n\nAll `json` objects are:\n\n\n- created with `create_json()` or `create_json(string s)` or\n`json_from_string(string s)` or `json_from_file(json j)`\n\n\n- and must be released using `free_json()` (to release a specific `json` object)\nor `free_all_json()` (to release all loaded `json` objects).", - "brief": null, - "attributes": { - "class": "json", - "group": "json", - "static": "json" - }, - "is_function_pointer": false, - "aliased_type": null, - "aliased_identifier": null, - "is_pointer": false, - "new_identifier": null - } - ], - "structs": [ - - ], - "enums": [ - - ], - "defines": [ - - ] - }, - "logging": { - "brief": "SplashKit Logging facilitates streamlined logging with customizable severity levels and modes.", - "description": "SplashKit Logging module, allows users to initialize a custom logger with specified log levels and modes (console, file, or both). \nThe module provides functions to log messages at different severity levels (INFO, DEBUG, WARNING, ERROR, FATAL) with timestamped entries. \nUsers can close the logging process as needed, and the module handles customization for console and file output.", - "functions": [ - { - "signature": "void close_log_process ();", - "name": "close_log_process", - "method_name": null, - "unique_global_name": "close_log_process", - "unique_method_name": null, - "suffix_name": null, - "description": "Ensures propper memory clean-up prior to exit, if needed. Used in sk_init_looging ().", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "logging", - "static": "logging" - }, - "signatures": { "python": [ - "def close_log_process():" - ], - "cpp": [ - "void close_log_process()" + "def start_popup(name):" ], "csharp": [ - "public static void SplashKit.CloseLogProcess();" + "public static bool SplashKit.StartPopup(string name);" ], "pascal": [ - "procedure CloseLogProcess()" + "function StartPopup(const name: String): Boolean" ] } }, { - "signature": "void init_custom_logger (log_mode mode);", - "name": "init_custom_logger", + "signature": "bool start_treenode(const string& label_text);", + "name": "start_treenode", "method_name": null, - "unique_global_name": "init_custom_logger", + "unique_global_name": "start_treenode", "unique_method_name": null, "suffix_name": null, - "description": "Initialises the logging mode for logged messages to be written to the text-based console.", + "description": "Starts the creation of a tree node (such as those in a file tree view).\nReturns whether the tree node is expanded or not.\n\nUsage is the same as `start_panel`.\nThe function **must** be accompanied by a call to `end_treenode`\nwith the same name.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "Whether the tree node is expanded or not", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "mode": { - "type": "log_mode", - "description": "The mode of log output i.e. whether there should be output to the console, a text file, or both. Pass your choice of mode variable in by reference.", + "label_text": { + "type": "string", + "description": "The name of the node", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -55662,48 +51799,48 @@ } }, "attributes": { - "group": "logging", - "static": "logging" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def init_custom_logger(mode):" - ], "cpp": [ - "void init_custom_logger(log_mode mode)" + "bool start_treenode(const string &label_text)" + ], + "python": [ + "def start_treenode(label_text):" ], "csharp": [ - "public static void SplashKit.InitCustomLogger(LogMode mode);" + "public static bool SplashKit.StartTreenode(string labelText);" ], "pascal": [ - "procedure InitCustomLogger(mode: LogMode)" + "function StartTreenode(const labelText: String): Boolean" ] } }, { - "signature": "void init_custom_logger (string app_name,bool override_prev_log,log_mode mode);", - "name": "init_custom_logger", + "signature": "string text_box(const string& label_text,const string& value,const rectangle& rect);", + "name": "text_box", "method_name": null, - "unique_global_name": "init_custom_logger_name_override_mode", + "unique_global_name": "text_box_at_position", "unique_method_name": null, "suffix_name": null, - "description": "Initialises the logging mode between either writing to a file or both a file and the text-based console.", + "description": "Creates a text entry box at a specific position on screen.\nReturns the updated value of the text box.\n\nExample usage:\n```c++\nmy_string = text_box(\"Name\", my_string, rectangle_from(0,0,100,100));\n```", "brief": null, "return": { - "type": "void", - "description": null, + "type": "string", + "description": "The updated value of the text box", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "app_name": { + "label_text": { "type": "string", - "description": "The name of the application being written requiring logging", + "description": "Unique identifier for the text box (not drawn)", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -55711,12 +51848,12 @@ "is_vector": false, "type_parameter": null }, - "override_prev_log": { - "type": "bool", - "description": "Determines whether or not a new logging session should override the existing file, if any. Set this to false if you want new log messages to be appended to the bottom of the file; otherwise set it to true if you would like a new file to be created on top of the old one.", + "value": { + "type": "string", + "description": "The current value of the text box", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -55724,12 +51861,12 @@ "is_vector": false, "type_parameter": null }, - "mode": { - "type": "log_mode", - "description": "The mode of log output i.e. whether there should be output to the console, a text file, or both. Pass your choice of mode variable in by reference.", + "rect": { + "type": "rectangle", + "description": "The rectangle to display the button in", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -55739,49 +51876,49 @@ } }, "attributes": { - "suffix": "name_override_mode", - "group": "logging", - "static": "logging" + "suffix": "at_position", + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def init_custom_logger_name_override_mode(app_name, override_prev_log, mode):" - ], "cpp": [ - "void init_custom_logger(string app_name, bool override_prev_log, log_mode mode)" + "string text_box(const string &label_text, const string &value, const rectangle &rect)" + ], + "python": [ + "def text_box_at_position(label_text, value, rect):" ], "csharp": [ - "public static void SplashKit.InitCustomLogger(string appName, bool overridePrevLog, LogMode mode);" + "public static string SplashKit.TextBox(string labelText, string value, Rectangle rect);" ], "pascal": [ - "procedure InitCustomLogger(appName: String; overridePrevLog: Boolean; mode: LogMode)" + "function TextBox(const labelText: String; const value: String; const rect: Rectangle): String" ] } }, { - "signature": "void log(log_level level,string message);", - "name": "log", + "signature": "string text_box(const string& label_text,const string& value);", + "name": "text_box", "method_name": null, - "unique_global_name": "log", + "unique_global_name": "text_box", "unique_method_name": null, "suffix_name": null, - "description": "Send a message to the message log. The message will be written if the log level for\nthe program is set to display this.", + "description": "Creates a text entry box with a label.\nReturns the updated value of the text box.\n\nExample usage:\n```c++\nmy_string = text_box(\"Name\", my_string);\n```", "brief": null, "return": { - "type": "void", - "description": null, + "type": "string", + "description": "The updated value of the text box", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "level": { - "type": "log_level", - "description": "The level of the message to log", + "label_text": { + "type": "string", + "description": "Unique identifier for the text box (not drawn)", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -55789,12 +51926,12 @@ "is_vector": false, "type_parameter": null }, - "message": { + "value": { "type": "string", - "description": "The message to be shown", + "description": "The current value of the text box", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -55804,119 +51941,132 @@ } }, "attributes": { - "group": "logging", - "static": "logging" + "group": "interface", + "static": "interface" }, "signatures": { - "python": [ - "def log(level, message):" - ], "cpp": [ - "void log(log_level level, string message)" + "string text_box(const string &label_text, const string &value)" + ], + "python": [ + "def text_box(label_text, value):" ], "csharp": [ - "public static void SplashKit.Log(LogLevel level, string message);" + "public static string SplashKit.TextBox(string labelText, string value);" ], "pascal": [ - "procedure Log(level: LogLevel; message: String)" + "function TextBox(const labelText: String; const value: String): String" ] } - } - ], - "typedefs": [ - - ], - "structs": [ - - ], - "enums": [ - { - "signature": "enum log_level {NONE,INFO,DEBUG,WARNING,ERROR,FATAL};", - "name": "log_level", - "description": "Defines the available levels for log messages. This allows categorisation of log\nmessages which can then be filtered allowing messages below a given level to be\nignored.", - "brief": null, - "constants": { - "NONE": { - "description": "Output to the message log but without a specified level" - }, - "INFO": { - "description": "Output information to the message log" - }, - "DEBUG": { - "description": "Output a debug message to the message log" - }, - "WARNING": { - "description": "Output a warning message to the message log" - }, - "ERROR": { - "description": "Output an error message to the message log" - }, - "FATAL": { - "description": "Output an error message to the message log" - } - }, - "attributes": { - "group": "logging", - "static": "logging" - }, - "signatures": { - "python": "public enum {LogLevel.none = 0, LogLevel.info = 0, LogLevel.debug = 0, LogLevel.warning = 0, LogLevel.error = 0, LogLevel.fatal = 0}", - "cpp": "class log_level {NONE = 0, INFO = 0, DEBUG = 0, WARNING = 0, ERROR = 0, FATAL = 0};", - "csharp": "public enum {LogLevel.None = 0, LogLevel.Info = 0, LogLevel.Debug = 0, LogLevel.Warning = 0, LogLevel.Error = 0, LogLevel.Fatal = 0}", - "pascal": "public enum {LogLevel.None = 0, LogLevel.Info = 0, LogLevel.Debug = 0, LogLevel.Warning = 0, LogLevel.Error = 0, LogLevel.Fatal = 0}" - } }, { - "signature": "enum log_mode {LOG_NONE,LOG_CONSOLE,LOG_FILE_ONLY,LOG_CONSOLE_AND_FILE};", - "name": "log_mode", - "description": "Defines the available modes of logging, indicating where messages are written to.", + "signature": "string text_box(const string& label_text,const string& value,bool show_label);", + "name": "text_box", + "method_name": null, + "unique_global_name": "text_box_labeled", + "unique_method_name": null, + "suffix_name": null, + "description": "Creates a text entry box with a label that can be shown.\nReturns the updated value of the text box.\n\nExample usage:\n```c++\nmy_string = text_box(\"Name\", my_string, true);\n```", "brief": null, - "constants": { - "LOG_NONE": { - "description": "Set the logging mode to none for nothing to be logged to the console or a file." - }, - "LOG_CONSOLE": { - "description": "Ensure that output only directs to the on-screen, text-based console.." + "return": { + "type": "string", + "description": "The updated value of the text box", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "label_text": { + "type": "string", + "description": "Unique identifier for the text box (not drawn)", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null }, - "LOG_FILE_ONLY": { - "description": "Ensure that output only directs to a text file.." + "value": { + "type": "string", + "description": "The current value of the text box", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null }, - "LOG_CONSOLE_AND_FILE": { - "description": "Direct ouput to both the console and a file." + "show_label": { + "type": "bool", + "description": "Whether to show the label or not", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null } }, "attributes": { - "group": "logging", - "static": "logging" + "suffix": "labeled", + "group": "interface", + "static": "interface" }, "signatures": { - "python": "public enum {LogMode.log_none = 0, LogMode.log_console = 0, LogMode.log_file_only = 0, LogMode.log_console_and_file = 0}", - "cpp": "class log_mode {LOG_NONE = 0, LOG_CONSOLE = 0, LOG_FILE_ONLY = 0, LOG_CONSOLE_AND_FILE = 0};", - "csharp": "public enum {LogMode.LogNone = 0, LogMode.LogConsole = 0, LogMode.LogFileOnly = 0, LogMode.LogConsoleAndFile = 0}", - "pascal": "public enum {LogMode.LogNone = 0, LogMode.LogConsole = 0, LogMode.LogFileOnly = 0, LogMode.LogConsoleAndFile = 0}" + "cpp": [ + "string text_box(const string &label_text, const string &value, bool show_label)" + ], + "python": [ + "def text_box_labeled(label_text, value, show_label):" + ], + "csharp": [ + "public static string SplashKit.TextBox(string labelText, string value, bool showLabel);" + ], + "pascal": [ + "function TextBox(const labelText: String; const value: String; showLabel: Boolean): String" + ] } } + ], + "typedefs": [ + + ], + "structs": [ + + ], + "enums": [ + ], "defines": [ ] }, - "networking": { - "brief": "SplashKit's network-related functions allow you to communicate data\nacross networks.", - "description": "", + "json": { + "brief": "SplashKit Json allows you to create and read JSON objects.", + "description": "Splashkit's JSON library allows you to easily create or read JSON objects and\nmanipulate them to/from a JSON string or from a file containing a JSON\nstring. Create a new JSON object with a call to `create_json()` and\nread or write data to it by calling methods like\n`json_add_string(json j, string key, string value)` and\n`json_read_string(json j, string key)`.", "functions": [ { - "signature": "bool accept_all_new_connections();", - "name": "accept_all_new_connections", + "signature": "json create_json();", + "name": "create_json", "method_name": null, - "unique_global_name": "accept_all_new_connections", + "unique_global_name": "create_json", "unique_method_name": null, "suffix_name": null, - "description": "Accept new connections for all servers.", - "brief": null, + "description": "The empty `json` object returned can be filled with data and read by the\nfunctions and procedures prefixed with `json_add_` and `json_read_`", + "brief": "Creates an empty `json` object.", "return": { - "type": "bool", - "description": "True if there were accepted connections", + "type": "json", + "description": "Returns an empty `json` object.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -55925,45 +52075,48 @@ "parameters": { }, "attributes": { - "group": "networking", - "static": "networking" + "class": "json", + "constructor": true, + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def accept_all_new_connections():" - ], "cpp": [ - "bool accept_all_new_connections()" + "json create_json()" + ], + "python": [ + "def create_json():" ], "csharp": [ - "public static bool SplashKit.AcceptAllNewConnections();" + "public static Json SplashKit.CreateJson();", + "public Json();" ], "pascal": [ - "function AcceptAllNewConnections(): Boolean" + "function CreateJson(): Json" ] } }, { - "signature": "bool accept_new_connection(server_socket server);", - "name": "accept_new_connection", - "method_name": "accept_new_connection", - "unique_global_name": "accept_new_connection", - "unique_method_name": "server_socket.accept_new_connection", + "signature": "json create_json(string json_string);", + "name": "create_json", + "method_name": null, + "unique_global_name": "create_json_from_string", + "unique_method_name": null, "suffix_name": null, - "description": "Accept new connections for a server", - "brief": null, + "description": "`string json_string` must be valid JSON.\nThe `json` object returned can be filled with data and read by the functions\nand procedures prefixed with `json_add_` and `json_read_`", + "brief": "Creates a `json` object filled with JSON fields from `json_string`.", "return": { - "type": "bool", - "description": "True if a connection was accepted", + "type": "json", + "description": "Returns a `json` object filled with data from the parameter `string`.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "server": { - "type": "server_socket", - "description": "The server to check", + "json_string": { + "type": "string", + "description": "The JSON formatted `string` to be converted to a `json` object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -55976,36 +52129,76 @@ } }, "attributes": { - "class": "server_socket", - "method": "accept_new_connection", - "group": "networking", - "static": "networking", - "self": "server" + "class": "json", + "constructor": true, + "suffix": "from_string", + "group": "json", + "static": "json" }, "signatures": { + "cpp": [ + "json create_json(string json_string)" + ], "python": [ - "def accept_new_connection(server):" + "def create_json_from_string(json_string):" + ], + "csharp": [ + "public static Json SplashKit.CreateJson(string jsonString);", + "public Json(string jsonString);" ], + "pascal": [ + "function CreateJson(jsonString: String): Json" + ] + } + }, + { + "signature": "void free_all_json();", + "name": "free_all_json", + "method_name": "free_all", + "unique_global_name": "free_all_json", + "unique_method_name": ".free_all", + "suffix_name": null, + "description": "Releases all of the `json` objects which have been loaded.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + }, + "attributes": { + "method": "free_all", + "static": "json", + "group": "json" + }, + "signatures": { "cpp": [ - "bool accept_new_connection(server_socket server)" + "void free_all_json()" + ], + "python": [ + "def free_all_json():" ], "csharp": [ - "public bool ServerSocket.AcceptNewConnection();", - "public static bool SplashKit.AcceptNewConnection(ServerSocket server);" + "public static void Json.FreeAll();", + "public static void SplashKit.FreeAllJson();" ], "pascal": [ - "function AcceptNewConnection(server: ServerSocket): Boolean" + "procedure FreeAllJson()" ] } }, { - "signature": "void broadcast_message(const string &a_msg,server_socket svr);", - "name": "broadcast_message", - "method_name": "broadcast_message", - "unique_global_name": "broadcast_message", - "unique_method_name": "server_socket.broadcast_message", + "signature": "void free_json(json j);", + "name": "free_json", + "method_name": null, + "unique_global_name": "free_json", + "unique_method_name": null, "suffix_name": null, - "description": "Broadcast a message to all connections of a server.", + "description": "Frees the SplashKit resources associated with the `json` object.", "brief": null, "return": { "type": "void", @@ -56016,22 +52209,9 @@ "type_parameter": null }, "parameters": { - "a_msg": { - "type": "string", - "description": "The message to send", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "svr": { - "type": "server_socket", - "description": "The server to send the message to.", + "j": { + "type": "json", + "description": "The `json` object whose resources should be released.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -56044,52 +52224,51 @@ } }, "attributes": { - "class": "server_socket", - "method": "broadcast_message", - "self": "svr", - "group": "networking", - "static": "networking" + "class": "json", + "destructor": true, + "self": "j", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def broadcast_message(a_msg, svr):" - ], "cpp": [ - "void broadcast_message(const string &a_msg, server_socket svr)" + "void free_json(json j)" + ], + "python": [ + "def free_json(j):" ], "csharp": [ - "public void ServerSocket.BroadcastMessage(string aMsg);", - "public static void SplashKit.BroadcastMessage(string aMsg, ServerSocket svr);" + "public static void SplashKit.FreeJson(Json j);" ], "pascal": [ - "procedure BroadcastMessage(const aMsg: String; svr: ServerSocket)" + "procedure FreeJson(j: Json)" ] } }, { - "signature": "void broadcast_message(const string &a_msg);", - "name": "broadcast_message", - "method_name": null, - "unique_global_name": "broadcast_message_to_all", - "unique_method_name": null, + "signature": "int json_count_keys(json j);", + "name": "json_count_keys", + "method_name": "count_keys", + "unique_global_name": "json_count_keys", + "unique_method_name": "json.count_keys", "suffix_name": null, - "description": "Broadcase a message to all of the connections.", + "description": "Returns the count of keys in the top-level `json` object.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "int", + "description": "The count of keys in the top-level `json` object.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_msg": { - "type": "string", - "description": "The message to send", + "j": { + "type": "json", + "description": "The `json` object to count keys.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -56099,62 +52278,52 @@ } }, "attributes": { - "suffix": "to_all", - "group": "networking", - "static": "networking" + "class": "json", + "method": "count_keys", + "self": "j", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def broadcast_message_to_all(a_msg):" - ], "cpp": [ - "void broadcast_message(const string &a_msg)" + "int json_count_keys(json j)" + ], + "python": [ + "def json_count_keys(j):" ], "csharp": [ - "public static void SplashKit.BroadcastMessage(string aMsg);" + "public int Json.CountKeys();", + "public static int SplashKit.JsonCountKeys(Json j);" ], "pascal": [ - "procedure BroadcastMessage(const aMsg: String)" + "function JsonCountKeys(j: Json): Integer" ] } }, { - "signature": "void broadcast_message(const string &a_msg,const string &name);", - "name": "broadcast_message", + "signature": "json json_from_color(color clr);", + "name": "json_from_color", "method_name": null, - "unique_global_name": "broadcast_message_to_server_named", + "unique_global_name": "json_from_color", "unique_method_name": null, "suffix_name": null, - "description": "Broadcast a message to all connections of a server.", + "description": "Converts a `color` to a `json` object.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "json", + "description": "The `color` serialized into a `json` object.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_msg": { - "type": "string", - "description": "The message to send", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "name": { - "type": "string", - "description": "The name of the server to send the message to.", + "clr": { + "type": "color", + "description": "The `color` to convert to `json`.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -56164,84 +52333,98 @@ } }, "attributes": { - "suffix": "to_server_named", - "group": "networking", - "static": "networking" + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def broadcast_message_to_server_named(a_msg, name):" - ], "cpp": [ - "void broadcast_message(const string &a_msg, const string &name)" + "json json_from_color(color clr)" + ], + "python": [ + "def json_from_color(clr):" ], "csharp": [ - "public static void SplashKit.BroadcastMessage(string aMsg, string name);" + "public static Json SplashKit.JsonFromColor(Color clr);" ], "pascal": [ - "procedure BroadcastMessage(const aMsg: String; const name: String)" + "function JsonFromColor(clr: Color): Json" ] } }, { - "signature": "void check_network_activity();", - "name": "check_network_activity", - "method_name": null, - "unique_global_name": "check_network_activity", - "unique_method_name": null, + "signature": "json json_from_file(const string& filename);", + "name": "json_from_file", + "method_name": "from_file", + "unique_global_name": "json_from_file", + "unique_method_name": ".from_file", "suffix_name": null, - "description": "Check network activity, looking for new connections and messages.", + "description": "Reads a `json` object from a JSON string stored in `Resources/json/filename`\nand loads the data into the returned `json` object.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "json", + "description": "Returns the `json` object loaded from the JSON file in `filename`.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "filename": { + "type": "string", + "description": "The filename of the file to be written to `Resources/json/`.", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { - "group": "networking", - "static": "networking" + "method": "from_file", + "static": "json", + "group": "json" }, "signatures": { - "python": [ - "def check_network_activity():" - ], "cpp": [ - "void check_network_activity()" + "json json_from_file(const string &filename)" + ], + "python": [ + "def json_from_file(filename):" ], "csharp": [ - "public static void SplashKit.CheckNetworkActivity();" + "public static Json Json.FromFile(string filename);", + "public static Json SplashKit.JsonFromFile(string filename);" ], "pascal": [ - "procedure CheckNetworkActivity()" + "function JsonFromFile(const filename: String): Json" ] } }, { - "signature": "void clear_messages(const string &name);", - "name": "clear_messages", - "method_name": null, - "unique_global_name": "clear_messages_from_name", - "unique_method_name": null, + "signature": "json json_from_string(const string &j_string);", + "name": "json_from_string", + "method_name": "from_json_string", + "unique_global_name": "json_from_string", + "unique_method_name": ".from_json_string", "suffix_name": null, - "description": "Clear all of the messages from a server or connection with the supplied name.", + "description": "Reads a `json` object from a `string` in the JSON format.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "json", + "description": "Returns a `json` object loaded with data from `string j_string`.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { + "j_string": { "type": "string", - "description": "The name of the connection or the server to clear.", + "description": "A `string` in the JSON format.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -56254,46 +52437,60 @@ } }, "attributes": { - "suffix": "from_name", - "group": "networking", - "static": "networking" + "method": "from_json_string", + "static": "json", + "group": "json" }, "signatures": { - "python": [ - "def clear_messages_from_name(name):" - ], "cpp": [ - "void clear_messages(const string &name)" + "json json_from_string(const string &j_string)" + ], + "python": [ + "def json_from_string(j_string):" ], "csharp": [ - "public static void SplashKit.ClearMessages(string name);" + "public static Json Json.FromJsonString(string jString);", + "public static Json SplashKit.JsonFromString(string jString);" ], "pascal": [ - "procedure ClearMessages(const name: String)" + "function JsonFromString(const jString: String): Json" ] } }, { - "signature": "void clear_messages(connection a_connection);", - "name": "clear_messages", - "method_name": "clear_messages", - "unique_global_name": "clear_messages_from_connection", - "unique_method_name": "connection.clear_messages_from_connection", + "signature": "bool json_has_key(json j,string key);", + "name": "json_has_key", + "method_name": "has_key", + "unique_global_name": "json_has_key", + "unique_method_name": "json.has_key", "suffix_name": null, - "description": "Clear all of the messages from a connection.", + "description": "Checks if the `json` object contains the given `string` key.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "Returns `true` if the `json j` object contains a key for `string` key.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_connection": { - "type": "connection", - "description": "The connection", + "j": { + "type": "json", + "description": "The `json` object to check for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { + "type": "string", + "description": "The `string` key to be checked.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -56306,37 +52503,36 @@ } }, "attributes": { - "class": "connection", - "method": "clear_messages", - "suffix": "from_connection", - "group": "networking", - "static": "networking", - "self": "a_connection" + "class": "json", + "method": "has_key", + "self": "j", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def clear_messages_from_connection(a_connection):" - ], "cpp": [ - "void clear_messages(connection a_connection)" + "bool json_has_key(json j, string key)" + ], + "python": [ + "def json_has_key(j, key):" ], "csharp": [ - "public void Connection.ClearMessages();", - "public static void SplashKit.ClearMessages(Connection aConnection);" + "public bool Json.HasKey(string key);", + "public static bool SplashKit.JsonHasKey(Json j, string key);" ], "pascal": [ - "procedure ClearMessages(aConnection: Connection)" + "function JsonHasKey(j: Json; key: String): Boolean" ] } }, { - "signature": "void clear_messages(server_socket svr);", - "name": "clear_messages", - "method_name": "clear_messages", - "unique_global_name": "clear_messages_from_server", - "unique_method_name": "server_socket.clear_messages_from_server", + "signature": "void json_read_array(json j,string key,vector &out_result);", + "name": "json_read_array", + "method_name": "read_array", + "unique_global_name": "json_read_array_of_double", + "unique_method_name": "json.read_array_of_double", "suffix_name": null, - "description": "Clear all of the messages from a server.", + "description": "Reads an array of `double` values from the `json` object for\nthe given `string` key.", "brief": null, "return": { "type": "void", @@ -56347,9 +52543,22 @@ "type_parameter": null }, "parameters": { - "svr": { - "type": "server_socket", - "description": "The server to clear the messages from", + "j": { + "type": "json", + "description": "The `json` object from which data will be returned for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { + "type": "string", + "description": "The `string` key used to find data in the `json` object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -56359,40 +52568,53 @@ ], "is_vector": false, "type_parameter": null + }, + "out_result": { + "type": "vector", + "description": "The array which will be filled with the data stored for `string` key.", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": true, + "type_parameter": "double" } }, "attributes": { - "class": "server_socket", - "method": "clear_messages", - "suffix": "from_server", - "group": "networking", - "static": "networking", - "self": "svr" + "class": "json", + "method": "read_array", + "self": "j", + "suffix": "of_double", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def clear_messages_from_server(svr):" - ], "cpp": [ - "void clear_messages(server_socket svr)" + "void json_read_array(json j, string key, vector &out_result)" + ], + "python": [ + "def json_read_array_of_double(j, key, out_result):" ], "csharp": [ - "public void ServerSocket.ClearMessages();", - "public static void SplashKit.ClearMessages(ServerSocket svr);" + "public void Json.ReadArray(string key, ref List outResult);", + "public static void SplashKit.JsonReadArray(Json j, string key, ref List outResult);" ], "pascal": [ - "procedure ClearMessages(svr: ServerSocket)" + "procedure JsonReadArray(j: Json; key: String; var outResult: ArrayOfDouble)" ] } }, { - "signature": "void close_all_connections();", - "name": "close_all_connections", - "method_name": null, - "unique_global_name": "close_all_connections", - "unique_method_name": null, + "signature": "void json_read_array(json j,string key,vector &out_result);", + "name": "json_read_array", + "method_name": "read_array", + "unique_global_name": "json_read_array_of_json", + "unique_method_name": "json.read_array_of_json", "suffix_name": null, - "description": "Close all of the connections you have opened. This does not close\nconnections to servers.", + "description": "Reads an array of `json` object values from the `json` object for\nthe given `string` key.", "brief": null, "return": { "type": "void", @@ -56403,34 +52625,78 @@ "type_parameter": null }, "parameters": { + "j": { + "type": "json", + "description": "The `json` object from which data will be returned for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { + "type": "string", + "description": "The `string` key used to find data in the `json` object.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "out_result": { + "type": "vector", + "description": "The array which will be filled with the data stored for `string` key.", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": true, + "type_parameter": "json" + } }, "attributes": { - "group": "networking", - "static": "networking" + "class": "json", + "method": "read_array", + "self": "j", + "suffix": "of_json", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def close_all_connections():" - ], "cpp": [ - "void close_all_connections()" + "void json_read_array(json j, string key, vector &out_result)" + ], + "python": [ + "def json_read_array_of_json(j, key, out_result):" ], "csharp": [ - "public static void SplashKit.CloseAllConnections();" + "public void Json.ReadArray(string key, ref List outResult);", + "public static void SplashKit.JsonReadArray(Json j, string key, ref List outResult);" ], "pascal": [ - "procedure CloseAllConnections()" + "procedure JsonReadArray(j: Json; key: String; var outResult: ArrayOfJson)" ] } }, { - "signature": "void close_all_servers();", - "name": "close_all_servers", - "method_name": null, - "unique_global_name": "close_all_servers", - "unique_method_name": null, + "signature": "void json_read_array(json j,string key,vector &out_result);", + "name": "json_read_array", + "method_name": "read_array", + "unique_global_name": "json_read_array_of_string", + "unique_method_name": "json.read_array_of_string", "suffix_name": null, - "description": "Close all of the servers that are currently open.", + "description": "Reads an array of `string` values from the `json` object for\nthe given `string` key.", "brief": null, "return": { "type": "void", @@ -56441,47 +52707,104 @@ "type_parameter": null }, "parameters": { + "j": { + "type": "json", + "description": "The `json` object from which data will be returned for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { + "type": "string", + "description": "The `string` key used to find data in the `json` object.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "out_result": { + "type": "vector", + "description": "The array which will be filled with the data stored for `string` key.", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": true, + "type_parameter": "string" + } }, "attributes": { - "group": "networking", - "static": "networking" + "class": "json", + "method": "read_array", + "self": "j", + "suffix": "of_string", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def close_all_servers():" - ], "cpp": [ - "void close_all_servers()" + "void json_read_array(json j, string key, vector &out_result)" + ], + "python": [ + "def json_read_array_of_string(j, key, out_result):" ], "csharp": [ - "public static void SplashKit.CloseAllServers();" + "public void Json.ReadArray(string key, ref List outResult);", + "public static void SplashKit.JsonReadArray(Json j, string key, ref List outResult);" ], "pascal": [ - "procedure CloseAllServers()" + "procedure JsonReadArray(j: Json; key: String; var outResult: ArrayOfString)" ] } }, { - "signature": "bool close_connection(connection a_connection);", - "name": "close_connection", - "method_name": "close", - "unique_global_name": "close_connection", - "unique_method_name": "connection.close", + "signature": "void json_read_array(json j,string key,vector &out_result);", + "name": "json_read_array", + "method_name": "read_array", + "unique_global_name": "json_read_array_of_bool", + "unique_method_name": "json.read_array_of_bool", "suffix_name": null, - "description": "Close the connection", + "description": "Reads an array of `bool` values from the `json` object for\nthe given `string` key.", "brief": null, "return": { - "type": "bool", - "description": "True if this succeeds.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_connection": { - "type": "connection", - "description": "The connection to close", + "j": { + "type": "json", + "description": "The `json` object from which data will be returned for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { + "type": "string", + "description": "The `string` key used to find data in the `json` object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -56491,56 +52814,82 @@ ], "is_vector": false, "type_parameter": null + }, + "out_result": { + "type": "vector", + "description": "The array which will be filled with the data stored for `string` key.", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": true, + "type_parameter": "bool" } }, "attributes": { - "class": "connection", - "destructor": true, - "method": "close", - "group": "networking", - "static": "networking", - "self": "a_connection" + "class": "json", + "method": "read_array", + "self": "j", + "suffix": "of_bool", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def close_connection(a_connection):" - ], "cpp": [ - "bool close_connection(connection a_connection)" + "void json_read_array(json j, string key, vector &out_result)" + ], + "python": [ + "def json_read_array_of_bool(j, key, out_result):" ], "csharp": [ - "public bool Connection.Close();", - "public static bool SplashKit.CloseConnection(Connection aConnection);" + "public void Json.ReadArray(string key, ref List outResult);", + "public static void SplashKit.JsonReadArray(Json j, string key, ref List outResult);" ], "pascal": [ - "function CloseConnection(aConnection: Connection): Boolean" + "procedure JsonReadArray(j: Json; key: String; var outResult: ArrayOfBoolean)" ] } }, { - "signature": "bool close_connection(const string &name);", - "name": "close_connection", - "method_name": null, - "unique_global_name": "close_connection_named", - "unique_method_name": null, + "signature": "bool json_read_bool(json j,string key);", + "name": "json_read_bool", + "method_name": "read_bool", + "unique_global_name": "json_read_bool", + "unique_method_name": "json.read_bool", "suffix_name": null, - "description": "Close the connection", + "description": "Reads a `bool` value from the `json` object for the given `string` key.", "brief": null, "return": { "type": "bool", - "description": "True if this succeeds.", + "description": "Returns the `bool` value stored at the `string` key.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { + "j": { + "type": "json", + "description": "The `json` object from which data will be returned for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { "type": "string", - "description": "The name of the connection to close", + "description": "The `string` key used to find data in the `json` object.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -56550,46 +52899,62 @@ } }, "attributes": { - "suffix": "named", - "group": "networking", - "static": "networking" + "class": "json", + "method": "read_bool", + "self": "j", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def close_connection_named(name):" - ], "cpp": [ - "bool close_connection(const string &name)" + "bool json_read_bool(json j, string key)" + ], + "python": [ + "def json_read_bool(j, key):" ], "csharp": [ - "public static bool SplashKit.CloseConnection(string name);" + "public bool Json.ReadBool(string key);", + "public static bool SplashKit.JsonReadBool(Json j, string key);" ], "pascal": [ - "function CloseConnection(const name: String): Boolean" + "function JsonReadBool(j: Json; key: String): Boolean" ] } }, { - "signature": "void close_message(message msg);", - "name": "close_message", - "method_name": "close", - "unique_global_name": "close_message", - "unique_method_name": "message.close", + "signature": "float json_read_number(json j,string key);", + "name": "json_read_number", + "method_name": "read_number", + "unique_global_name": "json_read_number", + "unique_method_name": "json.read_number", "suffix_name": null, - "description": "Closes the message.", + "description": "Reads a `float` value from the `json` object for the given `string` key.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "float", + "description": "Returns the `float` value stored at the `string` key.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "msg": { - "type": "message", - "description": "The message to close", + "j": { + "type": "json", + "description": "The `json` object from which data will be returned for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { + "type": "string", + "description": "The `string` key used to find data in the `json` object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -56602,53 +52967,65 @@ } }, "attributes": { - "class": "message", - "destructor": true, - "method": "close", - "group": "networking", - "static": "networking", - "self": "msg" + "class": "json", + "method": "read_number", + "self": "j", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def close_message(msg):" - ], "cpp": [ - "void close_message(message msg)" + "float json_read_number(json j, string key)" + ], + "python": [ + "def json_read_number(j, key):" ], "csharp": [ - "public void Message.Close();", - "public static void SplashKit.CloseMessage(Message msg);" + "public float Json.ReadNumber(string key);", + "public static float SplashKit.JsonReadNumber(Json j, string key);" ], "pascal": [ - "procedure CloseMessage(msg: Message)" + "function JsonReadNumber(j: Json; key: String): Single" ] } }, { - "signature": "bool close_server(const string &name);", - "name": "close_server", - "method_name": null, - "unique_global_name": "close_server_named", - "unique_method_name": null, + "signature": "double json_read_number_as_double(json j,string key);", + "name": "json_read_number_as_double", + "method_name": "read_double", + "unique_global_name": "json_read_number_as_double", + "unique_method_name": "json.read_double", "suffix_name": null, - "description": "Closes the server with the indicated name.", + "description": "Reads a `double` value from the `json` object for the given `string` key.", "brief": null, "return": { - "type": "bool", - "description": "True if the server was closed successfully", + "type": "double", + "description": "Returns the `double` value stored at the `string` key.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { + "j": { + "type": "json", + "description": "The `json` object from which data will be returned for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { "type": "string", - "description": "The name of the server to close", + "description": "The `string` key used to find data in the `json` object.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -56658,46 +53035,62 @@ } }, "attributes": { - "suffix": "named", - "group": "networking", - "static": "networking" + "class": "json", + "method": "read_double", + "self": "j", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def close_server_named(name):" - ], "cpp": [ - "bool close_server(const string &name)" + "double json_read_number_as_double(json j, string key)" + ], + "python": [ + "def json_read_number_as_double(j, key):" ], "csharp": [ - "public static bool SplashKit.CloseServer(string name);" + "public double Json.ReadDouble(string key);", + "public static double SplashKit.JsonReadNumberAsDouble(Json j, string key);" ], "pascal": [ - "function CloseServer(const name: String): Boolean" + "function JsonReadNumberAsDouble(j: Json; key: String): Double" ] } }, { - "signature": "bool close_server(server_socket svr);", - "name": "close_server", - "method_name": "close", - "unique_global_name": "close_server", - "unique_method_name": "server_socket.close", + "signature": "int json_read_number_as_int(json j,string key);", + "name": "json_read_number_as_int", + "method_name": "read_integer", + "unique_global_name": "json_read_number_as_int", + "unique_method_name": "json.read_integer", "suffix_name": null, - "description": "Closes the server, all connections with clients will be shut and\nthe port will be closed.", + "description": "Reads a `integer` value from the `json` object for the given `string` key.", "brief": null, "return": { - "type": "bool", - "description": "True if the close was successful", + "type": "int", + "description": "Returns the `integer` value stored at the `string` key.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "svr": { - "type": "server_socket", - "description": "The server to close", + "j": { + "type": "json", + "description": "The `json` object from which data will be returned for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { + "type": "string", + "description": "The `string` key used to find data in the `json` object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -56710,53 +53103,65 @@ } }, "attributes": { - "class": "server_socket", - "destructor": true, - "method": "close", - "group": "networking", - "static": "networking", - "self": "svr" + "class": "json", + "method": "read_integer", + "self": "j", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def close_server(svr):" - ], "cpp": [ - "bool close_server(server_socket svr)" + "int json_read_number_as_int(json j, string key)" + ], + "python": [ + "def json_read_number_as_int(j, key):" ], "csharp": [ - "public bool ServerSocket.Close();", - "public static bool SplashKit.CloseServer(ServerSocket svr);" + "public int Json.ReadInteger(string key);", + "public static int SplashKit.JsonReadNumberAsInt(Json j, string key);" ], "pascal": [ - "function CloseServer(svr: ServerSocket): Boolean" + "function JsonReadNumberAsInt(j: Json; key: String): Integer" ] } }, { - "signature": "unsigned int connection_count(const string &name);", - "name": "connection_count", - "method_name": null, - "unique_global_name": "connection_count_named", - "unique_method_name": null, + "signature": "json json_read_object(json j,string key);", + "name": "json_read_object", + "method_name": "read_object", + "unique_global_name": "json_read_object", + "unique_method_name": "json.read_object", "suffix_name": null, - "description": "Returns the number of clients connected to a server.", + "description": "Reads a `json` object value from the `json` object for the given `string` key.", "brief": null, "return": { - "type": "unsigned int", - "description": "The number of connected clients", + "type": "json", + "description": "Returns the `json` object value stored at the `string` key.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { + "j": { + "type": "json", + "description": "The `json` object from which data will be returned for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { "type": "string", - "description": "The name of the server to check", + "description": "The `string` key used to find data in the `json` object.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -56765,47 +53170,63 @@ "type_parameter": null } }, - "attributes": { - "suffix": "named", - "group": "networking", - "static": "networking" + "attributes": { + "class": "json", + "method": "read_object", + "self": "j", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def connection_count_named(name):" - ], "cpp": [ - "unsigned int connection_count(const string &name)" + "json json_read_object(json j, string key)" + ], + "python": [ + "def json_read_object(j, key):" ], "csharp": [ - "public static uint SplashKit.ConnectionCount(string name);" + "public Json Json.ReadObject(string key);", + "public static Json SplashKit.JsonReadObject(Json j, string key);" ], "pascal": [ - "function ConnectionCount(const name: String): Cardinal" + "function JsonReadObject(j: Json; key: String): Json" ] } }, { - "signature": "unsigned int connection_count(server_socket server);", - "name": "connection_count", - "method_name": null, - "unique_global_name": "connection_count", - "unique_method_name": null, + "signature": "string json_read_string(json j,string key);", + "name": "json_read_string", + "method_name": "read_string", + "unique_global_name": "json_read_string", + "unique_method_name": "json.read_string", "suffix_name": null, - "description": "Returns the number of clients connected to a server.", + "description": "Reads a `string` value from the `json` object for the given `string` key.", "brief": null, "return": { - "type": "unsigned int", - "description": "The number of connected clients", + "type": "string", + "description": "Returns the `string` value stored at the `string` key.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "server": { - "type": "server_socket", - "description": "The server to check", + "j": { + "type": "json", + "description": "The `json` object from which data will be returned for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { + "type": "string", + "description": "The `string` key used to find data in the `json` object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -56818,49 +53239,62 @@ } }, "attributes": { - "class": "server_socket", - "getter": "connection_count", - "group": "networking", - "static": "networking", - "self": "server" + "class": "json", + "method": "read_string", + "self": "j", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def connection_count(server):" - ], "cpp": [ - "unsigned int connection_count(server_socket server)" + "string json_read_string(json j, string key)" + ], + "python": [ + "def json_read_string(j, key):" ], "csharp": [ - "public uint ServerSocket.ConnectionCount { get }", - "public static uint SplashKit.ConnectionCount(ServerSocket server);" + "public string Json.ReadString(string key);", + "public static string SplashKit.JsonReadString(Json j, string key);" ], "pascal": [ - "function ConnectionCount(server: ServerSocket): Cardinal" + "function JsonReadString(j: Json; key: String): String" ] } }, { - "signature": "unsigned int connection_ip(connection a_connection);", - "name": "connection_ip", - "method_name": null, - "unique_global_name": "connection_ip", - "unique_method_name": null, + "signature": "void json_set_array(json j,string key,vector value);", + "name": "json_set_array", + "method_name": "add_array", + "unique_global_name": "json_set_array_of_string", + "unique_method_name": "json.add_array_of_string", "suffix_name": null, - "description": "Gets the ip address of the passed in connection.", + "description": "Adds an array of `string` values to the `json` object for\nthe given `string` key.", "brief": null, "return": { - "type": "unsigned int", - "description": "The ip addres of the connection", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_connection": { - "type": "connection", - "description": "The connection", + "j": { + "type": "json", + "description": "The `json` object where data will be inserted for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { + "type": "string", + "description": "The `string` key where data will be stored in the `json` object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -56870,155 +53304,243 @@ ], "is_vector": false, "type_parameter": null + }, + "value": { + "type": "vector", + "description": "The value to be inserted into the `json` object.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": true, + "type_parameter": "string" } }, "attributes": { - "class": "connection", - "getter": "ip", - "group": "networking", - "static": "networking", - "self": "a_connection" + "class": "json", + "method": "add_array", + "self": "j", + "suffix": "of_string", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def connection_ip(a_connection):" - ], "cpp": [ - "unsigned int connection_ip(connection a_connection)" + "void json_set_array(json j, string key, vector value)" + ], + "python": [ + "def json_set_array_of_string(j, key, value):" ], "csharp": [ - "public uint Connection.IP { get }", - "public static uint SplashKit.ConnectionIP(Connection aConnection);" + "public void Json.AddArray(string key, List value);", + "public static void SplashKit.JsonSetArray(Json j, string key, List value);" ], "pascal": [ - "function ConnectionIP(aConnection: Connection): Cardinal" + "procedure JsonSetArray(j: Json; key: String; value: ArrayOfString)" ] } }, { - "signature": "unsigned int connection_ip(const string &name);", - "name": "connection_ip", - "method_name": null, - "unique_global_name": "connection_ip_from_name", - "unique_method_name": null, + "signature": "void json_set_array(json j,string key,vector value);", + "name": "json_set_array", + "method_name": "add_array", + "unique_global_name": "json_set_array_of_double", + "unique_method_name": "json.add_array_of_double", "suffix_name": null, - "description": "Gets the ip address of the connection with the supplied name.", + "description": "Adds an array of `double` values to the `json` object for\nthe given `string` key.", "brief": null, "return": { - "type": "unsigned int", - "description": "The connection's ip address", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { + "j": { + "type": "json", + "description": "The `json` object where data will be inserted for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { "type": "string", - "description": "The name of the connection", + "description": "The `string` key where data will be stored in the `json` object.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null + }, + "value": { + "type": "vector", + "description": "The value to be inserted into the `json` object.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": true, + "type_parameter": "double" } }, "attributes": { - "suffix": "from_name", - "group": "networking", - "static": "networking" + "class": "json", + "method": "add_array", + "self": "j", + "suffix": "of_double", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def connection_ip_from_name(name):" - ], "cpp": [ - "unsigned int connection_ip(const string &name)" + "void json_set_array(json j, string key, vector value)" + ], + "python": [ + "def json_set_array_of_double(j, key, value):" ], "csharp": [ - "public static uint SplashKit.ConnectionIP(string name);" + "public void Json.AddArray(string key, List value);", + "public static void SplashKit.JsonSetArray(Json j, string key, List value);" ], "pascal": [ - "function ConnectionIP(const name: String): Cardinal" + "procedure JsonSetArray(j: Json; key: String; value: ArrayOfDouble)" ] } }, { - "signature": "connection connection_named(const string &name);", - "name": "connection_named", - "method_name": null, - "unique_global_name": "connection_named", - "unique_method_name": null, + "signature": "void json_set_array(json j,string key,vector value);", + "name": "json_set_array", + "method_name": "add_array", + "unique_global_name": "json_set_array_of_bool", + "unique_method_name": "json.add_array_of_bool", "suffix_name": null, - "description": "Fetch the connection with the indicated name.", + "description": "Adds an array of `bool` values to the `json` object for\nthe given `string` key.", "brief": null, "return": { - "type": "connection", - "description": "The connection with that name", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { + "j": { + "type": "json", + "description": "The `json` object where data will be inserted for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { "type": "string", - "description": "The name of the connection to fetch", + "description": "The `string` key where data will be stored in the `json` object.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null + }, + "value": { + "type": "vector", + "description": "The value to be inserted into the `json` object.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": true, + "type_parameter": "bool" } }, "attributes": { - "group": "networking", - "static": "networking" + "class": "json", + "method": "add_array", + "self": "j", + "suffix": "of_bool", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def connection_named(name):" - ], "cpp": [ - "connection connection_named(const string &name)" + "void json_set_array(json j, string key, vector value)" + ], + "python": [ + "def json_set_array_of_bool(j, key, value):" ], "csharp": [ - "public static Connection SplashKit.ConnectionNamed(string name);" + "public void Json.AddArray(string key, List value);", + "public static void SplashKit.JsonSetArray(Json j, string key, List value);" ], "pascal": [ - "function ConnectionNamed(const name: String): Connection" + "procedure JsonSetArray(j: Json; key: String; value: ArrayOfBoolean)" ] } }, { - "signature": "unsigned short int connection_port(connection a_connection);", - "name": "connection_port", - "method_name": null, - "unique_global_name": "connection_port", - "unique_method_name": null, + "signature": "void json_set_array(json j,string key,vector value);", + "name": "json_set_array", + "method_name": "add_array", + "unique_global_name": "json_set_array_of_json", + "unique_method_name": "json.add_array_of_json", "suffix_name": null, - "description": "Gets the port of the connection.", + "description": "Adds an array of `json` object values to the `json` object for\nthe given `string` key.", "brief": null, "return": { - "type": "unsigned short", - "description": "The port of the connection.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_connection": { - "type": "connection", - "description": "The connection", + "j": { + "type": "json", + "description": "The `json` object where data will be inserted for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { + "type": "string", + "description": "The `string` key where data will be stored in the `json` object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -57028,55 +53550,95 @@ ], "is_vector": false, "type_parameter": null + }, + "value": { + "type": "vector", + "description": "The value to be inserted into the `json` object.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": true, + "type_parameter": "json" } }, "attributes": { - "class": "connection", - "getter": "port", - "group": "networking", - "static": "networking", - "self": "a_connection" + "class": "json", + "method": "add_array", + "self": "j", + "suffix": "of_json", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def connection_port(a_connection):" - ], "cpp": [ - "unsigned short connection_port(connection a_connection)" + "void json_set_array(json j, string key, vector value)" + ], + "python": [ + "def json_set_array_of_json(j, key, value):" ], "csharp": [ - "public ushort Connection.Port { get }", - "public static ushort SplashKit.ConnectionPort(Connection aConnection);" + "public void Json.AddArray(string key, List value);", + "public static void SplashKit.JsonSetArray(Json j, string key, List value);" ], "pascal": [ - "function ConnectionPort(aConnection: Connection): Word" + "procedure JsonSetArray(j: Json; key: String; value: ArrayOfJson)" ] } }, { - "signature": "unsigned short int connection_port(const string &name);", - "name": "connection_port", - "method_name": null, - "unique_global_name": "connection_port_from_name", - "unique_method_name": null, + "signature": "void json_set_bool(json j,string key,bool value);", + "name": "json_set_bool", + "method_name": "add_bool", + "unique_global_name": "json_set_bool", + "unique_method_name": "json.add_bool", "suffix_name": null, - "description": "Gets the part of the connection.", + "description": "Adds a `bool` value to the `json` object for the given `string` key.", "brief": null, "return": { - "type": "unsigned short", - "description": "The port of the connection", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { + "j": { + "type": "json", + "description": "The `json` object where data will be inserted for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { "type": "string", - "description": "The name of the connection", + "description": "The `string` key where data will be stored in the `json` object.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "value": { + "type": "bool", + "description": "The value to be inserted into the `json` object.", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -57086,49 +53648,65 @@ } }, "attributes": { - "suffix": "from_name", - "group": "networking", - "static": "networking" + "class": "json", + "method": "add_bool", + "self": "j", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def connection_port_from_name(name):" - ], "cpp": [ - "unsigned short connection_port(const string &name)" + "void json_set_bool(json j, string key, bool value)" + ], + "python": [ + "def json_set_bool(j, key, value):" ], "csharp": [ - "public static ushort SplashKit.ConnectionPort(string name);" + "public void Json.AddBool(string key, bool value);", + "public static void SplashKit.JsonSetBool(Json j, string key, bool value);" ], "pascal": [ - "function ConnectionPort(const name: String): Word" + "procedure JsonSetBool(j: Json; key: String; value: Boolean)" ] } }, { - "signature": "server_socket create_server(const string &name,unsigned short int port);", - "name": "create_server", - "method_name": null, - "unique_global_name": "create_server_with_port", - "unique_method_name": null, + "signature": "void json_set_number(json j,string key,int value);", + "name": "json_set_number", + "method_name": "add_number", + "unique_global_name": "json_set_number_integer", + "unique_method_name": "json.add_number_integer", "suffix_name": null, - "description": "Creates a new TCP server that can accept connections from other programs.", + "description": "Adds an `int` value to the `json` object for the given `string` key.", "brief": null, "return": { - "type": "server_socket", - "description": "A new server with the indicated details", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { + "j": { + "type": "json", + "description": "The `json` object where data will be inserted for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { "type": "string", - "description": "The name used to access the Server in splashkit", + "description": "The `string` key where data will be stored in the `json` object.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -57136,9 +53714,9 @@ "is_vector": false, "type_parameter": null }, - "port": { - "type": "unsigned short", - "description": "The port that clients will use to connect to the server", + "value": { + "type": "int", + "description": "The value to be inserted into the `json` object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -57151,52 +53729,53 @@ } }, "attributes": { - "class": "server_socket", - "constructor": true, - "suffix": "with_port", - "group": "networking", - "static": "networking" + "class": "json", + "method": "add_number", + "self": "j", + "suffix": "integer", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def create_server_with_port(name, port):" - ], "cpp": [ - "server_socket create_server(const string &name, unsigned short port)" + "void json_set_number(json j, string key, int value)" + ], + "python": [ + "def json_set_number_integer(j, key, value):" ], "csharp": [ - "public static ServerSocket SplashKit.CreateServer(string name, ushort port);", - "public ServerSocket(string name, ushort port);" + "public void Json.AddNumber(string key, int value);", + "public static void SplashKit.JsonSetNumber(Json j, string key, int value);" ], "pascal": [ - "function CreateServer(const name: String; port: Word): ServerSocket" + "procedure JsonSetNumber(j: Json; key: String; value: Integer)" ] } }, { - "signature": "server_socket create_server(const string &name,unsigned short int port,connection_type protocol);", - "name": "create_server", - "method_name": null, - "unique_global_name": "create_server_with_port_and_protocol", - "unique_method_name": null, + "signature": "void json_set_number(json j,string key,double value);", + "name": "json_set_number", + "method_name": "add_number", + "unique_global_name": "json_set_number_double", + "unique_method_name": "json.add_number_double", "suffix_name": null, - "description": "Creates a new server that can accept connections from other programs.", + "description": "Adds a `double` value to the `json` object for the given `string` key.", "brief": null, "return": { - "type": "server_socket", - "description": "A new server with the indicated details", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name used to access the Server in splashkit", + "j": { + "type": "json", + "description": "The `json` object where data will be inserted for the given key.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -57204,9 +53783,9 @@ "is_vector": false, "type_parameter": null }, - "port": { - "type": "unsigned short", - "description": "The port that clients will use to connect to the server", + "key": { + "type": "string", + "description": "The `string` key where data will be stored in the `json` object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -57217,9 +53796,9 @@ "is_vector": false, "type_parameter": null }, - "protocol": { - "type": "connection_type", - "description": "The protocol used by the server", + "value": { + "type": "double", + "description": "The value to be inserted into the `json` object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -57232,49 +53811,50 @@ } }, "attributes": { - "class": "server_socket", - "constructor": true, - "suffix": "with_port_and_protocol", - "group": "networking", - "static": "networking" + "class": "json", + "method": "add_number", + "self": "j", + "suffix": "double", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def create_server_with_port_and_protocol(name, port, protocol):" - ], "cpp": [ - "server_socket create_server(const string &name, unsigned short port, connection_type protocol)" + "void json_set_number(json j, string key, double value)" + ], + "python": [ + "def json_set_number_double(j, key, value):" ], "csharp": [ - "public static ServerSocket SplashKit.CreateServer(string name, ushort port, ConnectionType protocol);", - "public ServerSocket(string name, ushort port, ConnectionType protocol);" + "public void Json.AddNumber(string key, double value);", + "public static void SplashKit.JsonSetNumber(Json j, string key, double value);" ], "pascal": [ - "function CreateServer(const name: String; port: Word; protocol: ConnectionType): ServerSocket" + "procedure JsonSetNumber(j: Json; key: String; value: Double)" ] } }, { - "signature": "string dec_to_hex(unsigned int a_dec);", - "name": "dec_to_hex", - "method_name": null, - "unique_global_name": "dec_to_hex", - "unique_method_name": null, + "signature": "void json_set_number(json j,string key,float value);", + "name": "json_set_number", + "method_name": "add_number", + "unique_global_name": "json_set_number_float", + "unique_method_name": "json.add_number_float", "suffix_name": null, - "description": "Converts the supplied decimal integer into it's hexadecimal representation.\ne.g. 0x7F000001 from 2130706433", - "brief": "Converts a decimal integer into a hexadecimal string", + "description": "Adds a `float` value to the `json` object for the given `string` key.", + "brief": null, "return": { - "type": "string", - "description": "hexadecimal representation of the supplied decimal integer", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_dec": { - "type": "unsigned int", - "description": "decimal to be converted to a hexadecimal number string", + "j": { + "type": "json", + "description": "The `json` object where data will be inserted for the given key.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -57284,48 +53864,23 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "group": "networking", - "static": "networking" - }, - "signatures": { - "python": [ - "def dec_to_hex(a_dec):" - ], - "cpp": [ - "string dec_to_hex(unsigned int a_dec)" - ], - "csharp": [ - "public static string SplashKit.DecToHex(uint aDec);" - ], - "pascal": [ - "function DecToHex(aDec: Cardinal): String" - ] - } - }, - { - "signature": "string dec_to_ipv4(unsigned int ip);", - "name": "dec_to_ipv4", - "method_name": null, - "unique_global_name": "dec_to_ipv4", - "unique_method_name": null, - "suffix_name": null, - "description": "Decodes the supplied unsigned 32-bit integer into its ipv4 address form\ne.g. 2130706433 into 127.0.0.1", - "brief": "Decodes an integer into its ipv4 address representation", - "return": { - "type": "string", - "description": "ipv4 address string in X.X.X.X format", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "ip": { - "type": "unsigned int", - "description": "integer to be decoded", + }, + "key": { + "type": "string", + "description": "The `string` key where data will be stored in the `json` object.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "value": { + "type": "float", + "description": "The value to be inserted into the `json` object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -57338,45 +53893,76 @@ } }, "attributes": { - "group": "networking", - "static": "networking" + "class": "json", + "method": "add_number", + "self": "j", + "suffix": "float", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def dec_to_ipv4(ip):" - ], "cpp": [ - "string dec_to_ipv4(unsigned int ip)" + "void json_set_number(json j, string key, float value)" + ], + "python": [ + "def json_set_number_float(j, key, value):" ], "csharp": [ - "public static string SplashKit.DecToIpv4(uint ip);" + "public void Json.AddNumber(string key, float value);", + "public static void SplashKit.JsonSetNumber(Json j, string key, float value);" ], "pascal": [ - "function DecToIpv4(ip: Cardinal): String" + "procedure JsonSetNumber(j: Json; key: String; value: Single)" ] } }, { - "signature": "connection fetch_new_connection(server_socket server);", - "name": "fetch_new_connection", - "method_name": "fetch_new_connection", - "unique_global_name": "fetch_new_connection", - "unique_method_name": "server_socket.fetch_new_connection", + "signature": "void json_set_object(json j,string key,json obj);", + "name": "json_set_object", + "method_name": "add_object", + "unique_global_name": "json_set_object", + "unique_method_name": "json.add_object", "suffix_name": null, - "description": "Get the oldest new connections made to the server, and\nreduces the new connection count by 1.", + "description": "Adds a `json` object to the `json` object for the given `string` key.", "brief": null, "return": { - "type": "connection", - "description": "The oldest new connection", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "server": { - "type": "server_socket", - "description": "The server to check", + "j": { + "type": "json", + "description": "The `json` object where data will be inserted for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { + "type": "string", + "description": "The `string` key where data will be stored in the `json` object.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "obj": { + "type": "json", + "description": "The value to be inserted into the `json` object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -57389,52 +53975,78 @@ } }, "attributes": { - "class": "server_socket", - "method": "fetch_new_connection", - "group": "networking", - "static": "networking", - "self": "server" + "class": "json", + "method": "add_object", + "self": "j", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def fetch_new_connection(server):" - ], "cpp": [ - "connection fetch_new_connection(server_socket server)" + "void json_set_object(json j, string key, json obj)" + ], + "python": [ + "def json_set_object(j, key, obj):" ], "csharp": [ - "public Connection ServerSocket.FetchNewConnection();", - "public static Connection SplashKit.FetchNewConnection(ServerSocket server);" + "public void Json.AddObject(string key, Json obj);", + "public static void SplashKit.JsonSetObject(Json j, string key, Json obj);" ], "pascal": [ - "function FetchNewConnection(server: ServerSocket): Connection" + "procedure JsonSetObject(j: Json; key: String; obj: Json)" ] } }, { - "signature": "bool has_connection(const string &name);", - "name": "has_connection", - "method_name": null, - "unique_global_name": "has_connection", - "unique_method_name": null, + "signature": "void json_set_string(json j,string key,string value);", + "name": "json_set_string", + "method_name": "add_string", + "unique_global_name": "json_set_string", + "unique_method_name": "json.add_string", "suffix_name": null, - "description": "Does the connection with the supplied name exist?", + "description": "Adds a `string` value to the `json` object for the given `string` key.", "brief": null, "return": { - "type": "bool", - "description": "True if there is a connection with the supplied name", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { + "j": { + "type": "json", + "description": "The `json` object where data will be inserted for the given key.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "key": { "type": "string", - "description": "The name of the connection to check.", + "description": "The `string` key where data will be stored in the `json` object.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "value": { + "type": "string", + "description": "The value to be inserted into the `json` object.", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -57444,85 +54056,49 @@ } }, "attributes": { - "group": "networking", - "static": "networking" + "class": "json", + "method": "add_string", + "self": "j", + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def has_connection(name):" - ], "cpp": [ - "bool has_connection(const string &name)" - ], - "csharp": [ - "public static bool SplashKit.HasConnection(string name);" + "void json_set_string(json j, string key, string value)" ], - "pascal": [ - "function HasConnection(const name: String): Boolean" - ] - } - }, - { - "signature": "bool has_messages();", - "name": "has_messages", - "method_name": null, - "unique_global_name": "has_messages", - "unique_method_name": null, - "suffix_name": null, - "description": "Checks if there are any messages waiting to be read.", - "brief": null, - "return": { - "type": "bool", - "description": "True if there are any messages waiting to be read", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "getter": "has_messages", - "group": "networking", - "static": "networking" - }, - "signatures": { "python": [ - "def has_messages():" - ], - "cpp": [ - "bool has_messages()" + "def json_set_string(j, key, value):" ], "csharp": [ - "public static bool Networking.HasMessages { get }", - "public static bool SplashKit.HasMessages();" + "public void Json.AddString(string key, string value);", + "public static void SplashKit.JsonSetString(Json j, string key, string value);" ], "pascal": [ - "function HasMessages(): Boolean" + "procedure JsonSetString(j: Json; key: String; value: String)" ] } }, { - "signature": "bool has_messages(connection con);", - "name": "has_messages", + "signature": "color json_to_color(json j);", + "name": "json_to_color", "method_name": null, - "unique_global_name": "has_messages_on_connection", + "unique_global_name": "json_to_color", "unique_method_name": null, "suffix_name": null, - "description": "Checks if a connection has messages waiting to be read.", + "description": "Converts a `json` object to a `color` object.", "brief": null, "return": { - "type": "bool", - "description": "True if there are any messages on the connection.", + "type": "color", + "description": "The `color` deserialized from the `json` object.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "con": { - "type": "connection", - "description": "The connection", + "j": { + "type": "json", + "description": "The `json` to convert to a `color`.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -57535,50 +54111,58 @@ } }, "attributes": { - "class": "connection", - "getter": "has_messages", - "suffix": "on_connection", - "group": "networking", - "static": "networking", - "self": "con" + "group": "json", + "static": "json" }, "signatures": { - "python": [ - "def has_messages_on_connection(con):" - ], "cpp": [ - "bool has_messages(connection con)" + "color json_to_color(json j)" + ], + "python": [ + "def json_to_color(j):" ], "csharp": [ - "public bool Connection.HasMessages { get }", - "public static bool SplashKit.HasMessages(Connection con);" + "public static Color SplashKit.JsonToColor(Json j);" ], "pascal": [ - "function HasMessages(con: Connection): Boolean" + "function JsonToColor(j: Json): Color" ] } }, { - "signature": "bool has_messages(const string &name);", - "name": "has_messages", - "method_name": null, - "unique_global_name": "has_messages_on_name", - "unique_method_name": null, + "signature": "void json_to_file(json j,const string& filename);", + "name": "json_to_file", + "method_name": "to_file", + "unique_global_name": "json_to_file", + "unique_method_name": ".to_file", "suffix_name": null, - "description": "Checks if a server or connection has any messages.", + "description": "Writes the `json` object to a JSON string stored in `Resources/json/filename`.", "brief": null, "return": { - "type": "bool", - "description": "[description]", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { + "j": { + "type": "json", + "description": "The `json` object to be written to file.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "filename": { "type": "string", - "description": "The name of the server or connection to check.", + "description": "The filename of the file to be stored in `Resources/json/`", "is_pointer": false, "is_const": true, "is_reference": true, @@ -57591,46 +54175,47 @@ } }, "attributes": { - "suffix": "on_name", - "group": "networking", - "static": "networking" + "method": "to_file", + "static": "json", + "group": "json" }, "signatures": { - "python": [ - "def has_messages_on_name(name):" - ], "cpp": [ - "bool has_messages(const string &name)" + "void json_to_file(json j, const string &filename)" + ], + "python": [ + "def json_to_file(j, filename):" ], "csharp": [ - "public static bool SplashKit.HasMessages(string name);" + "public static void Json.ToFile(Json j, string filename);", + "public static void SplashKit.JsonToFile(Json j, string filename);" ], "pascal": [ - "function HasMessages(const name: String): Boolean" + "procedure JsonToFile(j: Json; const filename: String)" ] } }, { - "signature": "bool has_messages(server_socket svr);", - "name": "has_messages", - "method_name": null, - "unique_global_name": "has_messages_on_server", - "unique_method_name": null, + "signature": "string json_to_string(json j);", + "name": "json_to_string", + "method_name": "to_json_string", + "unique_global_name": "json_to_string", + "unique_method_name": ".to_json_string", "suffix_name": null, - "description": "Checks if a server has any messages waiting to be read.", + "description": "Converts and returns the `json` object as a `string`.", "brief": null, "return": { - "type": "bool", - "description": "True if there are messages on the server.", + "type": "string", + "description": "Returns the `json` object as a `string`.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "svr": { - "type": "server_socket", - "description": "The server to check", + "j": { + "type": "json", + "description": "The `json` object to be converted to a `string`.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -57643,41 +54228,71 @@ } }, "attributes": { - "class": "server_socket", - "getter": "has_messages", - "suffix": "on_server", - "group": "networking", - "static": "networking", - "self": "svr" + "method": "to_json_string", + "static": "json", + "group": "json" }, "signatures": { - "python": [ - "def has_messages_on_server(svr):" - ], "cpp": [ - "bool has_messages(server_socket svr)" + "string json_to_string(json j)" + ], + "python": [ + "def json_to_string(j):" ], "csharp": [ - "public bool ServerSocket.HasMessages { get }", - "public static bool SplashKit.HasMessages(ServerSocket svr);" + "public static string Json.ToJsonString(Json j);", + "public static string SplashKit.JsonToString(Json j);" ], "pascal": [ - "function HasMessages(svr: ServerSocket): Boolean" + "function JsonToString(j: Json): String" ] } - }, + } + ], + "typedefs": [ { - "signature": "bool has_new_connections();", - "name": "has_new_connections", + "signature": "typedef struct sk_json *json;", + "name": "json", + "description": "The `json` type is used to refer to objects in the JSON format that can be\nmanipulated by the SplashKit `json` functions and procedures.\n\n\nAll `json` objects are:\n\n\n- created with `create_json()` or `create_json(string s)` or\n`json_from_string(string s)` or `json_from_file(json j)`\n\n\n- and must be released using `free_json()` (to release a specific `json` object)\nor `free_all_json()` (to release all loaded `json` objects).", + "brief": null, + "attributes": { + "class": "json", + "group": "json", + "static": "json" + }, + "is_function_pointer": false, + "aliased_type": null, + "aliased_identifier": null, + "is_pointer": false, + "new_identifier": null + } + ], + "structs": [ + + ], + "enums": [ + + ], + "defines": [ + + ] + }, + "logging": { + "brief": "SplashKit Logging facilitates streamlined logging with customizable severity levels and modes.", + "description": "SplashKit Logging module, allows users to initialize a custom logger with specified log levels and modes (console, file, or both). \nThe module provides functions to log messages at different severity levels (INFO, DEBUG, WARNING, ERROR, FATAL) with timestamped entries. \nUsers can close the logging process as needed, and the module handles customization for console and file output.", + "functions": [ + { + "signature": "void close_log_process ();", + "name": "close_log_process", "method_name": null, - "unique_global_name": "has_new_connections", + "unique_global_name": "close_log_process", "unique_method_name": null, "suffix_name": null, - "description": "Checks if any of the servers have new connections.", + "description": "Ensures propper memory clean-up prior to exit, if needed. Used in sk_init_looging ().", "brief": null, "return": { - "type": "bool", - "description": "True if there is one or more servers with new connections.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, @@ -57686,48 +54301,48 @@ "parameters": { }, "attributes": { - "group": "networking", - "static": "networking" + "group": "logging", + "static": "logging" }, "signatures": { - "python": [ - "def has_new_connections():" - ], "cpp": [ - "bool has_new_connections()" + "void close_log_process()" + ], + "python": [ + "def close_log_process():" ], "csharp": [ - "public static bool SplashKit.HasNewConnections();" + "public static void SplashKit.CloseLogProcess();" ], "pascal": [ - "function HasNewConnections(): Boolean" + "procedure CloseLogProcess()" ] } }, { - "signature": "bool has_server(const string &name);", - "name": "has_server", + "signature": "void init_custom_logger (log_mode mode);", + "name": "init_custom_logger", "method_name": null, - "unique_global_name": "has_server", + "unique_global_name": "init_custom_logger", "unique_method_name": null, "suffix_name": null, - "description": "Checks if there is a server with the indicated name.", + "description": "Initialises the logging mode for logged messages to be written to the text-based console.", "brief": null, "return": { - "type": "bool", - "description": "True if there is a server with that name", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name of the server to check", + "mode": { + "type": "log_mode", + "description": "The mode of log output i.e. whether there should be output to the console, a text file, or both. Pass your choice of mode variable in by reference.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -57737,48 +54352,74 @@ } }, "attributes": { - "group": "networking", - "static": "networking" + "group": "logging", + "static": "logging" }, "signatures": { - "python": [ - "def has_server(name):" - ], "cpp": [ - "bool has_server(const string &name)" + "void init_custom_logger(log_mode mode)" + ], + "python": [ + "def init_custom_logger(mode):" ], "csharp": [ - "public static bool SplashKit.HasServer(string name);" + "public static void SplashKit.InitCustomLogger(LogMode mode);" ], "pascal": [ - "function HasServer(const name: String): Boolean" + "procedure InitCustomLogger(mode: LogMode)" ] } }, { - "signature": "string hex_str_to_ipv4(const string &a_hex);", - "name": "hex_str_to_ipv4", + "signature": "void init_custom_logger (string app_name,bool override_prev_log,log_mode mode);", + "name": "init_custom_logger", "method_name": null, - "unique_global_name": "hex_str_to_ipv4", + "unique_global_name": "init_custom_logger_name_override_mode", "unique_method_name": null, "suffix_name": null, - "description": "The supplied hexadecimal string is translated into ipv4 standard address string.\nFunction handles hex strings starting with or without 0x.\ne.g. 127.0.0.1 from 0x7F000001", - "brief": "Converts a hexadecimal ipv4 string to standard ipv4 address string x.x.x.x", + "description": "Initialises the logging mode between either writing to a file or both a file and the text-based console.", + "brief": null, "return": { - "type": "string", - "description": "standard ipv4 address using format X.X.X.X", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_hex": { + "app_name": { "type": "string", - "description": "hexadecimal ipv4 string to convert", + "description": "The name of the application being written requiring logging", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "override_prev_log": { + "type": "bool", + "description": "Determines whether or not a new logging session should override the existing file, if any. Set this to false if you want new log messages to be appended to the bottom of the file; otherwise set it to true if you would like a new file to be created on top of the old one.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "mode": { + "type": "log_mode", + "description": "The mode of log output i.e. whether there should be output to the console, a text file, or both. Pass your choice of mode variable in by reference.", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -57788,48 +54429,62 @@ } }, "attributes": { - "group": "networking", - "static": "networking" + "suffix": "name_override_mode", + "group": "logging", + "static": "logging" }, "signatures": { - "python": [ - "def hex_str_to_ipv4(a_hex):" - ], "cpp": [ - "string hex_str_to_ipv4(const string &a_hex)" + "void init_custom_logger(string app_name, bool override_prev_log, log_mode mode)" + ], + "python": [ + "def init_custom_logger_name_override_mode(app_name, override_prev_log, mode):" ], "csharp": [ - "public static string SplashKit.HexStrToIpv4(string aHex);" + "public static void SplashKit.InitCustomLogger(string appName, bool overridePrevLog, LogMode mode);" ], "pascal": [ - "function HexStrToIpv4(const aHex: String): String" + "procedure InitCustomLogger(appName: String; overridePrevLog: Boolean; mode: LogMode)" ] } }, { - "signature": "string hex_to_dec_string(const string &a_hex);", - "name": "hex_to_dec_string", + "signature": "void log(log_level level,string message);", + "name": "log", "method_name": null, - "unique_global_name": "hex_to_dec_string", + "unique_global_name": "log", "unique_method_name": null, "suffix_name": null, - "description": "The supplied hexadecimal string is converted into it's decimal representation\ne.g. 7F into 127", - "brief": "Converts a hexadecimal string to a decimal string", + "description": "Send a message to the message log. The message will be written if the log level for\nthe program is set to display this.", + "brief": null, "return": { - "type": "string", - "description": "decimal representation of supplied hex string", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_hex": { + "level": { + "type": "log_level", + "description": "The level of the message to log", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "message": { "type": "string", - "description": "hexadecimal string to convert", + "description": "The message to be shown", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -57839,99 +54494,169 @@ } }, "attributes": { - "group": "networking", - "static": "networking" + "group": "logging", + "static": "logging" }, "signatures": { - "python": [ - "def hex_to_dec_string(a_hex):" - ], "cpp": [ - "string hex_to_dec_string(const string &a_hex)" + "void log(log_level level, string message)" + ], + "python": [ + "def log(level, message):" ], "csharp": [ - "public static string SplashKit.HexToDecString(string aHex);" + "public static void SplashKit.Log(LogLevel level, string message);" ], "pascal": [ - "function HexToDecString(const aHex: String): String" + "procedure Log(level: LogLevel; message: String)" ] } + } + ], + "typedefs": [ + + ], + "structs": [ + + ], + "enums": [ + { + "signature": "enum log_level {NONE,INFO,DEBUG,WARNING,ERROR,FATAL};", + "name": "log_level", + "description": "Defines the available levels for log messages. This allows categorisation of log\nmessages which can then be filtered allowing messages below a given level to be\nignored.", + "brief": null, + "constants": { + "NONE": { + "description": "Output to the message log but without a specified level" + }, + "INFO": { + "description": "Output information to the message log" + }, + "DEBUG": { + "description": "Output a debug message to the message log" + }, + "WARNING": { + "description": "Output a warning message to the message log" + }, + "ERROR": { + "description": "Output an error message to the message log" + }, + "FATAL": { + "description": "Output an error message to the message log" + } + }, + "attributes": { + "group": "logging", + "static": "logging" + }, + "signatures": { + "cpp": "class log_level {NONE = 0, INFO = 0, DEBUG = 0, WARNING = 0, ERROR = 0, FATAL = 0};", + "python": "public enum {LogLevel.none = 0, LogLevel.info = 0, LogLevel.debug = 0, LogLevel.warning = 0, LogLevel.error = 0, LogLevel.fatal = 0}", + "csharp": "public enum {LogLevel.None = 0, LogLevel.Info = 0, LogLevel.Debug = 0, LogLevel.Warning = 0, LogLevel.Error = 0, LogLevel.Fatal = 0}", + "pascal": "public enum {LogLevel.None = 0, LogLevel.Info = 0, LogLevel.Debug = 0, LogLevel.Warning = 0, LogLevel.Error = 0, LogLevel.Fatal = 0}" + } }, { - "signature": "string hex_to_mac(const string &hex_str);", - "name": "hex_to_mac", + "signature": "enum log_mode {LOG_NONE,LOG_CONSOLE,LOG_FILE_ONLY,LOG_CONSOLE_AND_FILE};", + "name": "log_mode", + "description": "Defines the available modes of logging, indicating where messages are written to.", + "brief": null, + "constants": { + "LOG_NONE": { + "description": "Set the logging mode to none for nothing to be logged to the console or a file." + }, + "LOG_CONSOLE": { + "description": "Ensure that output only directs to the on-screen, text-based console.." + }, + "LOG_FILE_ONLY": { + "description": "Ensure that output only directs to a text file.." + }, + "LOG_CONSOLE_AND_FILE": { + "description": "Direct ouput to both the console and a file." + } + }, + "attributes": { + "group": "logging", + "static": "logging" + }, + "signatures": { + "cpp": "class log_mode {LOG_NONE = 0, LOG_CONSOLE = 0, LOG_FILE_ONLY = 0, LOG_CONSOLE_AND_FILE = 0};", + "python": "public enum {LogMode.log_none = 0, LogMode.log_console = 0, LogMode.log_file_only = 0, LogMode.log_console_and_file = 0}", + "csharp": "public enum {LogMode.LogNone = 0, LogMode.LogConsole = 0, LogMode.LogFileOnly = 0, LogMode.LogConsoleAndFile = 0}", + "pascal": "public enum {LogMode.LogNone = 0, LogMode.LogConsole = 0, LogMode.LogFileOnly = 0, LogMode.LogConsoleAndFile = 0}" + } + } + ], + "defines": [ + + ] + }, + "networking": { + "brief": "SplashKit's network-related functions allow you to communicate data\nacross networks.", + "description": "", + "functions": [ + { + "signature": "bool accept_all_new_connections();", + "name": "accept_all_new_connections", "method_name": null, - "unique_global_name": "hex_to_mac", + "unique_global_name": "accept_all_new_connections", "unique_method_name": null, "suffix_name": null, - "description": "Converts a hexadecimal representation of a MAC address back to its standard format.\ne.g. 01:23:45:67:89:AB from 0x0123456789AB", - "brief": "Converts a hexadecimal string to a MAC address", + "description": "Accept new connections for all servers.", + "brief": null, "return": { - "type": "string", - "description": "MAC address as a string in the format XX:XX:XX:XX:XX:XX", + "type": "bool", + "description": "True if there were accepted connections", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "hex_str": { - "type": "string", - "description": "hexadecimal string to convert", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def hex_to_mac(hex_str):" - ], "cpp": [ - "string hex_to_mac(const string &hex_str)" + "bool accept_all_new_connections()" + ], + "python": [ + "def accept_all_new_connections():" ], "csharp": [ - "public static string SplashKit.HexToMac(string hexStr);" + "public static bool SplashKit.AcceptAllNewConnections();" ], "pascal": [ - "function HexToMac(const hexStr: String): String" + "function AcceptAllNewConnections(): Boolean" ] } }, { - "signature": "unsigned int ipv4_to_dec(const string &a_ip);", - "name": "ipv4_to_dec", - "method_name": null, - "unique_global_name": "ipv4_to_dec", - "unique_method_name": null, + "signature": "bool accept_new_connection(server_socket server);", + "name": "accept_new_connection", + "method_name": "accept_new_connection", + "unique_global_name": "accept_new_connection", + "unique_method_name": "server_socket.accept_new_connection", "suffix_name": null, - "description": "Encodes the supplied ipv4 address string (in format X.X.X.X) into a single integer\ne.g. 127.0.0.1 into 2130706433", - "brief": "Encodes ipv4 string into single integer", + "description": "Accept new connections for a server", + "brief": null, "return": { - "type": "unsigned int", - "description": "encoded ipv4 string", + "type": "bool", + "description": "True if a connection was accepted", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_ip": { - "type": "string", - "description": "ipv4 address to encode", + "server": { + "type": "server_socket", + "description": "The server to check", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -57941,99 +54666,120 @@ } }, "attributes": { + "class": "server_socket", + "method": "accept_new_connection", "group": "networking", - "static": "networking" + "static": "networking", + "self": "server" }, "signatures": { - "python": [ - "def ipv4_to_dec(a_ip):" - ], "cpp": [ - "unsigned int ipv4_to_dec(const string &a_ip)" + "bool accept_new_connection(server_socket server)" + ], + "python": [ + "def accept_new_connection(server):" ], "csharp": [ - "public static uint SplashKit.Ipv4ToDec(string aIP);" + "public bool ServerSocket.AcceptNewConnection();", + "public static bool SplashKit.AcceptNewConnection(ServerSocket server);" ], "pascal": [ - "function Ipv4ToDec(const aIP: String): Cardinal" + "function AcceptNewConnection(server: ServerSocket): Boolean" ] } }, { - "signature": "string ipv4_to_hex(const string& a_ip);", - "name": "ipv4_to_hex", - "method_name": null, - "unique_global_name": "ipv4_to_hex", - "unique_method_name": null, + "signature": "void broadcast_message(const string &a_msg,server_socket svr);", + "name": "broadcast_message", + "method_name": "broadcast_message", + "unique_global_name": "broadcast_message", + "unique_method_name": "server_socket.broadcast_message", "suffix_name": null, - "description": "Converts an ipv4 address into it's hexadecimal representation\ne.g. 0x7F000001 from 127.0.0.1", - "brief": "Converts an ipv4 address string to hex representation", + "description": "Broadcast a message to all connections of a server.", + "brief": null, "return": { - "type": "string", - "description": "hexadecimal representation of ipc4 string", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_ip": { + "a_msg": { "type": "string", - "description": "ip address to convert", + "description": "The message to send", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "svr": { + "type": "server_socket", + "description": "The server to send the message to.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { + "class": "server_socket", + "method": "broadcast_message", + "self": "svr", "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def ipv4_to_hex(a_ip):" - ], "cpp": [ - "string ipv4_to_hex(const string &a_ip)" + "void broadcast_message(const string &a_msg, server_socket svr)" + ], + "python": [ + "def broadcast_message(a_msg, svr):" ], "csharp": [ - "public static string SplashKit.Ipv4ToHex(string aIP);" + "public void ServerSocket.BroadcastMessage(string aMsg);", + "public static void SplashKit.BroadcastMessage(string aMsg, ServerSocket svr);" ], "pascal": [ - "function Ipv4ToHex(const aIP: String): String" + "procedure BroadcastMessage(const aMsg: String; svr: ServerSocket)" ] } }, { - "signature": "bool is_connection_open(connection con);", - "name": "is_connection_open", + "signature": "void broadcast_message(const string &a_msg);", + "name": "broadcast_message", "method_name": null, - "unique_global_name": "is_connection_open", + "unique_global_name": "broadcast_message_to_all", "unique_method_name": null, "suffix_name": null, - "description": "Checks if the connection currently is open.", + "description": "Broadcase a message to all of the connections.", "brief": null, "return": { - "type": "bool", - "description": "True if the connection is open.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "con": { - "type": "connection", - "description": "The connection", + "a_msg": { + "type": "string", + "description": "The message to send", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -58043,49 +54789,59 @@ } }, "attributes": { - "class": "connection", - "getter": "is_open", + "suffix": "to_all", "group": "networking", - "static": "networking", - "self": "con" + "static": "networking" }, "signatures": { - "python": [ - "def is_connection_open(con):" - ], "cpp": [ - "bool is_connection_open(connection con)" + "void broadcast_message(const string &a_msg)" + ], + "python": [ + "def broadcast_message_to_all(a_msg):" ], "csharp": [ - "public bool Connection.IsOpen { get }", - "public static bool SplashKit.IsConnectionOpen(Connection con);" + "public static void SplashKit.BroadcastMessage(string aMsg);" ], "pascal": [ - "function IsConnectionOpen(con: Connection): Boolean" + "procedure BroadcastMessage(const aMsg: String)" ] } }, { - "signature": "bool is_connection_open(const string &name);", - "name": "is_connection_open", + "signature": "void broadcast_message(const string &a_msg,const string &name);", + "name": "broadcast_message", "method_name": null, - "unique_global_name": "is_connection_open_from_name", + "unique_global_name": "broadcast_message_to_server_named", "unique_method_name": null, "suffix_name": null, - "description": "Checks if the connection with the supplied name currently is open.", + "description": "Broadcast a message to all connections of a server.", "brief": null, "return": { - "type": "bool", - "description": "True if the connection is open.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "a_msg": { + "type": "string", + "description": "The message to send", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, "name": { "type": "string", - "description": "The name of the connection", + "description": "The name of the server to send the message to.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -58098,97 +54854,84 @@ } }, "attributes": { - "suffix": "from_name", + "suffix": "to_server_named", "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def is_connection_open_from_name(name):" - ], "cpp": [ - "bool is_connection_open(const string &name)" + "void broadcast_message(const string &a_msg, const string &name)" + ], + "python": [ + "def broadcast_message_to_server_named(a_msg, name):" ], "csharp": [ - "public static bool SplashKit.IsConnectionOpen(string name);" + "public static void SplashKit.BroadcastMessage(string aMsg, string name);" ], "pascal": [ - "function IsConnectionOpen(const name: String): Boolean" + "procedure BroadcastMessage(const aMsg: String; const name: String)" ] } }, { - "signature": "bool is_valid_ipv4(const string &ip);", - "name": "is_valid_ipv4", + "signature": "void check_network_activity();", + "name": "check_network_activity", "method_name": null, - "unique_global_name": "is_valid_ipv4", + "unique_global_name": "check_network_activity", "unique_method_name": null, "suffix_name": null, - "description": null, - "brief": "Validates if a given string represents a valid IPv4 address.", + "description": "Check network activity, looking for new connections and messages.", + "brief": null, "return": { - "type": "bool", - "description": "bool Returns true if the string is a valid IPv4 address, false otherwise", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "ip": { - "type": "string", - "description": "The string containing the IP address to validate", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { "group": "networking", "static": "networking" }, - "signatures": { - "python": [ - "def is_valid_ipv4(ip):" - ], + "signatures": { "cpp": [ - "bool is_valid_ipv4(const string &ip)" + "void check_network_activity()" + ], + "python": [ + "def check_network_activity():" ], "csharp": [ - "public static bool SplashKit.IsValidIpv4(string ip);" + "public static void SplashKit.CheckNetworkActivity();" ], "pascal": [ - "function IsValidIpv4(const ip: String): Boolean" + "procedure CheckNetworkActivity()" ] } }, { - "signature": "bool is_valid_mac(const string &mac_address);", - "name": "is_valid_mac", + "signature": "void clear_messages(const string &name);", + "name": "clear_messages", "method_name": null, - "unique_global_name": "is_valid_mac", + "unique_global_name": "clear_messages_from_name", "unique_method_name": null, "suffix_name": null, - "description": "Checks if the supplied MAC address is valid.", - "brief": "Checks if a MAC address is valid", + "description": "Clear all of the messages from a server or connection with the supplied name.", + "brief": null, "return": { - "type": "bool", - "description": "true if the MAC address is valid", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "mac_address": { + "name": { "type": "string", - "description": "MAC address to check", + "description": "The name of the connection or the server to clear.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -58201,48 +54944,49 @@ } }, "attributes": { + "suffix": "from_name", "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def is_valid_mac(mac_address):" - ], "cpp": [ - "bool is_valid_mac(const string &mac_address)" + "void clear_messages(const string &name)" + ], + "python": [ + "def clear_messages_from_name(name):" ], "csharp": [ - "public static bool SplashKit.IsValidMac(string macAddress);" + "public static void SplashKit.ClearMessages(string name);" ], "pascal": [ - "function IsValidMac(const macAddress: String): Boolean" + "procedure ClearMessages(const name: String)" ] } }, { - "signature": "connection last_connection(const string &name);", - "name": "last_connection", - "method_name": null, - "unique_global_name": "last_connection_named", - "unique_method_name": null, + "signature": "void clear_messages(connection a_connection);", + "name": "clear_messages", + "method_name": "clear_messages", + "unique_global_name": "clear_messages_from_connection", + "unique_method_name": "connection.clear_messages_from_connection", "suffix_name": null, - "description": "Gets the last client that connected to a server.", + "description": "Clear all of the messages from a connection.", "brief": null, "return": { - "type": "connection", - "description": "The last connection made to that server", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name of the server to check", + "a_connection": { + "type": "connection", + "description": "The connection", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -58252,46 +54996,50 @@ } }, "attributes": { - "suffix": "named", + "class": "connection", + "method": "clear_messages", + "suffix": "from_connection", "group": "networking", - "static": "networking" + "static": "networking", + "self": "a_connection" }, "signatures": { - "python": [ - "def last_connection_named(name):" - ], "cpp": [ - "connection last_connection(const string &name)" + "void clear_messages(connection a_connection)" + ], + "python": [ + "def clear_messages_from_connection(a_connection):" ], "csharp": [ - "public static Connection SplashKit.LastConnection(string name);" + "public void Connection.ClearMessages();", + "public static void SplashKit.ClearMessages(Connection aConnection);" ], "pascal": [ - "function LastConnection(const name: String): Connection" + "procedure ClearMessages(aConnection: Connection)" ] } }, { - "signature": "connection last_connection(server_socket server);", - "name": "last_connection", - "method_name": null, - "unique_global_name": "last_connection", - "unique_method_name": null, + "signature": "void clear_messages(server_socket svr);", + "name": "clear_messages", + "method_name": "clear_messages", + "unique_global_name": "clear_messages_from_server", + "unique_method_name": "server_socket.clear_messages_from_server", "suffix_name": null, - "description": "Gets the last client that connected to a server.", + "description": "Clear all of the messages from a server.", "brief": null, "return": { - "type": "connection", - "description": "The last connection made to that server", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "server": { + "svr": { "type": "server_socket", - "description": "The server to check", + "description": "The server to clear the messages from", "is_pointer": false, "is_const": false, "is_reference": false, @@ -58305,150 +55053,125 @@ }, "attributes": { "class": "server_socket", - "getter": "last_connection", + "method": "clear_messages", + "suffix": "from_server", "group": "networking", "static": "networking", - "self": "server" + "self": "svr" }, "signatures": { - "python": [ - "def last_connection(server):" - ], "cpp": [ - "connection last_connection(server_socket server)" + "void clear_messages(server_socket svr)" + ], + "python": [ + "def clear_messages_from_server(svr):" ], "csharp": [ - "public Connection ServerSocket.LastConnection { get }", - "public static Connection SplashKit.LastConnection(ServerSocket server);" + "public void ServerSocket.ClearMessages();", + "public static void SplashKit.ClearMessages(ServerSocket svr);" ], "pascal": [ - "function LastConnection(server: ServerSocket): Connection" + "procedure ClearMessages(svr: ServerSocket)" ] } }, { - "signature": "string mac_to_hex(const string &mac_address);", - "name": "mac_to_hex", + "signature": "void close_all_connections();", + "name": "close_all_connections", "method_name": null, - "unique_global_name": "mac_to_hex", + "unique_global_name": "close_all_connections", "unique_method_name": null, "suffix_name": null, - "description": "Converts a MAC address into its hexadecimal representation.\ne.g. 0x0123456789AB from 01:23:45:67:89:AB", - "brief": "Converts a MAC address string to its hexadecimal representation", + "description": "Close all of the connections you have opened. This does not close\nconnections to servers.", + "brief": null, "return": { - "type": "string", - "description": "hexadecimal representation of MAC address as a string", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "mac_address": { - "type": "string", - "description": "MAC address to convert", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def mac_to_hex(mac_address):" - ], "cpp": [ - "string mac_to_hex(const string &mac_address)" + "void close_all_connections()" + ], + "python": [ + "def close_all_connections():" ], "csharp": [ - "public static string SplashKit.MacToHex(string macAddress);" + "public static void SplashKit.CloseAllConnections();" ], "pascal": [ - "function MacToHex(const macAddress: String): String" + "procedure CloseAllConnections()" ] } }, { - "signature": "connection message_connection(message msg);", - "name": "message_connection", + "signature": "void close_all_servers();", + "name": "close_all_servers", "method_name": null, - "unique_global_name": "message_connection", + "unique_global_name": "close_all_servers", "unique_method_name": null, "suffix_name": null, - "description": "Returns the connection that sent a message.", + "description": "Close all of the servers that are currently open.", "brief": null, "return": { - "type": "connection", - "description": "The connection that sent the message", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "msg": { - "type": "message", - "description": "The message", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def message_connection(msg):" - ], "cpp": [ - "connection message_connection(message msg)" + "void close_all_servers()" + ], + "python": [ + "def close_all_servers():" ], "csharp": [ - "public static Connection SplashKit.MessageConnection(Message msg);" + "public static void SplashKit.CloseAllServers();" ], "pascal": [ - "function MessageConnection(msg: Message): Connection" + "procedure CloseAllServers()" ] } }, { - "signature": "unsigned int message_count(server_socket svr);", - "name": "message_count", - "method_name": null, - "unique_global_name": "message_count_on_server", - "unique_method_name": null, + "signature": "bool close_connection(connection a_connection);", + "name": "close_connection", + "method_name": "close", + "unique_global_name": "close_connection", + "unique_method_name": "connection.close", "suffix_name": null, - "description": "Returns the number of messages on a server.", + "description": "Close the connection", "brief": null, "return": { - "type": "unsigned int", - "description": "The number of messages on the server", + "type": "bool", + "description": "True if this succeeds.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "svr": { - "type": "server_socket", - "description": "The server to check", + "a_connection": { + "type": "connection", + "description": "The connection to close", "is_pointer": false, "is_const": false, "is_reference": false, @@ -58461,53 +55184,53 @@ } }, "attributes": { - "class": "server_socket", - "getter": "message_count", - "suffix": "on_server", + "class": "connection", + "destructor": true, + "method": "close", "group": "networking", "static": "networking", - "self": "svr" + "self": "a_connection" }, "signatures": { - "python": [ - "def message_count_on_server(svr):" - ], "cpp": [ - "unsigned int message_count(server_socket svr)" + "bool close_connection(connection a_connection)" + ], + "python": [ + "def close_connection(a_connection):" ], "csharp": [ - "public uint ServerSocket.MessageCount { get }", - "public static uint SplashKit.MessageCount(ServerSocket svr);" + "public bool Connection.Close();", + "public static bool SplashKit.CloseConnection(Connection aConnection);" ], "pascal": [ - "function MessageCount(svr: ServerSocket): Cardinal" + "function CloseConnection(aConnection: Connection): Boolean" ] } }, { - "signature": "unsigned int message_count(connection a_connection);", - "name": "message_count", + "signature": "bool close_connection(const string &name);", + "name": "close_connection", "method_name": null, - "unique_global_name": "message_count_on_connection", + "unique_global_name": "close_connection_named", "unique_method_name": null, "suffix_name": null, - "description": "Returns the number of messages on a connection.", + "description": "Close the connection", "brief": null, "return": { - "type": "unsigned int", - "description": "The number of messages to be read from the connection", + "type": "bool", + "description": "True if this succeeds.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_connection": { - "type": "connection", - "description": "The connection", + "name": { + "type": "string", + "description": "The name of the connection to close", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -58517,53 +55240,49 @@ } }, "attributes": { - "class": "connection", - "getter": "message_count", - "suffix": "on_connection", + "suffix": "named", "group": "networking", - "static": "networking", - "self": "a_connection" + "static": "networking" }, "signatures": { - "python": [ - "def message_count_on_connection(a_connection):" - ], "cpp": [ - "unsigned int message_count(connection a_connection)" + "bool close_connection(const string &name)" + ], + "python": [ + "def close_connection_named(name):" ], "csharp": [ - "public uint Connection.MessageCount { get }", - "public static uint SplashKit.MessageCount(Connection aConnection);" + "public static bool SplashKit.CloseConnection(string name);" ], "pascal": [ - "function MessageCount(aConnection: Connection): Cardinal" + "function CloseConnection(const name: String): Boolean" ] } }, { - "signature": "unsigned int message_count(const string &name);", - "name": "message_count", - "method_name": null, - "unique_global_name": "message_count_from_name", - "unique_method_name": null, + "signature": "void close_message(message msg);", + "name": "close_message", + "method_name": "close", + "unique_global_name": "close_message", + "unique_method_name": "message.close", "suffix_name": null, - "description": "Returns the number of messages on a server or connection.", + "description": "Closes the message.", "brief": null, "return": { - "type": "unsigned int", - "description": "The number of messages on the server or connection", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name of the server or connection", + "msg": { + "type": "message", + "description": "The message to close", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -58573,49 +55292,53 @@ } }, "attributes": { - "suffix": "from_name", + "class": "message", + "destructor": true, + "method": "close", "group": "networking", - "static": "networking" + "static": "networking", + "self": "msg" }, "signatures": { - "python": [ - "def message_count_from_name(name):" - ], "cpp": [ - "unsigned int message_count(const string &name)" + "void close_message(message msg)" + ], + "python": [ + "def close_message(msg):" ], "csharp": [ - "public static uint SplashKit.MessageCount(string name);" + "public void Message.Close();", + "public static void SplashKit.CloseMessage(Message msg);" ], "pascal": [ - "function MessageCount(const name: String): Cardinal" + "procedure CloseMessage(msg: Message)" ] } }, { - "signature": "string message_data(message msg);", - "name": "message_data", + "signature": "bool close_server(const string &name);", + "name": "close_server", "method_name": null, - "unique_global_name": "message_data", + "unique_global_name": "close_server_named", "unique_method_name": null, "suffix_name": null, - "description": "Gets the body of a message as a string.", + "description": "Closes the server with the indicated name.", "brief": null, "return": { - "type": "string", - "description": "The string body of the message", + "type": "bool", + "description": "True if the server was closed successfully", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "msg": { - "type": "message", - "description": "The message to check", + "name": { + "type": "string", + "description": "The name of the server to close", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -58625,49 +55348,46 @@ } }, "attributes": { - "class": "message", - "getter": "data", + "suffix": "named", "group": "networking", - "static": "networking", - "self": "msg" + "static": "networking" }, "signatures": { - "python": [ - "def message_data(msg):" - ], "cpp": [ - "string message_data(message msg)" + "bool close_server(const string &name)" + ], + "python": [ + "def close_server_named(name):" ], "csharp": [ - "public string Message.Data { get }", - "public static string SplashKit.MessageData(Message msg);" + "public static bool SplashKit.CloseServer(string name);" ], "pascal": [ - "function MessageData(msg: Message): String" + "function CloseServer(const name: String): Boolean" ] } }, { - "signature": "vector message_data_bytes(message msg);", - "name": "message_data_bytes", - "method_name": null, - "unique_global_name": "message_data_bytes", - "unique_method_name": null, + "signature": "bool close_server(server_socket svr);", + "name": "close_server", + "method_name": "close", + "unique_global_name": "close_server", + "unique_method_name": "server_socket.close", "suffix_name": null, - "description": "Gets the body of a message as a list of bytes.", + "description": "Closes the server, all connections with clients will be shut and\nthe port will be closed.", "brief": null, "return": { - "type": "vector", - "description": "The body of the message as bytes", + "type": "bool", + "description": "True if the close was successful", "is_pointer": false, "is_reference": false, - "is_vector": true, - "type_parameter": "int8_t" + "is_vector": false, + "type_parameter": null }, "parameters": { - "msg": { - "type": "message", - "description": "The message to check", + "svr": { + "type": "server_socket", + "description": "The server to close", "is_pointer": false, "is_const": false, "is_reference": false, @@ -58680,52 +55400,53 @@ } }, "attributes": { - "class": "message", - "getter": "data_bytes", + "class": "server_socket", + "destructor": true, + "method": "close", "group": "networking", "static": "networking", - "self": "msg" + "self": "svr" }, "signatures": { - "python": [ - "def message_data_bytes(msg):" - ], "cpp": [ - "vector message_data_bytes(message msg)" + "bool close_server(server_socket svr)" + ], + "python": [ + "def close_server(svr):" ], "csharp": [ - "public List Message.DataBytes { get }", - "public static List SplashKit.MessageDataBytes(Message msg);" + "public bool ServerSocket.Close();", + "public static bool SplashKit.CloseServer(ServerSocket svr);" ], "pascal": [ - "function MessageDataBytes(msg: Message): ArrayOfChar" + "function CloseServer(svr: ServerSocket): Boolean" ] } }, { - "signature": "string message_host(message msg);", - "name": "message_host", + "signature": "unsigned int connection_count(const string &name);", + "name": "connection_count", "method_name": null, - "unique_global_name": "message_host", + "unique_global_name": "connection_count_named", "unique_method_name": null, "suffix_name": null, - "description": "Returns the host who made the message.", + "description": "Returns the number of clients connected to a server.", "brief": null, "return": { - "type": "string", - "description": "The host who sent the message", + "type": "unsigned int", + "description": "The number of connected clients", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "msg": { - "type": "message", - "description": "The message to check", + "name": { + "type": "string", + "description": "The name of the server to check", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -58735,49 +55456,46 @@ } }, "attributes": { - "class": "message", - "getter": "host", + "suffix": "named", "group": "networking", - "static": "networking", - "self": "msg" + "static": "networking" }, "signatures": { - "python": [ - "def message_host(msg):" - ], "cpp": [ - "string message_host(message msg)" + "unsigned int connection_count(const string &name)" + ], + "python": [ + "def connection_count_named(name):" ], "csharp": [ - "public string Message.Host { get }", - "public static string SplashKit.MessageHost(Message msg);" + "public static uint SplashKit.ConnectionCount(string name);" ], "pascal": [ - "function MessageHost(msg: Message): String" + "function ConnectionCount(const name: String): Cardinal" ] } }, { - "signature": "unsigned short int message_port(message msg);", - "name": "message_port", + "signature": "unsigned int connection_count(server_socket server);", + "name": "connection_count", "method_name": null, - "unique_global_name": "message_port", + "unique_global_name": "connection_count", "unique_method_name": null, "suffix_name": null, - "description": "Returns the port used to send a message.", + "description": "Returns the number of clients connected to a server.", "brief": null, "return": { - "type": "unsigned short", - "description": "The port of the message", + "type": "unsigned int", + "description": "The number of connected clients", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "msg": { - "type": "message", - "description": "The message to check", + "server": { + "type": "server_socket", + "description": "The server to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -58790,49 +55508,49 @@ } }, "attributes": { - "class": "message", - "getter": "port", + "class": "server_socket", + "getter": "connection_count", "group": "networking", "static": "networking", - "self": "msg" + "self": "server" }, "signatures": { - "python": [ - "def message_port(msg):" - ], "cpp": [ - "unsigned short message_port(message msg)" + "unsigned int connection_count(server_socket server)" + ], + "python": [ + "def connection_count(server):" ], "csharp": [ - "public ushort Message.Port { get }", - "public static ushort SplashKit.MessagePort(Message msg);" + "public uint ServerSocket.ConnectionCount { get }", + "public static uint SplashKit.ConnectionCount(ServerSocket server);" ], "pascal": [ - "function MessagePort(msg: Message): Word" + "function ConnectionCount(server: ServerSocket): Cardinal" ] } }, { - "signature": "connection_type message_protocol(message msg);", - "name": "message_protocol", + "signature": "unsigned int connection_ip(connection a_connection);", + "name": "connection_ip", "method_name": null, - "unique_global_name": "message_protocol", + "unique_global_name": "connection_ip", "unique_method_name": null, "suffix_name": null, - "description": "Returns the protocol used to send a message.", + "description": "Gets the ip address of the passed in connection.", "brief": null, - "return": { - "type": "connection_type", - "description": "The protocol used to sent the message", + "return": { + "type": "unsigned int", + "description": "The ip addres of the connection", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "msg": { - "type": "message", - "description": "The message to check", + "a_connection": { + "type": "connection", + "description": "The connection", "is_pointer": false, "is_const": false, "is_reference": false, @@ -58845,103 +55563,104 @@ } }, "attributes": { - "class": "message", - "getter": "protocol", + "class": "connection", + "getter": "ip", "group": "networking", "static": "networking", - "self": "msg" + "self": "a_connection" }, "signatures": { - "python": [ - "def message_protocol(msg):" - ], "cpp": [ - "connection_type message_protocol(message msg)" + "unsigned int connection_ip(connection a_connection)" + ], + "python": [ + "def connection_ip(a_connection):" ], "csharp": [ - "public ConnectionType Message.Protocol { get }", - "public static ConnectionType SplashKit.MessageProtocol(Message msg);" + "public uint Connection.IP { get }", + "public static uint SplashKit.ConnectionIP(Connection aConnection);" ], "pascal": [ - "function MessageProtocol(msg: Message): ConnectionType" + "function ConnectionIP(aConnection: Connection): Cardinal" ] } }, { - "signature": "string my_ip();", - "name": "my_ip", + "signature": "unsigned int connection_ip(const string &name);", + "name": "connection_ip", "method_name": null, - "unique_global_name": "my_ip", + "unique_global_name": "connection_ip_from_name", "unique_method_name": null, "suffix_name": null, - "description": "Returns the ipv4 string of the localhost loopback for the current computer.", - "brief": "Returns the ipv4 string for the current computer's ip", + "description": "Gets the ip address of the connection with the supplied name.", + "brief": null, "return": { - "type": "string", - "description": "ipv4 address string in X.X.X.X format", + "type": "unsigned int", + "description": "The connection's ip address", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "name": { + "type": "string", + "description": "The name of the connection", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { + "suffix": "from_name", "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def my_ip():" - ], "cpp": [ - "string my_ip()" + "unsigned int connection_ip(const string &name)" + ], + "python": [ + "def connection_ip_from_name(name):" ], "csharp": [ - "public static string SplashKit.MyIP();" + "public static uint SplashKit.ConnectionIP(string name);" ], "pascal": [ - "function MyIP(): String" + "function ConnectionIP(const name: String): Cardinal" ] } }, { - "signature": "string name_for_connection(const string host,const unsigned int port);", - "name": "name_for_connection", + "signature": "connection connection_named(const string &name);", + "name": "connection_named", "method_name": null, - "unique_global_name": "name_for_connection", + "unique_global_name": "connection_named", "unique_method_name": null, "suffix_name": null, - "description": "Returns the name SplashKit would use for a connection made to a server\nfrom a host to a port.", + "description": "Fetch the connection with the indicated name.", "brief": null, "return": { - "type": "string", - "description": "The name SplashKit would use for this connection", + "type": "connection", + "description": "The connection with that name", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "host": { + "name": { "type": "string", - "description": "The host name", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "port": { - "type": "unsigned int", - "description": "The port", + "description": "The name of the connection to fetch", "is_pointer": false, "is_const": true, - "is_reference": false, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -58955,41 +55674,41 @@ "static": "networking" }, "signatures": { - "python": [ - "def name_for_connection(host, port):" - ], "cpp": [ - "string name_for_connection(const string host, const unsigned int port)" + "connection connection_named(const string &name)" + ], + "python": [ + "def connection_named(name):" ], "csharp": [ - "public static string SplashKit.NameForConnection(string host, uint port);" + "public static Connection SplashKit.ConnectionNamed(string name);" ], "pascal": [ - "function NameForConnection(host: String; port: Cardinal): String" + "function ConnectionNamed(const name: String): Connection" ] } }, { - "signature": "int new_connection_count(server_socket server);", - "name": "new_connection_count", + "signature": "unsigned short int connection_port(connection a_connection);", + "name": "connection_port", "method_name": null, - "unique_global_name": "new_connection_count", + "unique_global_name": "connection_port", "unique_method_name": null, "suffix_name": null, - "description": "Get the number of new connections made to the server.\nThe count will increase as the server accepts new connections.\nThe count decreases each time you fetch a new connection, or\ncan be set to 0 if you reset the new connection count.", + "description": "Gets the port of the connection.", "brief": null, "return": { - "type": "int", - "description": "The number of new connections", + "type": "unsigned short", + "description": "The port of the connection.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "server": { - "type": "server_socket", - "description": "The server to check", + "a_connection": { + "type": "connection", + "description": "The connection", "is_pointer": false, "is_const": false, "is_reference": false, @@ -59002,40 +55721,40 @@ } }, "attributes": { - "class": "server_socket", - "getter": "new_connection_count", + "class": "connection", + "getter": "port", "group": "networking", "static": "networking", - "self": "server" + "self": "a_connection" }, "signatures": { - "python": [ - "def new_connection_count(server):" - ], "cpp": [ - "int new_connection_count(server_socket server)" + "unsigned short connection_port(connection a_connection)" + ], + "python": [ + "def connection_port(a_connection):" ], "csharp": [ - "public int ServerSocket.NewConnectionCount { get }", - "public static int SplashKit.NewConnectionCount(ServerSocket server);" + "public ushort Connection.Port { get }", + "public static ushort SplashKit.ConnectionPort(Connection aConnection);" ], "pascal": [ - "function NewConnectionCount(server: ServerSocket): Integer" + "function ConnectionPort(aConnection: Connection): Word" ] } }, { - "signature": "connection open_connection(const string &name,const string &host,unsigned short int port);", - "name": "open_connection", + "signature": "unsigned short int connection_port(const string &name);", + "name": "connection_port", "method_name": null, - "unique_global_name": "open_connection", + "unique_global_name": "connection_port_from_name", "unique_method_name": null, "suffix_name": null, - "description": "Opens a TCP connection to a server using the supplied details.", + "description": "Gets the part of the connection.", "brief": null, "return": { - "type": "connection", - "description": "A new connection to the indicated server", + "type": "unsigned short", + "description": "The port of the connection", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -59044,7 +55763,7 @@ "parameters": { "name": { "type": "string", - "description": "The name for the connection", + "description": "The name of the connection", "is_pointer": false, "is_const": true, "is_reference": true, @@ -59054,10 +55773,49 @@ ], "is_vector": false, "type_parameter": null - }, - "host": { + } + }, + "attributes": { + "suffix": "from_name", + "group": "networking", + "static": "networking" + }, + "signatures": { + "cpp": [ + "unsigned short connection_port(const string &name)" + ], + "python": [ + "def connection_port_from_name(name):" + ], + "csharp": [ + "public static ushort SplashKit.ConnectionPort(string name);" + ], + "pascal": [ + "function ConnectionPort(const name: String): Word" + ] + } + }, + { + "signature": "server_socket create_server(const string &name,unsigned short int port);", + "name": "create_server", + "method_name": null, + "unique_global_name": "create_server_with_port", + "unique_method_name": null, + "suffix_name": null, + "description": "Creates a new TCP server that can accept connections from other programs.", + "brief": null, + "return": { + "type": "server_socket", + "description": "A new server with the indicated details", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "name": { "type": "string", - "description": "The address of the server", + "description": "The name used to access the Server in splashkit", "is_pointer": false, "is_const": true, "is_reference": true, @@ -59070,7 +55828,7 @@ }, "port": { "type": "unsigned short", - "description": "The server's port", + "description": "The port that clients will use to connect to the server", "is_pointer": false, "is_const": false, "is_reference": false, @@ -59083,39 +55841,40 @@ } }, "attributes": { - "class": "connection", + "class": "server_socket", "constructor": true, + "suffix": "with_port", "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def open_connection(name, host, port):" - ], "cpp": [ - "connection open_connection(const string &name, const string &host, unsigned short port)" + "server_socket create_server(const string &name, unsigned short port)" + ], + "python": [ + "def create_server_with_port(name, port):" ], "csharp": [ - "public static Connection SplashKit.OpenConnection(string name, string host, ushort port);", - "public Connection(string name, string host, ushort port);" + "public static ServerSocket SplashKit.CreateServer(string name, ushort port);", + "public ServerSocket(string name, ushort port);" ], "pascal": [ - "function OpenConnection(const name: String; const host: String; port: Word): Connection" + "function CreateServer(const name: String; port: Word): ServerSocket" ] } }, { - "signature": "connection open_connection(const string &name,const string &host,unsigned short int port,connection_type protocol);", - "name": "open_connection", + "signature": "server_socket create_server(const string &name,unsigned short int port,connection_type protocol);", + "name": "create_server", "method_name": null, - "unique_global_name": "open_connection_with_protocol", + "unique_global_name": "create_server_with_port_and_protocol", "unique_method_name": null, "suffix_name": null, - "description": "Opens a connection to a server using the supplied details.", + "description": "Creates a new server that can accept connections from other programs.", "brief": null, "return": { - "type": "connection", - "description": "A new connection to the indicated server", + "type": "server_socket", + "description": "A new server with the indicated details", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -59124,20 +55883,7 @@ "parameters": { "name": { "type": "string", - "description": "The name for the connection", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "host": { - "type": "string", - "description": "The address of the server", + "description": "The name used to access the Server in splashkit", "is_pointer": false, "is_const": true, "is_reference": true, @@ -59150,7 +55896,7 @@ }, "port": { "type": "unsigned short", - "description": "The server's port", + "description": "The port that clients will use to connect to the server", "is_pointer": false, "is_const": false, "is_reference": false, @@ -59163,7 +55909,7 @@ }, "protocol": { "type": "connection_type", - "description": "The protocol used to connect to the server", + "description": "The protocol used by the server", "is_pointer": false, "is_const": false, "is_reference": false, @@ -59176,87 +55922,151 @@ } }, "attributes": { - "class": "connection", + "class": "server_socket", "constructor": true, - "suffix": "with_protocol", + "suffix": "with_port_and_protocol", "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def open_connection_with_protocol(name, host, port, protocol):" - ], "cpp": [ - "connection open_connection(const string &name, const string &host, unsigned short port, connection_type protocol)" + "server_socket create_server(const string &name, unsigned short port, connection_type protocol)" + ], + "python": [ + "def create_server_with_port_and_protocol(name, port, protocol):" ], "csharp": [ - "public static Connection SplashKit.OpenConnection(string name, string host, ushort port, ConnectionType protocol);", - "public Connection(string name, string host, ushort port, ConnectionType protocol);" + "public static ServerSocket SplashKit.CreateServer(string name, ushort port, ConnectionType protocol);", + "public ServerSocket(string name, ushort port, ConnectionType protocol);" ], "pascal": [ - "function OpenConnection(const name: String; const host: String; port: Word; protocol: ConnectionType): Connection" + "function CreateServer(const name: String; port: Word; protocol: ConnectionType): ServerSocket" ] } }, { - "signature": "message read_message();", - "name": "read_message", + "signature": "string dec_to_hex(unsigned int a_dec);", + "name": "dec_to_hex", "method_name": null, - "unique_global_name": "read_message", + "unique_global_name": "dec_to_hex", "unique_method_name": null, "suffix_name": null, - "description": "Read a message from the network (from a server or connection).", - "brief": null, + "description": "Converts the supplied decimal integer into it's hexadecimal representation.\ne.g. 0x7F000001 from 2130706433", + "brief": "Converts a decimal integer into a hexadecimal string", "return": { - "type": "message", - "description": "The first message from the network.", + "type": "string", + "description": "hexadecimal representation of the supplied decimal integer", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "a_dec": { + "type": "unsigned int", + "description": "decimal to be converted to a hexadecimal number string", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { "group": "networking", "static": "networking" }, "signatures": { + "cpp": [ + "string dec_to_hex(unsigned int a_dec)" + ], "python": [ - "def read_message():" + "def dec_to_hex(a_dec):" + ], + "csharp": [ + "public static string SplashKit.DecToHex(uint aDec);" ], + "pascal": [ + "function DecToHex(aDec: Cardinal): String" + ] + } + }, + { + "signature": "string dec_to_ipv4(unsigned int ip);", + "name": "dec_to_ipv4", + "method_name": null, + "unique_global_name": "dec_to_ipv4", + "unique_method_name": null, + "suffix_name": null, + "description": "Decodes the supplied unsigned 32-bit integer into its ipv4 address form\ne.g. 2130706433 into 127.0.0.1", + "brief": "Decodes an integer into its ipv4 address representation", + "return": { + "type": "string", + "description": "ipv4 address string in X.X.X.X format", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "ip": { + "type": "unsigned int", + "description": "integer to be decoded", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } + }, + "attributes": { + "group": "networking", + "static": "networking" + }, + "signatures": { "cpp": [ - "message read_message()" + "string dec_to_ipv4(unsigned int ip)" + ], + "python": [ + "def dec_to_ipv4(ip):" ], "csharp": [ - "public static Message SplashKit.ReadMessage();" + "public static string SplashKit.DecToIpv4(uint ip);" ], "pascal": [ - "function ReadMessage(): Message" + "function DecToIpv4(ip: Cardinal): String" ] } }, { - "signature": "message read_message(connection a_connection);", - "name": "read_message", - "method_name": "read_message", - "unique_global_name": "read_message_from_connection", - "unique_method_name": "connection.read_message_from_connection", + "signature": "connection fetch_new_connection(server_socket server);", + "name": "fetch_new_connection", + "method_name": "fetch_new_connection", + "unique_global_name": "fetch_new_connection", + "unique_method_name": "server_socket.fetch_new_connection", "suffix_name": null, - "description": "Reads the first message from the connection.", + "description": "Get the oldest new connections made to the server, and\nreduces the new connection count by 1.", "brief": null, "return": { - "type": "message", - "description": "The first message read from the connection", + "type": "connection", + "description": "The oldest new connection", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_connection": { - "type": "connection", - "description": "A connection", + "server": { + "type": "server_socket", + "description": "The server to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -59269,41 +56079,40 @@ } }, "attributes": { - "class": "connection", - "method": "read_message", - "suffix": "from_connection", + "class": "server_socket", + "method": "fetch_new_connection", "group": "networking", "static": "networking", - "self": "a_connection" + "self": "server" }, "signatures": { - "python": [ - "def read_message_from_connection(a_connection):" - ], "cpp": [ - "message read_message(connection a_connection)" + "connection fetch_new_connection(server_socket server)" + ], + "python": [ + "def fetch_new_connection(server):" ], "csharp": [ - "public Message Connection.ReadMessage();", - "public static Message SplashKit.ReadMessage(Connection aConnection);" + "public Connection ServerSocket.FetchNewConnection();", + "public static Connection SplashKit.FetchNewConnection(ServerSocket server);" ], "pascal": [ - "function ReadMessage(aConnection: Connection): Message" + "function FetchNewConnection(server: ServerSocket): Connection" ] } }, { - "signature": "message read_message(const string &name);", - "name": "read_message", + "signature": "bool has_connection(const string &name);", + "name": "has_connection", "method_name": null, - "unique_global_name": "read_message_from_name", + "unique_global_name": "has_connection", "unique_method_name": null, "suffix_name": null, - "description": "Reads the first message from a connection or server.", + "description": "Does the connection with the supplied name exist?", "brief": null, "return": { - "type": "message", - "description": "The first message read from the connection or server", + "type": "bool", + "description": "True if there is a connection with the supplied name", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -59312,7 +56121,7 @@ "parameters": { "name": { "type": "string", - "description": "The name of a connection or server", + "description": "The name of the connection to check.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -59325,46 +56134,85 @@ } }, "attributes": { - "suffix": "from_name", "group": "networking", "static": "networking" }, "signatures": { + "cpp": [ + "bool has_connection(const string &name)" + ], "python": [ - "def read_message_from_name(name):" + "def has_connection(name):" + ], + "csharp": [ + "public static bool SplashKit.HasConnection(string name);" ], + "pascal": [ + "function HasConnection(const name: String): Boolean" + ] + } + }, + { + "signature": "bool has_messages();", + "name": "has_messages", + "method_name": null, + "unique_global_name": "has_messages", + "unique_method_name": null, + "suffix_name": null, + "description": "Checks if there are any messages waiting to be read.", + "brief": null, + "return": { + "type": "bool", + "description": "True if there are any messages waiting to be read", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + }, + "attributes": { + "getter": "has_messages", + "group": "networking", + "static": "networking" + }, + "signatures": { "cpp": [ - "message read_message(const string &name)" + "bool has_messages()" + ], + "python": [ + "def has_messages():" ], "csharp": [ - "public static Message SplashKit.ReadMessage(string name);" + "public static bool Networking.HasMessages { get }", + "public static bool SplashKit.HasMessages();" ], "pascal": [ - "function ReadMessage(const name: String): Message" + "function HasMessages(): Boolean" ] } }, { - "signature": "message read_message(server_socket svr);", - "name": "read_message", - "method_name": "read_message", - "unique_global_name": "read_message_from_server", - "unique_method_name": "server_socket.read_message_from_server", + "signature": "bool has_messages(connection con);", + "name": "has_messages", + "method_name": null, + "unique_global_name": "has_messages_on_connection", + "unique_method_name": null, "suffix_name": null, - "description": "Reads the first message from the server.", + "description": "Checks if a connection has messages waiting to be read.", "brief": null, "return": { - "type": "message", - "description": "The first message read from the server", + "type": "bool", + "description": "True if there are any messages on the connection.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "svr": { - "type": "server_socket", - "description": "A server", + "con": { + "type": "connection", + "description": "The connection", "is_pointer": false, "is_const": false, "is_reference": false, @@ -59377,41 +56225,41 @@ } }, "attributes": { - "class": "server_socket", - "method": "read_message", - "suffix": "from_server", + "class": "connection", + "getter": "has_messages", + "suffix": "on_connection", "group": "networking", "static": "networking", - "self": "svr" + "self": "con" }, "signatures": { - "python": [ - "def read_message_from_server(svr):" - ], "cpp": [ - "message read_message(server_socket svr)" + "bool has_messages(connection con)" + ], + "python": [ + "def has_messages_on_connection(con):" ], "csharp": [ - "public Message ServerSocket.ReadMessage();", - "public static Message SplashKit.ReadMessage(ServerSocket svr);" + "public bool Connection.HasMessages { get }", + "public static bool SplashKit.HasMessages(Connection con);" ], "pascal": [ - "function ReadMessage(svr: ServerSocket): Message" + "function HasMessages(con: Connection): Boolean" ] } }, { - "signature": "string read_message_data(const string &name);", - "name": "read_message_data", + "signature": "bool has_messages(const string &name);", + "name": "has_messages", "method_name": null, - "unique_global_name": "read_message_data_from_name", + "unique_global_name": "has_messages_on_name", "unique_method_name": null, "suffix_name": null, - "description": "Read message data from a connection or server.", + "description": "Checks if a server or connection has any messages.", "brief": null, "return": { - "type": "string", - "description": "The data from the first message from the server or connection", + "type": "bool", + "description": "[description]", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -59420,7 +56268,7 @@ "parameters": { "name": { "type": "string", - "description": "The name of the connection or server", + "description": "The name of the server or connection to check.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -59433,46 +56281,46 @@ } }, "attributes": { - "suffix": "from_name", + "suffix": "on_name", "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def read_message_data_from_name(name):" - ], "cpp": [ - "string read_message_data(const string &name)" + "bool has_messages(const string &name)" + ], + "python": [ + "def has_messages_on_name(name):" ], "csharp": [ - "public static string SplashKit.ReadMessageData(string name);" + "public static bool SplashKit.HasMessages(string name);" ], "pascal": [ - "function ReadMessageData(const name: String): String" + "function HasMessages(const name: String): Boolean" ] } }, { - "signature": "string read_message_data(connection a_connection);", - "name": "read_message_data", - "method_name": "read_message_data", - "unique_global_name": "read_message_data_from_connection", - "unique_method_name": "connection.read_message_data_from_connection", + "signature": "bool has_messages(server_socket svr);", + "name": "has_messages", + "method_name": null, + "unique_global_name": "has_messages_on_server", + "unique_method_name": null, "suffix_name": null, - "description": "Read message data from a connection.", + "description": "Checks if a server has any messages waiting to be read.", "brief": null, "return": { - "type": "string", - "description": "The data from the first message on the connection", + "type": "bool", + "description": "True if there are messages on the server.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_connection": { - "type": "connection", - "description": "The connection", + "svr": { + "type": "server_socket", + "description": "The server to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -59485,53 +56333,91 @@ } }, "attributes": { - "class": "connection", - "method": "read_message_data", - "suffix": "from_connection", + "class": "server_socket", + "getter": "has_messages", + "suffix": "on_server", "group": "networking", "static": "networking", - "self": "a_connection" + "self": "svr" }, "signatures": { + "cpp": [ + "bool has_messages(server_socket svr)" + ], "python": [ - "def read_message_data_from_connection(a_connection):" + "def has_messages_on_server(svr):" ], + "csharp": [ + "public bool ServerSocket.HasMessages { get }", + "public static bool SplashKit.HasMessages(ServerSocket svr);" + ], + "pascal": [ + "function HasMessages(svr: ServerSocket): Boolean" + ] + } + }, + { + "signature": "bool has_new_connections();", + "name": "has_new_connections", + "method_name": null, + "unique_global_name": "has_new_connections", + "unique_method_name": null, + "suffix_name": null, + "description": "Checks if any of the servers have new connections.", + "brief": null, + "return": { + "type": "bool", + "description": "True if there is one or more servers with new connections.", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + }, + "attributes": { + "group": "networking", + "static": "networking" + }, + "signatures": { "cpp": [ - "string read_message_data(connection a_connection)" + "bool has_new_connections()" + ], + "python": [ + "def has_new_connections():" ], "csharp": [ - "public string Connection.ReadMessageData();", - "public static string SplashKit.ReadMessageData(Connection aConnection);" + "public static bool SplashKit.HasNewConnections();" ], "pascal": [ - "function ReadMessageData(aConnection: Connection): String" + "function HasNewConnections(): Boolean" ] } }, { - "signature": "string read_message_data(server_socket svr);", - "name": "read_message_data", - "method_name": "read_message_data", - "unique_global_name": "read_message_data_from_server", - "unique_method_name": "server_socket.read_message_data_from_server", + "signature": "bool has_server(const string &name);", + "name": "has_server", + "method_name": null, + "unique_global_name": "has_server", + "unique_method_name": null, "suffix_name": null, - "description": "Read message data from a server.", + "description": "Checks if there is a server with the indicated name.", "brief": null, "return": { - "type": "string", - "description": "The data from the first message on the server", + "type": "bool", + "description": "True if there is a server with that name", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "svr": { - "type": "server_socket", - "description": "The server", + "name": { + "type": "string", + "description": "The name of the server to check", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -59541,53 +56427,48 @@ } }, "attributes": { - "class": "server_socket", - "method": "read_message_data", - "suffix": "from_server", "group": "networking", - "static": "networking", - "self": "svr" + "static": "networking" }, "signatures": { - "python": [ - "def read_message_data_from_server(svr):" - ], "cpp": [ - "string read_message_data(server_socket svr)" + "bool has_server(const string &name)" + ], + "python": [ + "def has_server(name):" ], "csharp": [ - "public string ServerSocket.ReadMessageData();", - "public static string SplashKit.ReadMessageData(ServerSocket svr);" + "public static bool SplashKit.HasServer(string name);" ], "pascal": [ - "function ReadMessageData(svr: ServerSocket): String" + "function HasServer(const name: String): Boolean" ] } }, { - "signature": "void reconnect(connection a_connection);", - "name": "reconnect", - "method_name": "reconnect", - "unique_global_name": "reconnect", - "unique_method_name": "connection.reconnect", + "signature": "string hex_str_to_ipv4(const string &a_hex);", + "name": "hex_str_to_ipv4", + "method_name": null, + "unique_global_name": "hex_str_to_ipv4", + "unique_method_name": null, "suffix_name": null, - "description": "Attempt to reconnect the connection.", - "brief": null, + "description": "The supplied hexadecimal string is translated into ipv4 standard address string.\nFunction handles hex strings starting with or without 0x.\ne.g. 127.0.0.1 from 0x7F000001", + "brief": "Converts a hexadecimal ipv4 string to standard ipv4 address string x.x.x.x", "return": { - "type": "void", - "description": null, + "type": "string", + "description": "standard ipv4 address using format X.X.X.X", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_connection": { - "type": "connection", - "description": "The connection to reconnect", + "a_hex": { + "type": "string", + "description": "hexadecimal ipv4 string to convert", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -59597,49 +56478,45 @@ } }, "attributes": { - "class": "connection", - "method": "reconnect", "group": "networking", - "static": "networking", - "self": "a_connection" + "static": "networking" }, "signatures": { - "python": [ - "def reconnect(a_connection):" - ], "cpp": [ - "void reconnect(connection a_connection)" + "string hex_str_to_ipv4(const string &a_hex)" + ], + "python": [ + "def hex_str_to_ipv4(a_hex):" ], "csharp": [ - "public void Connection.Reconnect();", - "public static void SplashKit.Reconnect(Connection aConnection);" + "public static string SplashKit.HexStrToIpv4(string aHex);" ], "pascal": [ - "procedure Reconnect(aConnection: Connection)" + "function HexStrToIpv4(const aHex: String): String" ] } }, { - "signature": "void reconnect(const string &name);", - "name": "reconnect", + "signature": "string hex_to_dec_string(const string &a_hex);", + "name": "hex_to_dec_string", "method_name": null, - "unique_global_name": "reconnect_from_name", + "unique_global_name": "hex_to_dec_string", "unique_method_name": null, "suffix_name": null, - "description": "Attempt to reconnect the connection.", - "brief": null, + "description": "The supplied hexadecimal string is converted into it's decimal representation\ne.g. 7F into 127", + "brief": "Converts a hexadecimal string to a decimal string", "return": { - "type": "void", - "description": null, + "type": "string", + "description": "decimal representation of supplied hex string", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { + "a_hex": { "type": "string", - "description": "The name of the connection to reconnect.", + "description": "hexadecimal string to convert", "is_pointer": false, "is_const": true, "is_reference": true, @@ -59652,87 +56529,99 @@ } }, "attributes": { - "suffix": "from_name", "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def reconnect_from_name(name):" - ], "cpp": [ - "void reconnect(const string &name)" + "string hex_to_dec_string(const string &a_hex)" + ], + "python": [ + "def hex_to_dec_string(a_hex):" ], "csharp": [ - "public static void SplashKit.Reconnect(string name);" + "public static string SplashKit.HexToDecString(string aHex);" ], "pascal": [ - "procedure Reconnect(const name: String)" + "function HexToDecString(const aHex: String): String" ] } }, { - "signature": "void release_all_connections();", - "name": "release_all_connections", + "signature": "string hex_to_mac(const string &hex_str);", + "name": "hex_to_mac", "method_name": null, - "unique_global_name": "release_all_connections", + "unique_global_name": "hex_to_mac", "unique_method_name": null, "suffix_name": null, - "description": "Close and release the resources used by all of the connections.", - "brief": null, + "description": "Converts a hexadecimal representation of a MAC address back to its standard format.\ne.g. 01:23:45:67:89:AB from 0x0123456789AB", + "brief": "Converts a hexadecimal string to a MAC address", "return": { - "type": "void", - "description": null, + "type": "string", + "description": "MAC address as a string in the format XX:XX:XX:XX:XX:XX", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "hex_str": { + "type": "string", + "description": "hexadecimal string to convert", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def release_all_connections():" - ], "cpp": [ - "void release_all_connections()" + "string hex_to_mac(const string &hex_str)" + ], + "python": [ + "def hex_to_mac(hex_str):" ], "csharp": [ - "public static void SplashKit.ReleaseAllConnections();" + "public static string SplashKit.HexToMac(string hexStr);" ], "pascal": [ - "procedure ReleaseAllConnections()" + "function HexToMac(const hexStr: String): String" ] } }, { - "signature": "void reset_new_connection_count(server_socket server);", - "name": "reset_new_connection_count", - "method_name": "reset_new_connection_count", - "unique_global_name": "reset_new_connection_count", - "unique_method_name": "server_socket.reset_new_connection_count", + "signature": "unsigned int ipv4_to_dec(const string &a_ip);", + "name": "ipv4_to_dec", + "method_name": null, + "unique_global_name": "ipv4_to_dec", + "unique_method_name": null, "suffix_name": null, - "description": "Allows you to reset the new connection count to 0.\n(The connections are kept)", - "brief": null, + "description": "Encodes the supplied ipv4 address string (in format X.X.X.X) into a single integer\ne.g. 127.0.0.1 into 2130706433", + "brief": "Encodes ipv4 string into single integer", "return": { - "type": "void", - "description": null, + "type": "unsigned int", + "description": "encoded ipv4 string", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "server": { - "type": "server_socket", - "description": "The server to check", + "a_ip": { + "type": "string", + "description": "ipv4 address to encode", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -59742,127 +56631,96 @@ } }, "attributes": { - "class": "server_socket", - "method": "reset_new_connection_count", "group": "networking", - "static": "networking", - "self": "server" + "static": "networking" }, "signatures": { - "python": [ - "def reset_new_connection_count(server):" - ], "cpp": [ - "void reset_new_connection_count(server_socket server)" + "unsigned int ipv4_to_dec(const string &a_ip)" + ], + "python": [ + "def ipv4_to_dec(a_ip):" ], "csharp": [ - "public void ServerSocket.ResetNewConnectionCount();", - "public static void SplashKit.ResetNewConnectionCount(ServerSocket server);" + "public static uint SplashKit.Ipv4ToDec(string aIP);" ], "pascal": [ - "procedure ResetNewConnectionCount(server: ServerSocket)" + "function Ipv4ToDec(const aIP: String): Cardinal" ] } }, { - "signature": "connection retrieve_connection(const string &name,int idx);", - "name": "retrieve_connection", + "signature": "string ipv4_to_hex(const string& a_ip);", + "name": "ipv4_to_hex", "method_name": null, - "unique_global_name": "retrieve_connection_named", + "unique_global_name": "ipv4_to_hex", "unique_method_name": null, "suffix_name": null, - "description": "Get a connection from the server.", - "brief": null, + "description": "Converts an ipv4 address into it's hexadecimal representation\ne.g. 0x7F000001 from 127.0.0.1", + "brief": "Converts an ipv4 address string to hex representation", "return": { - "type": "connection", - "description": "The connection at the supplied index", + "type": "string", + "description": "hexadecimal representation of ipc4 string", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { + "a_ip": { "type": "string", - "description": "The name of the server", + "description": "ip address to convert", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "idx": { - "type": "int", - "description": "The index of the connection", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "suffix": "named", "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def retrieve_connection_named(name, idx):" - ], "cpp": [ - "connection retrieve_connection(const string &name, int idx)" + "string ipv4_to_hex(const string &a_ip)" + ], + "python": [ + "def ipv4_to_hex(a_ip):" ], "csharp": [ - "public static Connection SplashKit.RetrieveConnection(string name, int idx);" + "public static string SplashKit.Ipv4ToHex(string aIP);" ], "pascal": [ - "function RetrieveConnection(const name: String; idx: Integer): Connection" + "function Ipv4ToHex(const aIP: String): String" ] } }, { - "signature": "connection retrieve_connection(server_socket server,int idx);", - "name": "retrieve_connection", - "method_name": "retrieve_connection", - "unique_global_name": "retrieve_connection", - "unique_method_name": "server_socket.retrieve_connection", + "signature": "bool is_connection_open(connection con);", + "name": "is_connection_open", + "method_name": null, + "unique_global_name": "is_connection_open", + "unique_method_name": null, "suffix_name": null, - "description": "Get a connection from the server.", + "description": "Checks if the connection currently is open.", "brief": null, "return": { - "type": "connection", - "description": "The connection at the supplied index", + "type": "bool", + "description": "True if the connection is open.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "server": { - "type": "server_socket", - "description": "The server", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "idx": { - "type": "int", - "description": "The index of the connection", + "con": { + "type": "connection", + "description": "The connection", "is_pointer": false, "is_const": false, "is_reference": false, @@ -59875,118 +56733,101 @@ } }, "attributes": { - "class": "server_socket", - "method": "retrieve_connection", + "class": "connection", + "getter": "is_open", "group": "networking", "static": "networking", - "self": "server" + "self": "con" }, "signatures": { - "python": [ - "def retrieve_connection(server, idx):" - ], "cpp": [ - "connection retrieve_connection(server_socket server, int idx)" + "bool is_connection_open(connection con)" + ], + "python": [ + "def is_connection_open(con):" ], "csharp": [ - "public Connection ServerSocket.RetrieveConnection(int idx);", - "public static Connection SplashKit.RetrieveConnection(ServerSocket server, int idx);" + "public bool Connection.IsOpen { get }", + "public static bool SplashKit.IsConnectionOpen(Connection con);" ], "pascal": [ - "function RetrieveConnection(server: ServerSocket; idx: Integer): Connection" + "function IsConnectionOpen(con: Connection): Boolean" ] } }, { - "signature": "bool send_message_to(const string &a_msg,connection a_connection);", - "name": "send_message_to", - "method_name": "send_message", - "unique_global_name": "send_message_to_connection", - "unique_method_name": "connection.send_message_connection", + "signature": "bool is_connection_open(const string &name);", + "name": "is_connection_open", + "method_name": null, + "unique_global_name": "is_connection_open_from_name", + "unique_method_name": null, "suffix_name": null, - "description": "Send a message to the connection.", + "description": "Checks if the connection with the supplied name currently is open.", "brief": null, "return": { "type": "bool", - "description": "True if the message sends.", + "description": "True if the connection is open.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_msg": { + "name": { "type": "string", - "description": "The message to send", + "description": "The name of the connection", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "a_connection": { - "type": "connection", - "description": "The connection to send the message to", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "connection", - "method": "send_message", - "self": "a_connection", - "suffix": "connection", + "suffix": "from_name", "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def send_message_to_connection(a_msg, a_connection):" - ], "cpp": [ - "bool send_message_to(const string &a_msg, connection a_connection)" + "bool is_connection_open(const string &name)" + ], + "python": [ + "def is_connection_open_from_name(name):" ], "csharp": [ - "public bool Connection.SendMessage(string aMsg);", - "public static bool SplashKit.SendMessageTo(string aMsg, Connection aConnection);" + "public static bool SplashKit.IsConnectionOpen(string name);" ], "pascal": [ - "function SendMessageTo(const aMsg: String; aConnection: Connection): Boolean" + "function IsConnectionOpen(const name: String): Boolean" ] } }, { - "signature": "bool send_message_to(const string &a_msg,const string &name);", - "name": "send_message_to", + "signature": "bool is_valid_ipv4(const string &ip);", + "name": "is_valid_ipv4", "method_name": null, - "unique_global_name": "send_message_to_name", + "unique_global_name": "is_valid_ipv4", "unique_method_name": null, "suffix_name": null, - "description": "Send a message to the connection with the given name.", - "brief": null, + "description": null, + "brief": "Validates if a given string represents a valid IPv4 address.", "return": { "type": "bool", - "description": "True if the message sends", + "description": "bool Returns true if the string is a valid IPv4 address, false otherwise", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "a_msg": { + "ip": { "type": "string", - "description": "The message to send", + "description": "The string containing the IP address to validate", "is_pointer": false, "is_const": true, "is_reference": true, @@ -59996,10 +56837,48 @@ ], "is_vector": false, "type_parameter": null - }, - "name": { + } + }, + "attributes": { + "group": "networking", + "static": "networking" + }, + "signatures": { + "cpp": [ + "bool is_valid_ipv4(const string &ip)" + ], + "python": [ + "def is_valid_ipv4(ip):" + ], + "csharp": [ + "public static bool SplashKit.IsValidIpv4(string ip);" + ], + "pascal": [ + "function IsValidIpv4(const ip: String): Boolean" + ] + } + }, + { + "signature": "bool is_valid_mac(const string &mac_address);", + "name": "is_valid_mac", + "method_name": null, + "unique_global_name": "is_valid_mac", + "unique_method_name": null, + "suffix_name": null, + "description": "Checks if the supplied MAC address is valid.", + "brief": "Checks if a MAC address is valid", + "return": { + "type": "bool", + "description": "true if the MAC address is valid", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "mac_address": { "type": "string", - "description": "The name of the connection to send the message to", + "description": "MAC address to check", "is_pointer": false, "is_const": true, "is_reference": true, @@ -60012,37 +56891,36 @@ } }, "attributes": { - "suffix": "name", "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def send_message_to_name(a_msg, name):" - ], "cpp": [ - "bool send_message_to(const string &a_msg, const string &name)" + "bool is_valid_mac(const string &mac_address)" + ], + "python": [ + "def is_valid_mac(mac_address):" ], "csharp": [ - "public static bool SplashKit.SendMessageTo(string aMsg, string name);" + "public static bool SplashKit.IsValidMac(string macAddress);" ], "pascal": [ - "function SendMessageTo(const aMsg: String; const name: String): Boolean" + "function IsValidMac(const macAddress: String): Boolean" ] } }, { - "signature": "bool server_has_new_connection(const string &name);", - "name": "server_has_new_connection", + "signature": "connection last_connection(const string &name);", + "name": "last_connection", "method_name": null, - "unique_global_name": "server_has_new_connection_named", + "unique_global_name": "last_connection_named", "unique_method_name": null, "suffix_name": null, - "description": "Checks of there are new connections waiting for a server.", + "description": "Gets the last client that connected to a server.", "brief": null, "return": { - "type": "bool", - "description": "True if the server has new connections", + "type": "connection", + "description": "The last connection made to that server", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -60069,32 +56947,32 @@ "static": "networking" }, "signatures": { - "python": [ - "def server_has_new_connection_named(name):" - ], "cpp": [ - "bool server_has_new_connection(const string &name)" + "connection last_connection(const string &name)" + ], + "python": [ + "def last_connection_named(name):" ], "csharp": [ - "public static bool SplashKit.ServerHasNewConnection(string name);" + "public static Connection SplashKit.LastConnection(string name);" ], "pascal": [ - "function ServerHasNewConnection(const name: String): Boolean" + "function LastConnection(const name: String): Connection" ] } }, { - "signature": "bool server_has_new_connection(server_socket server);", - "name": "server_has_new_connection", + "signature": "connection last_connection(server_socket server);", + "name": "last_connection", "method_name": null, - "unique_global_name": "server_has_new_connection", + "unique_global_name": "last_connection", "unique_method_name": null, "suffix_name": null, - "description": "Checks of there are new connections waiting for a server.", + "description": "Gets the last client that connected to a server.", "brief": null, "return": { - "type": "bool", - "description": "True if the server has new connections", + "type": "connection", + "description": "The last connection made to that server", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -60117,48 +56995,48 @@ }, "attributes": { "class": "server_socket", - "getter": "has_new_connections", + "getter": "last_connection", "group": "networking", "static": "networking", "self": "server" }, "signatures": { - "python": [ - "def server_has_new_connection(server):" - ], "cpp": [ - "bool server_has_new_connection(server_socket server)" + "connection last_connection(server_socket server)" + ], + "python": [ + "def last_connection(server):" ], "csharp": [ - "public bool ServerSocket.HasNewConnections { get }", - "public static bool SplashKit.ServerHasNewConnection(ServerSocket server);" + "public Connection ServerSocket.LastConnection { get }", + "public static Connection SplashKit.LastConnection(ServerSocket server);" ], "pascal": [ - "function ServerHasNewConnection(server: ServerSocket): Boolean" + "function LastConnection(server: ServerSocket): Connection" ] } }, { - "signature": "server_socket server_named(const string &name);", - "name": "server_named", + "signature": "string mac_to_hex(const string &mac_address);", + "name": "mac_to_hex", "method_name": null, - "unique_global_name": "server_named", + "unique_global_name": "mac_to_hex", "unique_method_name": null, "suffix_name": null, - "description": "Gets the server with the indicated name.", - "brief": null, + "description": "Converts a MAC address into its hexadecimal representation.\ne.g. 0x0123456789AB from 01:23:45:67:89:AB", + "brief": "Converts a MAC address string to its hexadecimal representation", "return": { - "type": "server_socket", - "description": "The server", + "type": "string", + "description": "hexadecimal representation of MAC address as a string", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { + "mac_address": { "type": "string", - "description": "The name of the server to get", + "description": "MAC address to convert", "is_pointer": false, "is_const": true, "is_reference": true, @@ -60175,41 +57053,41 @@ "static": "networking" }, "signatures": { - "python": [ - "def server_named(name):" - ], "cpp": [ - "server_socket server_named(const string &name)" + "string mac_to_hex(const string &mac_address)" + ], + "python": [ + "def mac_to_hex(mac_address):" ], "csharp": [ - "public static ServerSocket SplashKit.ServerNamed(string name);" + "public static string SplashKit.MacToHex(string macAddress);" ], "pascal": [ - "function ServerNamed(const name: String): ServerSocket" + "function MacToHex(const macAddress: String): String" ] } }, { - "signature": "void set_udp_packet_size(unsigned int udp_packet_size);", - "name": "set_udp_packet_size", + "signature": "connection message_connection(message msg);", + "name": "message_connection", "method_name": null, - "unique_global_name": "set_udp_packet_size", + "unique_global_name": "message_connection", "unique_method_name": null, "suffix_name": null, - "description": "Change the size of the UDP packets.", + "description": "Returns the connection that sent a message.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "connection", + "description": "The connection that sent the message", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "udp_packet_size": { - "type": "unsigned int", - "description": "The new packet size.", + "msg": { + "type": "message", + "description": "The message", "is_pointer": false, "is_const": false, "is_reference": false, @@ -60222,113 +57100,101 @@ } }, "attributes": { - "setter": "udp_packet_size", "group": "networking", "static": "networking" }, "signatures": { - "python": [ - "def set_udp_packet_size(udp_packet_size):" - ], "cpp": [ - "void set_udp_packet_size(unsigned int udp_packet_size)" + "connection message_connection(message msg)" + ], + "python": [ + "def message_connection(msg):" ], "csharp": [ - "public static void Networking.UDPPacketSize { set }", - "public static void SplashKit.SetUDPPacketSize(uint udpPacketSize);" + "public static Connection SplashKit.MessageConnection(Message msg);" ], "pascal": [ - "procedure SetUDPPacketSize(udpPacketSize: Cardinal)" + "function MessageConnection(msg: Message): Connection" ] } }, { - "signature": "unsigned int udp_packet_size();", - "name": "udp_packet_size", + "signature": "unsigned int message_count(server_socket svr);", + "name": "message_count", "method_name": null, - "unique_global_name": "udp_packet_size", + "unique_global_name": "message_count_on_server", "unique_method_name": null, "suffix_name": null, - "description": "Returns the size SplashKit is using for UDP packets.", + "description": "Returns the number of messages on a server.", "brief": null, "return": { "type": "unsigned int", - "description": "The size of UDP packets.", + "description": "The number of messages on the server", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "svr": { + "type": "server_socket", + "description": "The server to check", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { - "getter": "udp_packet_size", + "class": "server_socket", + "getter": "message_count", + "suffix": "on_server", "group": "networking", - "static": "networking" + "static": "networking", + "self": "svr" }, "signatures": { - "python": [ - "def udp_packet_size():" - ], "cpp": [ - "unsigned int udp_packet_size()" + "unsigned int message_count(server_socket svr)" + ], + "python": [ + "def message_count_on_server(svr):" ], "csharp": [ - "public static uint Networking.UDPPacketSize { get }", - "public static uint SplashKit.UDPPacketSize();" + "public uint ServerSocket.MessageCount { get }", + "public static uint SplashKit.MessageCount(ServerSocket svr);" ], "pascal": [ - "function UDPPacketSize(): Cardinal" + "function MessageCount(svr: ServerSocket): Cardinal" ] } }, { - "signature": "bitmap download_bitmap(const string &name,const string &url,unsigned short port);", - "name": "download_bitmap", + "signature": "unsigned int message_count(connection a_connection);", + "name": "message_count", "method_name": null, - "unique_global_name": "download_bitmap", + "unique_global_name": "message_count_on_connection", "unique_method_name": null, "suffix_name": null, - "description": "Download an image from a web server and load it into SplashKit so that\nyou can use it.", + "description": "Returns the number of messages on a connection.", "brief": null, "return": { - "type": "bitmap", - "description": "The bitmap that was loaded", + "type": "unsigned int", + "description": "The number of messages to be read from the connection", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name of the bitmap resource when it is loaded", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "url": { - "type": "string", - "description": "The URL path to the image resoure", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "port": { - "type": "unsigned short", - "description": "The port to connect to on the server", + "a_connection": { + "type": "connection", + "description": "The connection", "is_pointer": false, "is_const": false, "is_reference": false, @@ -60341,35 +57207,41 @@ } }, "attributes": { - "group": "networking" + "class": "connection", + "getter": "message_count", + "suffix": "on_connection", + "group": "networking", + "static": "networking", + "self": "a_connection" }, "signatures": { - "python": [ - "def download_bitmap(name, url, port):" - ], "cpp": [ - "bitmap download_bitmap(const string &name, const string &url, unsigned short port)" + "unsigned int message_count(connection a_connection)" + ], + "python": [ + "def message_count_on_connection(a_connection):" ], "csharp": [ - "public static Bitmap SplashKit.DownloadBitmap(string name, string url, ushort port);" + "public uint Connection.MessageCount { get }", + "public static uint SplashKit.MessageCount(Connection aConnection);" ], "pascal": [ - "function DownloadBitmap(const name: String; const url: String; port: Word): Bitmap" + "function MessageCount(aConnection: Connection): Cardinal" ] } }, { - "signature": "font download_font(const string &name,const string &url,unsigned short port);", - "name": "download_font", + "signature": "unsigned int message_count(const string &name);", + "name": "message_count", "method_name": null, - "unique_global_name": "download_font", + "unique_global_name": "message_count_from_name", "unique_method_name": null, "suffix_name": null, - "description": "Download a font from a web server and load it into SplashKit so that\nyou can use it.", + "description": "Returns the number of messages on a server or connection.", "brief": null, "return": { - "type": "font", - "description": "The font that was loaded", + "type": "unsigned int", + "description": "The number of messages on the server or connection", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -60378,7 +57250,7 @@ "parameters": { "name": { "type": "string", - "description": "The name of the font resource when it is loaded", + "description": "The name of the server or connection", "is_pointer": false, "is_const": true, "is_reference": true, @@ -60388,23 +57260,104 @@ ], "is_vector": false, "type_parameter": null - }, - "url": { - "type": "string", - "description": "The URL path to the font resoure", + } + }, + "attributes": { + "suffix": "from_name", + "group": "networking", + "static": "networking" + }, + "signatures": { + "cpp": [ + "unsigned int message_count(const string &name)" + ], + "python": [ + "def message_count_from_name(name):" + ], + "csharp": [ + "public static uint SplashKit.MessageCount(string name);" + ], + "pascal": [ + "function MessageCount(const name: String): Cardinal" + ] + } + }, + { + "signature": "string message_data(message msg);", + "name": "message_data", + "method_name": null, + "unique_global_name": "message_data", + "unique_method_name": null, + "suffix_name": null, + "description": "Gets the body of a message as a string.", + "brief": null, + "return": { + "type": "string", + "description": "The string body of the message", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "msg": { + "type": "message", + "description": "The message to check", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - }, - "port": { - "type": "unsigned short", - "description": "The port to connect to on the server", + } + }, + "attributes": { + "class": "message", + "getter": "data", + "group": "networking", + "static": "networking", + "self": "msg" + }, + "signatures": { + "cpp": [ + "string message_data(message msg)" + ], + "python": [ + "def message_data(msg):" + ], + "csharp": [ + "public string Message.Data { get }", + "public static string SplashKit.MessageData(Message msg);" + ], + "pascal": [ + "function MessageData(msg: Message): String" + ] + } + }, + { + "signature": "vector message_data_bytes(message msg);", + "name": "message_data_bytes", + "method_name": null, + "unique_global_name": "message_data_bytes", + "unique_method_name": null, + "suffix_name": null, + "description": "Gets the body of a message as a list of bytes.", + "brief": null, + "return": { + "type": "vector", + "description": "The body of the message as bytes", + "is_pointer": false, + "is_reference": false, + "is_vector": true, + "type_parameter": "int8_t" + }, + "parameters": { + "msg": { + "type": "message", + "description": "The message to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -60417,70 +57370,49 @@ } }, "attributes": { - "group": "networking" + "class": "message", + "getter": "data_bytes", + "group": "networking", + "static": "networking", + "self": "msg" }, "signatures": { - "python": [ - "def download_font(name, url, port):" - ], "cpp": [ - "font download_font(const string &name, const string &url, unsigned short port)" + "vector message_data_bytes(message msg)" + ], + "python": [ + "def message_data_bytes(msg):" ], "csharp": [ - "public static Font SplashKit.DownloadFont(string name, string url, ushort port);" + "public List Message.DataBytes { get }", + "public static List SplashKit.MessageDataBytes(Message msg);" ], "pascal": [ - "function DownloadFont(const name: String; const url: String; port: Word): Font" + "function MessageDataBytes(msg: Message): ArrayOfChar" ] } }, { - "signature": "music download_music(const string &name,const string &url,unsigned short port);", - "name": "download_music", + "signature": "string message_host(message msg);", + "name": "message_host", "method_name": null, - "unique_global_name": "download_music", + "unique_global_name": "message_host", "unique_method_name": null, "suffix_name": null, - "description": "Download a music file from a web server and load it into SplashKit so\nthat you can use it.", + "description": "Returns the host who made the message.", "brief": null, "return": { - "type": "music", - "description": "The music that was loaded", + "type": "string", + "description": "The host who sent the message", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name of the music resource when it is loaded", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "url": { - "type": "string", - "description": "The URL path to the music resoure", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "port": { - "type": "unsigned short", - "description": "The port to connect to on the server", + "msg": { + "type": "message", + "description": "The message to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -60493,70 +57425,104 @@ } }, "attributes": { - "group": "networking" + "class": "message", + "getter": "host", + "group": "networking", + "static": "networking", + "self": "msg" }, "signatures": { - "python": [ - "def download_music(name, url, port):" - ], "cpp": [ - "music download_music(const string &name, const string &url, unsigned short port)" + "string message_host(message msg)" + ], + "python": [ + "def message_host(msg):" ], "csharp": [ - "public static Music SplashKit.DownloadMusic(string name, string url, ushort port);" + "public string Message.Host { get }", + "public static string SplashKit.MessageHost(Message msg);" ], "pascal": [ - "function DownloadMusic(const name: String; const url: String; port: Word): Music" + "function MessageHost(msg: Message): String" ] } }, { - "signature": "sound_effect download_sound_effect(const string &name,const string &url,unsigned short port);", - "name": "download_sound_effect", + "signature": "unsigned short int message_port(message msg);", + "name": "message_port", "method_name": null, - "unique_global_name": "download_sound_effect", + "unique_global_name": "message_port", "unique_method_name": null, "suffix_name": null, - "description": "Download a sound effect from a web server and load it into SplashKit so\nthat you can use it.", + "description": "Returns the port used to send a message.", "brief": null, "return": { - "type": "sound_effect", - "description": "The sound effect that was loaded", + "type": "unsigned short", + "description": "The port of the message", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name of the sound effect resource when it is loaded", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "url": { - "type": "string", - "description": "The URL path to the sound effect resoure", + "msg": { + "type": "message", + "description": "The message to check", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - }, - "port": { - "type": "unsigned short", - "description": "The port to connect to on the server", + } + }, + "attributes": { + "class": "message", + "getter": "port", + "group": "networking", + "static": "networking", + "self": "msg" + }, + "signatures": { + "cpp": [ + "unsigned short message_port(message msg)" + ], + "python": [ + "def message_port(msg):" + ], + "csharp": [ + "public ushort Message.Port { get }", + "public static ushort SplashKit.MessagePort(Message msg);" + ], + "pascal": [ + "function MessagePort(msg: Message): Word" + ] + } + }, + { + "signature": "connection_type message_protocol(message msg);", + "name": "message_protocol", + "method_name": null, + "unique_global_name": "message_protocol", + "unique_method_name": null, + "suffix_name": null, + "description": "Returns the protocol used to send a message.", + "brief": null, + "return": { + "type": "connection_type", + "description": "The protocol used to sent the message", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "msg": { + "type": "message", + "description": "The message to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -60569,102 +57535,90 @@ } }, "attributes": { - "group": "networking" + "class": "message", + "getter": "protocol", + "group": "networking", + "static": "networking", + "self": "msg" }, "signatures": { - "python": [ - "def download_sound_effect(name, url, port):" - ], "cpp": [ - "sound_effect download_sound_effect(const string &name, const string &url, unsigned short port)" + "connection_type message_protocol(message msg)" + ], + "python": [ + "def message_protocol(msg):" ], "csharp": [ - "public static SoundEffect SplashKit.DownloadSoundEffect(string name, string url, ushort port);" + "public ConnectionType Message.Protocol { get }", + "public static ConnectionType SplashKit.MessageProtocol(Message msg);" ], "pascal": [ - "function DownloadSoundEffect(const name: String; const url: String; port: Word): SoundEffect" + "function MessageProtocol(msg: Message): ConnectionType" ] } }, { - "signature": "void free_response (http_response response);", - "name": "free_response", - "method_name": "free", - "unique_global_name": "free_response", - "unique_method_name": "http_response.free", + "signature": "string my_ip();", + "name": "my_ip", + "method_name": null, + "unique_global_name": "my_ip", + "unique_method_name": null, "suffix_name": null, - "description": "Free the response resource.", - "brief": null, + "description": "Returns the ipv4 string of the localhost loopback for the current computer.", + "brief": "Returns the ipv4 string for the current computer's ip", "return": { - "type": "void", - "description": null, + "type": "string", + "description": "ipv4 address string in X.X.X.X format", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "response": { - "type": "http_response", - "description": "The response to free", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { - "class": "http_response", - "destructor": true, - "method": "free", "group": "networking", - "self": "response" + "static": "networking" }, "signatures": { - "python": [ - "def free_response(response):" - ], "cpp": [ - "void free_response(http_response response)" + "string my_ip()" + ], + "python": [ + "def my_ip():" ], "csharp": [ - "public void HttpResponse.Free();", - "public static void SplashKit.FreeResponse(HttpResponse response);" + "public static string SplashKit.MyIP();" ], "pascal": [ - "procedure FreeResponse(response: HttpResponse)" + "function MyIP(): String" ] } }, { - "signature": "http_response http_get(const string &url,unsigned short port);", - "name": "http_get", + "signature": "string name_for_connection(const string host,const unsigned int port);", + "name": "name_for_connection", "method_name": null, - "unique_global_name": "http_get", + "unique_global_name": "name_for_connection", "unique_method_name": null, "suffix_name": null, - "description": "Make a get request to access a resource on the internet.", + "description": "Returns the name SplashKit would use for a connection made to a server\nfrom a host to a port.", "brief": null, "return": { - "type": "http_response", - "description": "The response with all of the data received", + "type": "string", + "description": "The name SplashKit would use for this connection", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "url": { + "host": { "type": "string", - "description": "The path to the resource, for example http://splashkit.io", + "description": "The host name", "is_pointer": false, "is_const": true, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -60673,10 +57627,10 @@ "type_parameter": null }, "port": { - "type": "unsigned short", - "description": "The port on the server (80 for http, 443 for https)", + "type": "unsigned int", + "description": "The port", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -60687,57 +57641,45 @@ } }, "attributes": { - "group": "networking" + "group": "networking", + "static": "networking" }, "signatures": { - "python": [ - "def http_get(url, port):" - ], "cpp": [ - "http_response http_get(const string &url, unsigned short port)" + "string name_for_connection(const string host, const unsigned int port)" + ], + "python": [ + "def name_for_connection(host, port):" ], "csharp": [ - "public static HttpResponse SplashKit.HttpGet(string url, ushort port);" + "public static string SplashKit.NameForConnection(string host, uint port);" ], "pascal": [ - "function HttpGet(const url: String; port: Word): HttpResponse" + "function NameForConnection(host: String; port: Cardinal): String" ] } }, { - "signature": "http_response http_post(const string &url,unsigned short port,const string &body,const vector &headers);", - "name": "http_post", + "signature": "int new_connection_count(server_socket server);", + "name": "new_connection_count", "method_name": null, - "unique_global_name": "http_post_with_headers", + "unique_global_name": "new_connection_count", "unique_method_name": null, "suffix_name": null, - "description": "Post the supplied information to the indicated url with the given headers.", + "description": "Get the number of new connections made to the server.\nThe count will increase as the server accepts new connections.\nThe count decreases each time you fetch a new connection, or\ncan be set to 0 if you reset the new connection count.", "brief": null, "return": { - "type": "http_response", - "description": "The response from the server", + "type": "int", + "description": "The number of new connections", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "url": { - "type": "string", - "description": "The url of the server to post the data to", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "port": { - "type": "unsigned short", - "description": "The port to connect to on the server", + "server": { + "type": "server_socket", + "description": "The server to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -60747,74 +57689,52 @@ ], "is_vector": false, "type_parameter": null - }, - "body": { - "type": "string", - "description": "The body of the message to post", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "headers": { - "type": "vector", - "description": "The headers of the request", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": true, - "type_parameter": "string" } }, "attributes": { - "suffix": "with_headers", - "group": "networking" + "class": "server_socket", + "getter": "new_connection_count", + "group": "networking", + "static": "networking", + "self": "server" }, "signatures": { - "python": [ - "def http_post_with_headers(url, port, body, headers):" - ], "cpp": [ - "http_response http_post(const string &url, unsigned short port, const string &body, const vector &headers)" + "int new_connection_count(server_socket server)" + ], + "python": [ + "def new_connection_count(server):" ], "csharp": [ - "public static HttpResponse SplashKit.HttpPost(string url, ushort port, string body, List headers);" + "public int ServerSocket.NewConnectionCount { get }", + "public static int SplashKit.NewConnectionCount(ServerSocket server);" ], "pascal": [ - "function HttpPost(const url: String; port: Word; const body: String; const headers: ArrayOfString): HttpResponse" + "function NewConnectionCount(server: ServerSocket): Integer" ] } }, { - "signature": "http_response http_post(const string &url,unsigned short port,string body);", - "name": "http_post", + "signature": "connection open_connection(const string &name,const string &host,unsigned short int port);", + "name": "open_connection", "method_name": null, - "unique_global_name": "http_post", + "unique_global_name": "open_connection", "unique_method_name": null, "suffix_name": null, - "description": "Post the supplied information to the indicated url.", + "description": "Opens a TCP connection to a server using the supplied details.", "brief": null, "return": { - "type": "http_response", - "description": "The response from the server", + "type": "connection", + "description": "A new connection to the indicated server", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "url": { + "name": { "type": "string", - "description": "The url of the server to post the data to", + "description": "The name for the connection", "is_pointer": false, "is_const": true, "is_reference": true, @@ -60825,12 +57745,12 @@ "is_vector": false, "type_parameter": null }, - "port": { - "type": "unsigned short", - "description": "The port to connect to on the server", + "host": { + "type": "string", + "description": "The address of the server", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -60838,9 +57758,9 @@ "is_vector": false, "type_parameter": null }, - "body": { - "type": "string", - "description": "The body of the message to post", + "port": { + "type": "unsigned short", + "description": "The server's port", "is_pointer": false, "is_const": false, "is_reference": false, @@ -60853,94 +57773,74 @@ } }, "attributes": { - "group": "networking" + "class": "connection", + "constructor": true, + "group": "networking", + "static": "networking" }, "signatures": { - "python": [ - "def http_post(url, port, body):" - ], "cpp": [ - "http_response http_post(const string &url, unsigned short port, string body)" + "connection open_connection(const string &name, const string &host, unsigned short port)" + ], + "python": [ + "def open_connection(name, host, port):" ], "csharp": [ - "public static HttpResponse SplashKit.HttpPost(string url, ushort port, string body);" + "public static Connection SplashKit.OpenConnection(string name, string host, ushort port);", + "public Connection(string name, string host, ushort port);" ], "pascal": [ - "function HttpPost(const url: String; port: Word; body: String): HttpResponse" + "function OpenConnection(const name: String; const host: String; port: Word): Connection" ] } }, { - "signature": "string http_response_to_string(http_response response);", - "name": "http_response_to_string", + "signature": "connection open_connection(const string &name,const string &host,unsigned short int port,connection_type protocol);", + "name": "open_connection", "method_name": null, - "unique_global_name": "http_response_to_string", + "unique_global_name": "open_connection_with_protocol", "unique_method_name": null, "suffix_name": null, - "description": "Read the HTTP response and convert it to text", + "description": "Opens a connection to a server using the supplied details.", "brief": null, "return": { - "type": "string", - "description": "The data from the response as text", + "type": "connection", + "description": "A new connection to the indicated server", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "response": { - "type": "http_response", - "description": "The response from the server", + "name": { + "type": "string", + "description": "The name for the connection", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "group": "networking" - }, - "signatures": { - "python": [ - "def http_response_to_string(response):" - ], - "cpp": [ - "string http_response_to_string(http_response response)" - ], - "csharp": [ - "public static string SplashKit.HttpResponseToString(HttpResponse response);" - ], - "pascal": [ - "function HttpResponseToString(response: HttpResponse): String" - ] - } - }, - { - "signature": "void save_response_to_file(http_response response,string path);", - "name": "save_response_to_file", - "method_name": null, - "unique_global_name": "save_response_to_file", - "unique_method_name": null, - "suffix_name": null, - "description": "Save the HTTP response downloaded into a file.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "response": { - "type": "http_response", - "description": "The response from the server", + }, + "host": { + "type": "string", + "description": "The address of the server", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "port": { + "type": "unsigned short", + "description": "The server's port", "is_pointer": false, "is_const": false, "is_reference": false, @@ -60951,9 +57851,9 @@ "is_vector": false, "type_parameter": null }, - "path": { - "type": "string", - "description": "The path to the file where the response should be saved", + "protocol": { + "type": "connection_type", + "description": "The protocol used to connect to the server", "is_pointer": false, "is_const": false, "is_reference": false, @@ -60966,180 +57866,143 @@ } }, "attributes": { - "group": "networking" + "class": "connection", + "constructor": true, + "suffix": "with_protocol", + "group": "networking", + "static": "networking" }, "signatures": { - "python": [ - "def save_response_to_file(response, path):" - ], "cpp": [ - "void save_response_to_file(http_response response, string path)" + "connection open_connection(const string &name, const string &host, unsigned short port, connection_type protocol)" + ], + "python": [ + "def open_connection_with_protocol(name, host, port, protocol):" ], "csharp": [ - "public static void SplashKit.SaveResponseToFile(HttpResponse response, string path);" + "public static Connection SplashKit.OpenConnection(string name, string host, ushort port, ConnectionType protocol);", + "public Connection(string name, string host, ushort port, ConnectionType protocol);" ], "pascal": [ - "procedure SaveResponseToFile(response: HttpResponse; path: String)" + "function OpenConnection(const name: String; const host: String; port: Word; protocol: ConnectionType): Connection" ] } }, { - "signature": "bool has_incoming_requests(web_server server);", - "name": "has_incoming_requests", + "signature": "message read_message();", + "name": "read_message", "method_name": null, - "unique_global_name": "has_incoming_requests", + "unique_global_name": "read_message", "unique_method_name": null, "suffix_name": null, - "description": "Returns true if the given `web_sever` has pending requests.", + "description": "Read a message from the network (from a server or connection).", "brief": null, "return": { - "type": "bool", - "description": "Returns a `bool` denoting whether the `web_server` has pending requests.", + "type": "message", + "description": "The first message from the network.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "server": { - "type": "web_server", - "description": "The `web_server` to check for waiting requests.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { - "class": "web_server", - "getter": "has_incoming_requests", - "self": "server", "group": "networking", - "static": "web_server" + "static": "networking" }, "signatures": { - "python": [ - "def has_incoming_requests(server):" - ], "cpp": [ - "bool has_incoming_requests(web_server server)" + "message read_message()" + ], + "python": [ + "def read_message():" ], "csharp": [ - "public bool WebServer.HasIncomingRequests { get }", - "public static bool SplashKit.HasIncomingRequests(WebServer server);" + "public static Message SplashKit.ReadMessage();" ], "pascal": [ - "function HasIncomingRequests(server: WebServer): Boolean" + "function ReadMessage(): Message" ] } }, { - "signature": "bool is_delete_request_for(http_request request,const string &path);", - "name": "is_delete_request_for", - "method_name": "is_delete_request_for", - "unique_global_name": "is_delete_request_for", - "unique_method_name": "http_request.is_delete_request_for", + "signature": "message read_message(connection a_connection);", + "name": "read_message", + "method_name": "read_message", + "unique_global_name": "read_message_from_connection", + "unique_method_name": "connection.read_message_from_connection", "suffix_name": null, - "description": "Checks if a request wants to delete a given resource.", + "description": "Reads the first message from the connection.", "brief": null, "return": { - "type": "bool", - "description": "True if the request is a HTTP DELETE request for `path`", + "type": "message", + "description": "The first message read from the connection", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "request": { - "type": "http_request", - "description": "The request to check", + "a_connection": { + "type": "connection", + "description": "A connection", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "path": { - "type": "string", - "description": "The resource/route path", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "http_request", - "method": "is_delete_request_for", + "class": "connection", + "method": "read_message", + "suffix": "from_connection", "group": "networking", - "static": "web_server", - "self": "request" + "static": "networking", + "self": "a_connection" }, "signatures": { - "python": [ - "def is_delete_request_for(request, path):" - ], "cpp": [ - "bool is_delete_request_for(http_request request, const string &path)" + "message read_message(connection a_connection)" + ], + "python": [ + "def read_message_from_connection(a_connection):" ], "csharp": [ - "public bool HttpRequest.IsDeleteRequestFor(string path);", - "public static bool SplashKit.IsDeleteRequestFor(HttpRequest request, string path);" + "public Message Connection.ReadMessage();", + "public static Message SplashKit.ReadMessage(Connection aConnection);" ], "pascal": [ - "function IsDeleteRequestFor(request: HttpRequest; const path: String): Boolean" + "function ReadMessage(aConnection: Connection): Message" ] } }, { - "signature": "bool is_get_request_for(http_request request,const string &path);", - "name": "is_get_request_for", - "method_name": "is_get_request_for", - "unique_global_name": "is_get_request_for", - "unique_method_name": "http_request.is_get_request_for", + "signature": "message read_message(const string &name);", + "name": "read_message", + "method_name": null, + "unique_global_name": "read_message_from_name", + "unique_method_name": null, "suffix_name": null, - "description": "Checks if a request wants to get a given resource.", + "description": "Reads the first message from a connection or server.", "brief": null, "return": { - "type": "bool", - "description": "True if the request is a HTTP GET request for `path`", + "type": "message", + "description": "The first message read from the connection or server", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "request": { - "type": "http_request", - "description": "The request to check", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "path": { + "name": { "type": "string", - "description": "The resource/route path", + "description": "The name of a connection or server", "is_pointer": false, "is_const": true, "is_reference": true, @@ -61152,130 +58015,102 @@ } }, "attributes": { - "class": "http_request", - "method": "is_get_request_for", + "suffix": "from_name", "group": "networking", - "static": "web_server", - "self": "request" + "static": "networking" }, "signatures": { - "python": [ - "def is_get_request_for(request, path):" - ], "cpp": [ - "bool is_get_request_for(http_request request, const string &path)" + "message read_message(const string &name)" + ], + "python": [ + "def read_message_from_name(name):" ], "csharp": [ - "public bool HttpRequest.IsGetRequestFor(string path);", - "public static bool SplashKit.IsGetRequestFor(HttpRequest request, string path);" + "public static Message SplashKit.ReadMessage(string name);" ], "pascal": [ - "function IsGetRequestFor(request: HttpRequest; const path: String): Boolean" + "function ReadMessage(const name: String): Message" ] } }, { - "signature": "bool is_options_request_for(http_request request,const string &path);", - "name": "is_options_request_for", - "method_name": "is_options_request_for", - "unique_global_name": "is_options_request_for", - "unique_method_name": "http_request.is_options_request_for", + "signature": "message read_message(server_socket svr);", + "name": "read_message", + "method_name": "read_message", + "unique_global_name": "read_message_from_server", + "unique_method_name": "server_socket.read_message_from_server", "suffix_name": null, - "description": "Checks if a request wants to check options for given resource.", + "description": "Reads the first message from the server.", "brief": null, "return": { - "type": "bool", - "description": "True if the request is a HTTP OPTIONS request for `path`", + "type": "message", + "description": "The first message read from the server", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "request": { - "type": "http_request", - "description": "The request to check", + "svr": { + "type": "server_socket", + "description": "A server", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "path": { - "type": "string", - "description": "The resource/route path", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "http_request", - "method": "is_options_request_for", + "class": "server_socket", + "method": "read_message", + "suffix": "from_server", "group": "networking", - "static": "web_server", - "self": "request" + "static": "networking", + "self": "svr" }, "signatures": { - "python": [ - "def is_options_request_for(request, path):" - ], "cpp": [ - "bool is_options_request_for(http_request request, const string &path)" + "message read_message(server_socket svr)" + ], + "python": [ + "def read_message_from_server(svr):" ], "csharp": [ - "public bool HttpRequest.IsOptionsRequestFor(string path);", - "public static bool SplashKit.IsOptionsRequestFor(HttpRequest request, string path);" + "public Message ServerSocket.ReadMessage();", + "public static Message SplashKit.ReadMessage(ServerSocket svr);" ], "pascal": [ - "function IsOptionsRequestFor(request: HttpRequest; const path: String): Boolean" + "function ReadMessage(svr: ServerSocket): Message" ] } }, { - "signature": "bool is_post_request_for(http_request request,const string &path);", - "name": "is_post_request_for", - "method_name": "is_post_request_for", - "unique_global_name": "is_post_request_for", - "unique_method_name": "http_request.is_post_request_for", + "signature": "string read_message_data(const string &name);", + "name": "read_message_data", + "method_name": null, + "unique_global_name": "read_message_data_from_name", + "unique_method_name": null, "suffix_name": null, - "description": "Checks if a request wants to create (post) a given resource.", + "description": "Read message data from a connection or server.", "brief": null, "return": { - "type": "bool", - "description": "True if the request is a HTTP POST request for `path`", + "type": "string", + "description": "The data from the first message from the server or connection", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "request": { - "type": "http_request", - "description": "The request to check", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "path": { + "name": { "type": "string", - "description": "The resource/route path", + "description": "The name of the connection or server", "is_pointer": false, "is_const": true, "is_reference": true, @@ -61288,269 +58123,216 @@ } }, "attributes": { - "class": "http_request", - "method": "is_post_request_for", + "suffix": "from_name", "group": "networking", - "static": "web_server", - "self": "request" + "static": "networking" }, "signatures": { - "python": [ - "def is_post_request_for(request, path):" - ], "cpp": [ - "bool is_post_request_for(http_request request, const string &path)" + "string read_message_data(const string &name)" + ], + "python": [ + "def read_message_data_from_name(name):" ], "csharp": [ - "public bool HttpRequest.IsPostRequestFor(string path);", - "public static bool SplashKit.IsPostRequestFor(HttpRequest request, string path);" + "public static string SplashKit.ReadMessageData(string name);" ], "pascal": [ - "function IsPostRequestFor(request: HttpRequest; const path: String): Boolean" + "function ReadMessageData(const name: String): String" ] } }, { - "signature": "bool is_put_request_for(http_request request,const string &path);", - "name": "is_put_request_for", - "method_name": "is_put_request_for", - "unique_global_name": "is_put_request_for", - "unique_method_name": "http_request.is_put_request_for", + "signature": "string read_message_data(connection a_connection);", + "name": "read_message_data", + "method_name": "read_message_data", + "unique_global_name": "read_message_data_from_connection", + "unique_method_name": "connection.read_message_data_from_connection", "suffix_name": null, - "description": "Checks if a request wants to update (put) a given resource.", + "description": "Read message data from a connection.", "brief": null, "return": { - "type": "bool", - "description": "True if the request is a HTTP PUT request for `path`", + "type": "string", + "description": "The data from the first message on the connection", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "request": { - "type": "http_request", - "description": "The request to check", + "a_connection": { + "type": "connection", + "description": "The connection", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "path": { - "type": "string", - "description": "The resource/route path", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "http_request", - "method": "is_put_request_for", + "class": "connection", + "method": "read_message_data", + "suffix": "from_connection", "group": "networking", - "static": "web_server", - "self": "request" + "static": "networking", + "self": "a_connection" }, "signatures": { - "python": [ - "def is_put_request_for(request, path):" - ], "cpp": [ - "bool is_put_request_for(http_request request, const string &path)" + "string read_message_data(connection a_connection)" + ], + "python": [ + "def read_message_data_from_connection(a_connection):" ], "csharp": [ - "public bool HttpRequest.IsPutRequestFor(string path);", - "public static bool SplashKit.IsPutRequestFor(HttpRequest request, string path);" + "public string Connection.ReadMessageData();", + "public static string SplashKit.ReadMessageData(Connection aConnection);" ], "pascal": [ - "function IsPutRequestFor(request: HttpRequest; const path: String): Boolean" + "function ReadMessageData(aConnection: Connection): String" ] } }, { - "signature": "bool is_request_for(http_request request,http_method method,const string &path);", - "name": "is_request_for", - "method_name": "is_request_for", - "unique_global_name": "is_request_for", - "unique_method_name": "http_request.is_request_for", + "signature": "string read_message_data(server_socket svr);", + "name": "read_message_data", + "method_name": "read_message_data", + "unique_global_name": "read_message_data_from_server", + "unique_method_name": "server_socket.read_message_data_from_server", "suffix_name": null, - "description": "Checks if a request is after a given resource.", + "description": "Read message data from a server.", "brief": null, "return": { - "type": "bool", - "description": "True if the request is for the indicated method and path", + "type": "string", + "description": "The data from the first message on the server", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "request": { - "type": "http_request", - "description": "The request to check", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "method": { - "type": "http_method", - "description": "The kind of request", + "svr": { + "type": "server_socket", + "description": "The server", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "path": { - "type": "string", - "description": "The resource/route path", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "http_request", - "method": "is_request_for", + "class": "server_socket", + "method": "read_message_data", + "suffix": "from_server", "group": "networking", - "static": "web_server", - "self": "request" + "static": "networking", + "self": "svr" }, "signatures": { - "python": [ - "def is_request_for(request, method, path):" - ], "cpp": [ - "bool is_request_for(http_request request, http_method method, const string &path)" + "string read_message_data(server_socket svr)" + ], + "python": [ + "def read_message_data_from_server(svr):" ], "csharp": [ - "public bool HttpRequest.IsRequestFor(HttpMethod method, string path);", - "public static bool SplashKit.IsRequestFor(HttpRequest request, HttpMethod method, string path);" + "public string ServerSocket.ReadMessageData();", + "public static string SplashKit.ReadMessageData(ServerSocket svr);" ], "pascal": [ - "function IsRequestFor(request: HttpRequest; method: HttpMethod; const path: String): Boolean" + "function ReadMessageData(svr: ServerSocket): String" ] } }, { - "signature": "bool is_trace_request_for(http_request request,const string &path);", - "name": "is_trace_request_for", - "method_name": "is_trace_request_for", - "unique_global_name": "is_trace_request_for", - "unique_method_name": "http_request.is_trace_request_for", + "signature": "void reconnect(connection a_connection);", + "name": "reconnect", + "method_name": "reconnect", + "unique_global_name": "reconnect", + "unique_method_name": "connection.reconnect", "suffix_name": null, - "description": "Checks if a request wants to trace a given resource.", + "description": "Attempt to reconnect the connection.", "brief": null, "return": { - "type": "bool", - "description": "True if the request is a HTTP TRACE request for `path`", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "request": { - "type": "http_request", - "description": "The request to check", + "a_connection": { + "type": "connection", + "description": "The connection to reconnect", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "path": { - "type": "string", - "description": "The resource/route path", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "http_request", - "method": "is_trace_request_for", + "class": "connection", + "method": "reconnect", "group": "networking", - "static": "web_server", - "self": "request" + "static": "networking", + "self": "a_connection" }, "signatures": { - "python": [ - "def is_trace_request_for(request, path):" - ], "cpp": [ - "bool is_trace_request_for(http_request request, const string &path)" + "void reconnect(connection a_connection)" + ], + "python": [ + "def reconnect(a_connection):" ], "csharp": [ - "public bool HttpRequest.IsTraceRequestFor(string path);", - "public static bool SplashKit.IsTraceRequestFor(HttpRequest request, string path);" + "public void Connection.Reconnect();", + "public static void SplashKit.Reconnect(Connection aConnection);" ], "pascal": [ - "function IsTraceRequestFor(request: HttpRequest; const path: String): Boolean" + "procedure Reconnect(aConnection: Connection)" ] } }, { - "signature": "http_request next_web_request(web_server server);", - "name": "next_web_request", + "signature": "void reconnect(const string &name);", + "name": "reconnect", "method_name": null, - "unique_global_name": "next_web_request", + "unique_global_name": "reconnect_from_name", "unique_method_name": null, "suffix_name": null, - "description": "Returns the next request on a given `web_server` instance", + "description": "Attempt to reconnect the connection.", "brief": null, "return": { - "type": "http_request", - "description": "Returns the next request on the given `web_server` instance.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "server": { - "type": "web_server", - "description": "The `web_server` to get the `http_request` from.", + "name": { + "type": "string", + "description": "The name of the connection to reconnect.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -61560,172 +58342,152 @@ } }, "attributes": { - "class": "web_server", - "getter": "next_web_request", - "self": "server", + "suffix": "from_name", "group": "networking", - "static": "web_server" + "static": "networking" }, "signatures": { - "python": [ - "def next_web_request(server):" - ], "cpp": [ - "http_request next_web_request(web_server server)" + "void reconnect(const string &name)" + ], + "python": [ + "def reconnect_from_name(name):" ], "csharp": [ - "public HttpRequest WebServer.NextWebRequest { get }", - "public static HttpRequest SplashKit.NextWebRequest(WebServer server);" + "public static void SplashKit.Reconnect(string name);" ], "pascal": [ - "function NextWebRequest(server: WebServer): HttpRequest" + "procedure Reconnect(const name: String)" ] } }, { - "signature": "string request_body(http_request r);", - "name": "request_body", + "signature": "void release_all_connections();", + "name": "release_all_connections", "method_name": null, - "unique_global_name": "request_body", + "unique_global_name": "release_all_connections", "unique_method_name": null, "suffix_name": null, - "description": "Returns the body of the request.", + "description": "Close and release the resources used by all of the connections.", "brief": null, "return": { - "type": "string", - "description": "The body of the request.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "A request object.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { - "class": "http_request", - "getter": "body", "group": "networking", - "static": "web_server", - "self": "r" + "static": "networking" }, "signatures": { - "python": [ - "def request_body(r):" - ], "cpp": [ - "string request_body(http_request r)" + "void release_all_connections()" + ], + "python": [ + "def release_all_connections():" ], "csharp": [ - "public string HttpRequest.Body { get }", - "public static string SplashKit.RequestBody(HttpRequest r);" + "public static void SplashKit.ReleaseAllConnections();" ], "pascal": [ - "function RequestBody(r: HttpRequest): String" + "procedure ReleaseAllConnections()" ] } }, { - "signature": "bool request_has_query_parameter(http_request r,const string &name);", - "name": "request_has_query_parameter", - "method_name": "has_query_parameter", - "unique_global_name": "request_has_query_parameter", - "unique_method_name": "http_request.has_query_parameter", + "signature": "void reset_new_connection_count(server_socket server);", + "name": "reset_new_connection_count", + "method_name": "reset_new_connection_count", + "unique_global_name": "reset_new_connection_count", + "unique_method_name": "server_socket.reset_new_connection_count", "suffix_name": null, - "description": "Returns true if the parameter exists in the query string.", + "description": "Allows you to reset the new connection count to 0.\n(The connections are kept)", "brief": null, "return": { - "type": "bool", - "description": "True if the parameter exists in the user's request.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "A request object.", + "server": { + "type": "server_socket", + "description": "The server to check", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "name": { - "type": "string", - "description": "The name of the parameter to check", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "http_request", - "method": "has_query_parameter", + "class": "server_socket", + "method": "reset_new_connection_count", "group": "networking", - "static": "web_server", - "self": "r" + "static": "networking", + "self": "server" }, "signatures": { - "python": [ - "def request_has_query_parameter(r, name):" - ], "cpp": [ - "bool request_has_query_parameter(http_request r, const string &name)" + "void reset_new_connection_count(server_socket server)" + ], + "python": [ + "def reset_new_connection_count(server):" ], "csharp": [ - "public bool HttpRequest.HasQueryParameter(string name);", - "public static bool SplashKit.RequestHasQueryParameter(HttpRequest r, string name);" + "public void ServerSocket.ResetNewConnectionCount();", + "public static void SplashKit.ResetNewConnectionCount(ServerSocket server);" ], "pascal": [ - "function RequestHasQueryParameter(r: HttpRequest; const name: String): Boolean" + "procedure ResetNewConnectionCount(server: ServerSocket)" ] } }, { - "signature": "vector request_headers(http_request r);", - "name": "request_headers", + "signature": "connection retrieve_connection(const string &name,int idx);", + "name": "retrieve_connection", "method_name": null, - "unique_global_name": "request_headers", + "unique_global_name": "retrieve_connection_named", "unique_method_name": null, "suffix_name": null, - "description": "Returns the headers of the request.", + "description": "Get a connection from the server.", "brief": null, "return": { - "type": "vector", - "description": "The headers of the request.", + "type": "connection", + "description": "The connection at the supplied index", "is_pointer": false, "is_reference": false, - "is_vector": true, - "type_parameter": "string" + "is_vector": false, + "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "A request object.", + "name": { + "type": "string", + "description": "The name of the server", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "idx": { + "type": "int", + "description": "The index of the connection", "is_pointer": false, "is_const": false, "is_reference": false, @@ -61738,49 +58500,59 @@ } }, "attributes": { - "class": "http_request", - "getter": "headers", + "suffix": "named", "group": "networking", - "static": "web_server", - "self": "r" + "static": "networking" }, "signatures": { - "python": [ - "def request_headers(r):" - ], "cpp": [ - "vector request_headers(http_request r)" + "connection retrieve_connection(const string &name, int idx)" + ], + "python": [ + "def retrieve_connection_named(name, idx):" ], "csharp": [ - "public List HttpRequest.Headers { get }", - "public static List SplashKit.RequestHeaders(HttpRequest r);" + "public static Connection SplashKit.RetrieveConnection(string name, int idx);" ], "pascal": [ - "function RequestHeaders(r: HttpRequest): ArrayOfString" + "function RetrieveConnection(const name: String; idx: Integer): Connection" ] } }, { - "signature": "http_method request_method(http_request r);", - "name": "request_method", - "method_name": null, - "unique_global_name": "request_method", - "unique_method_name": null, + "signature": "connection retrieve_connection(server_socket server,int idx);", + "name": "retrieve_connection", + "method_name": "retrieve_connection", + "unique_global_name": "retrieve_connection", + "unique_method_name": "server_socket.retrieve_connection", "suffix_name": null, - "description": "Returns the HTTP method of the client request.", + "description": "Get a connection from the server.", "brief": null, "return": { - "type": "http_method", - "description": "Returns the request method.", + "type": "connection", + "description": "The connection at the supplied index", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "A request object.", + "server": { + "type": "server_socket", + "description": "The server", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "idx": { + "type": "int", + "description": "The index of the connection", "is_pointer": false, "is_const": false, "is_reference": false, @@ -61793,62 +58565,49 @@ } }, "attributes": { - "class": "http_request", - "getter": "method", + "class": "server_socket", + "method": "retrieve_connection", "group": "networking", - "static": "web_server", - "self": "r" + "static": "networking", + "self": "server" }, "signatures": { - "python": [ - "def request_method(r):" - ], "cpp": [ - "http_method request_method(http_request r)" + "connection retrieve_connection(server_socket server, int idx)" + ], + "python": [ + "def retrieve_connection(server, idx):" ], "csharp": [ - "public HttpMethod HttpRequest.Method { get }", - "public static HttpMethod SplashKit.RequestMethod(HttpRequest r);" + "public Connection ServerSocket.RetrieveConnection(int idx);", + "public static Connection SplashKit.RetrieveConnection(ServerSocket server, int idx);" ], "pascal": [ - "function RequestMethod(r: HttpRequest): HttpMethod" + "function RetrieveConnection(server: ServerSocket; idx: Integer): Connection" ] } }, { - "signature": "string request_query_parameter(http_request r,const string &name,const string &default_value);", - "name": "request_query_parameter", - "method_name": "query_parameter", - "unique_global_name": "request_query_parameter", - "unique_method_name": "http_request.query_parameter", + "signature": "bool send_message_to(const string &a_msg,connection a_connection);", + "name": "send_message_to", + "method_name": "send_message", + "unique_global_name": "send_message_to_connection", + "unique_method_name": "connection.send_message_connection", "suffix_name": null, - "description": "Returns the value of a parameter from within the query string, or the supplied default\nif no matching parameter is found.", + "description": "Send a message to the connection.", "brief": null, "return": { - "type": "string", - "description": "Returns value of the parameter from the query string, or the default value if the parameter is not found.", + "type": "bool", + "description": "True if the message sends.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "A request object.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "name": { + "a_msg": { "type": "string", - "description": "The name of the parameter to fetch", + "description": "The message to send", "is_pointer": false, "is_const": true, "is_reference": true, @@ -61859,12 +58618,12 @@ "is_vector": false, "type_parameter": null }, - "default_value": { - "type": "string", - "description": "The value to return if the named parameter is not in the query string.", + "a_connection": { + "type": "connection", + "description": "The connection to send the message to", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -61874,52 +58633,66 @@ } }, "attributes": { - "class": "http_request", - "method": "query_parameter", + "class": "connection", + "method": "send_message", + "self": "a_connection", + "suffix": "connection", "group": "networking", - "static": "web_server", - "self": "r" + "static": "networking" }, "signatures": { - "python": [ - "def request_query_parameter(r, name, default_value):" - ], "cpp": [ - "string request_query_parameter(http_request r, const string &name, const string &default_value)" + "bool send_message_to(const string &a_msg, connection a_connection)" + ], + "python": [ + "def send_message_to_connection(a_msg, a_connection):" ], "csharp": [ - "public string HttpRequest.QueryParameter(string name, string defaultValue);", - "public static string SplashKit.RequestQueryParameter(HttpRequest r, string name, string defaultValue);" + "public bool Connection.SendMessage(string aMsg);", + "public static bool SplashKit.SendMessageTo(string aMsg, Connection aConnection);" ], "pascal": [ - "function RequestQueryParameter(r: HttpRequest; const name: String; const defaultValue: String): String" + "function SendMessageTo(const aMsg: String; aConnection: Connection): Boolean" ] } }, { - "signature": "string request_query_string(http_request r);", - "name": "request_query_string", + "signature": "bool send_message_to(const string &a_msg,const string &name);", + "name": "send_message_to", "method_name": null, - "unique_global_name": "request_query_string", + "unique_global_name": "send_message_to_name", "unique_method_name": null, "suffix_name": null, - "description": "Returns the URI query string of the client request.", + "description": "Send a message to the connection with the given name.", "brief": null, "return": { - "type": "string", - "description": "Returns the requested URI queries in the form of a string.", + "type": "bool", + "description": "True if the message sends", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "A request object.", + "a_msg": { + "type": "string", + "description": "The message to send", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "name": { + "type": "string", + "description": "The name of the connection to send the message to", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -61929,52 +58702,49 @@ } }, "attributes": { - "class": "http_request", - "getter": "query_string", + "suffix": "name", "group": "networking", - "static": "web_server", - "self": "r" + "static": "networking" }, "signatures": { - "python": [ - "def request_query_string(r):" - ], "cpp": [ - "string request_query_string(http_request r)" + "bool send_message_to(const string &a_msg, const string &name)" + ], + "python": [ + "def send_message_to_name(a_msg, name):" ], "csharp": [ - "public string HttpRequest.QueryString { get }", - "public static string SplashKit.RequestQueryString(HttpRequest r);" + "public static bool SplashKit.SendMessageTo(string aMsg, string name);" ], "pascal": [ - "function RequestQueryString(r: HttpRequest): String" + "function SendMessageTo(const aMsg: String; const name: String): Boolean" ] } }, { - "signature": "string request_uri(http_request r);", - "name": "request_uri", + "signature": "bool server_has_new_connection(const string &name);", + "name": "server_has_new_connection", "method_name": null, - "unique_global_name": "request_uri", + "unique_global_name": "server_has_new_connection_named", "unique_method_name": null, "suffix_name": null, - "description": "Returns the server URI of the client request.", + "description": "Checks of there are new connections waiting for a server.", "brief": null, "return": { - "type": "string", - "description": "Returns the requested URI in the form of a string.", + "type": "bool", + "description": "True if the server has new connections", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "A request object.", + "name": { + "type": "string", + "description": "The name of the server to check", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -61984,49 +58754,46 @@ } }, "attributes": { - "class": "http_request", - "getter": "uri", + "suffix": "named", "group": "networking", - "static": "web_server", - "self": "r" + "static": "networking" }, "signatures": { - "python": [ - "def request_uri(r):" - ], "cpp": [ - "string request_uri(http_request r)" + "bool server_has_new_connection(const string &name)" + ], + "python": [ + "def server_has_new_connection_named(name):" ], "csharp": [ - "public string HttpRequest.URI { get }", - "public static string SplashKit.RequestURI(HttpRequest r);" + "public static bool SplashKit.ServerHasNewConnection(string name);" ], "pascal": [ - "function RequestURI(r: HttpRequest): String" + "function ServerHasNewConnection(const name: String): Boolean" ] } }, { - "signature": "vector request_uri_stubs(http_request r);", - "name": "request_uri_stubs", + "signature": "bool server_has_new_connection(server_socket server);", + "name": "server_has_new_connection", "method_name": null, - "unique_global_name": "request_uri_stubs", + "unique_global_name": "server_has_new_connection", "unique_method_name": null, "suffix_name": null, - "description": "Returns an array of strings representing each stub of the URI.\n\nFor example a request sent to `http://localhost:8080/names/0` returns...\n\n[\"names\", \"0\"]", + "description": "Checks of there are new connections waiting for a server.", "brief": null, "return": { - "type": "vector", - "description": "The array of stubs as strings.", + "type": "bool", + "description": "True if the server has new connections", "is_pointer": false, "is_reference": false, - "is_vector": true, - "type_parameter": "string" + "is_vector": false, + "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "The request for retrieving URI to split into stubs.", + "server": { + "type": "server_socket", + "description": "The server to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -62039,62 +58806,49 @@ } }, "attributes": { - "class": "http_request", - "getter": "uri_stubs", + "class": "server_socket", + "getter": "has_new_connections", "group": "networking", - "static": "web_server", - "self": "r" + "static": "networking", + "self": "server" }, "signatures": { - "python": [ - "def request_uri_stubs(r):" - ], "cpp": [ - "vector request_uri_stubs(http_request r)" + "bool server_has_new_connection(server_socket server)" + ], + "python": [ + "def server_has_new_connection(server):" ], "csharp": [ - "public List HttpRequest.URIStubs { get }", - "public static List SplashKit.RequestURIStubs(HttpRequest r);" + "public bool ServerSocket.HasNewConnections { get }", + "public static bool SplashKit.ServerHasNewConnection(ServerSocket server);" ], "pascal": [ - "function RequestURIStubs(r: HttpRequest): ArrayOfString" + "function ServerHasNewConnection(server: ServerSocket): Boolean" ] } }, { - "signature": "void send_css_file_response(http_request r,const string &filename);", - "name": "send_css_file_response", - "method_name": "send_css_file_response", - "unique_global_name": "send_css_file_response", - "unique_method_name": "http_request.send_css_file_response", + "signature": "server_socket server_named(const string &name);", + "name": "server_named", + "method_name": null, + "unique_global_name": "server_named", + "unique_method_name": null, "suffix_name": null, - "description": "Serves a css file to the given `http_request`.", + "description": "Gets the server with the indicated name.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "server_socket", + "description": "The server", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "The request which is asking for the resource.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "filename": { + "name": { "type": "string", - "description": "The name of the file in Resources/server", + "description": "The name of the server to get", "is_pointer": false, "is_const": true, "is_reference": true, @@ -62107,36 +58861,32 @@ } }, "attributes": { - "class": "http_request", - "method": "send_css_file_response", "group": "networking", - "static": "web_server", - "self": "r" + "static": "networking" }, "signatures": { - "python": [ - "def send_css_file_response(r, filename):" - ], "cpp": [ - "void send_css_file_response(http_request r, const string &filename)" + "server_socket server_named(const string &name)" + ], + "python": [ + "def server_named(name):" ], "csharp": [ - "public void HttpRequest.SendCSSFileResponse(string filename);", - "public static void SplashKit.SendCSSFileResponse(HttpRequest r, string filename);" + "public static ServerSocket SplashKit.ServerNamed(string name);" ], "pascal": [ - "procedure SendCSSFileResponse(r: HttpRequest; const filename: String)" + "function ServerNamed(const name: String): ServerSocket" ] } }, { - "signature": "void send_file_response(http_request r,const string &filename,const string &content_type);", - "name": "send_file_response", - "method_name": "send_file_response", - "unique_global_name": "send_file_response", - "unique_method_name": "http_request.send_file_response", + "signature": "void set_udp_packet_size(unsigned int udp_packet_size);", + "name": "set_udp_packet_size", + "method_name": null, + "unique_global_name": "set_udp_packet_size", + "unique_method_name": null, "suffix_name": null, - "description": "Serves a file to the given `http_request`.", + "description": "Change the size of the UDP packets.", "brief": null, "return": { "type": "void", @@ -62147,161 +58897,105 @@ "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "The request which is asking for the resource.", + "udp_packet_size": { + "type": "unsigned int", + "description": "The new packet size.", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "filename": { - "type": "string", - "description": "The name of the file in Resources/server", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "content_type": { - "type": "string", - "description": "The type of content being send:", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "http_request", - "method": "send_file_response", + "setter": "udp_packet_size", "group": "networking", - "static": "web_server", - "self": "r" + "static": "networking" }, "signatures": { - "python": [ - "def send_file_response(r, filename, content_type):" - ], "cpp": [ - "void send_file_response(http_request r, const string &filename, const string &content_type)" + "void set_udp_packet_size(unsigned int udp_packet_size)" + ], + "python": [ + "def set_udp_packet_size(udp_packet_size):" ], "csharp": [ - "public void HttpRequest.SendFileResponse(string filename, string contentType);", - "public static void SplashKit.SendFileResponse(HttpRequest r, string filename, string contentType);" + "public static void Networking.UDPPacketSize { set }", + "public static void SplashKit.SetUDPPacketSize(uint udpPacketSize);" ], "pascal": [ - "procedure SendFileResponse(r: HttpRequest; const filename: String; const contentType: String)" + "procedure SetUDPPacketSize(udpPacketSize: Cardinal)" ] } }, { - "signature": "void send_html_file_response(http_request r,const string &filename);", - "name": "send_html_file_response", - "method_name": "send_html_file_response", - "unique_global_name": "send_html_file_response", - "unique_method_name": "http_request.send_html_file_response", + "signature": "unsigned int udp_packet_size();", + "name": "udp_packet_size", + "method_name": null, + "unique_global_name": "udp_packet_size", + "unique_method_name": null, "suffix_name": null, - "description": "Serves a HTML file to the given `http_request`.", + "description": "Returns the size SplashKit is using for UDP packets.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "unsigned int", + "description": "The size of UDP packets.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "The request which is asking for the resource.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "filename": { - "type": "string", - "description": "The name of the file in Resources/server", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { - "class": "http_request", - "method": "send_html_file_response", + "getter": "udp_packet_size", "group": "networking", - "static": "web_server", - "self": "r" + "static": "networking" }, "signatures": { - "python": [ - "def send_html_file_response(r, filename):" - ], "cpp": [ - "void send_html_file_response(http_request r, const string &filename)" + "unsigned int udp_packet_size()" + ], + "python": [ + "def udp_packet_size():" ], "csharp": [ - "public void HttpRequest.SendHtmlFileResponse(string filename);", - "public static void SplashKit.SendHtmlFileResponse(HttpRequest r, string filename);" + "public static uint Networking.UDPPacketSize { get }", + "public static uint SplashKit.UDPPacketSize();" ], "pascal": [ - "procedure SendHtmlFileResponse(r: HttpRequest; const filename: String)" + "function UDPPacketSize(): Cardinal" ] } }, { - "signature": "void send_javascript_file_response(http_request r,const string &filename);", - "name": "send_javascript_file_response", - "method_name": "send_javascript_file_response", - "unique_global_name": "send_javascript_file_response", - "unique_method_name": "http_request.send_javascript_file_response", + "signature": "bitmap download_bitmap(const string &name,const string &url,unsigned short port);", + "name": "download_bitmap", + "method_name": null, + "unique_global_name": "download_bitmap", + "unique_method_name": null, "suffix_name": null, - "description": "Serves a javascript file to the given `http_request`.", + "description": "Download an image from a web server and load it into SplashKit so that\nyou can use it.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bitmap", + "description": "The bitmap that was loaded", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "The request which is asking for the resource.", + "name": { + "type": "string", + "description": "The name of the bitmap resource when it is loaded", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -62309,9 +59003,9 @@ "is_vector": false, "type_parameter": null }, - "filename": { + "url": { "type": "string", - "description": "The name of the file in Resources/server", + "description": "The URL path to the image resoure", "is_pointer": false, "is_const": true, "is_reference": true, @@ -62321,52 +59015,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "http_request", - "method": "send_javascript_file_response", - "group": "networking", - "static": "web_server", - "self": "r" - }, - "signatures": { - "python": [ - "def send_javascript_file_response(r, filename):" - ], - "cpp": [ - "void send_javascript_file_response(http_request r, const string &filename)" - ], - "csharp": [ - "public void HttpRequest.SendJavascriptFileResponse(string filename);", - "public static void SplashKit.SendJavascriptFileResponse(HttpRequest r, string filename);" - ], - "pascal": [ - "procedure SendJavascriptFileResponse(r: HttpRequest; const filename: String)" - ] - } - }, - { - "signature": "void send_response(http_request r);", - "name": "send_response", - "method_name": "send_response", - "unique_global_name": "send_response_empty", - "unique_method_name": "http_request.send_response_empty", - "suffix_name": null, - "description": "Sends a response with no content to a `http_request`.", - "brief": null, - "return": { - "type": "void", - "description": null, - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "r": { - "type": "http_request", - "description": "The `http_request` to send the response to", + }, + "port": { + "type": "unsigned short", + "description": "The port to connect to on the server", "is_pointer": false, "is_const": false, "is_reference": false, @@ -62379,53 +59031,47 @@ } }, "attributes": { - "class": "http_request", - "method": "send_response", - "self": "r", - "suffix": "empty", - "group": "networking", - "static": "web_server" + "group": "networking" }, "signatures": { - "python": [ - "def send_response_empty(r):" - ], "cpp": [ - "void send_response(http_request r)" + "bitmap download_bitmap(const string &name, const string &url, unsigned short port)" + ], + "python": [ + "def download_bitmap(name, url, port):" ], "csharp": [ - "public void HttpRequest.SendResponse();", - "public static void SplashKit.SendResponse(HttpRequest r);" + "public static Bitmap SplashKit.DownloadBitmap(string name, string url, ushort port);" ], "pascal": [ - "procedure SendResponse(r: HttpRequest)" + "function DownloadBitmap(const name: String; const url: String; port: Word): Bitmap" ] } }, { - "signature": "void send_response(http_request r,const string &message);", - "name": "send_response", - "method_name": "send_response", - "unique_global_name": "send_response", - "unique_method_name": "http_request.send_response", + "signature": "font download_font(const string &name,const string &url,unsigned short port);", + "name": "download_font", + "method_name": null, + "unique_global_name": "download_font", + "unique_method_name": null, "suffix_name": null, - "description": "Sends a message to a given `http_request`.", + "description": "Download a font from a web server and load it into SplashKit so that\nyou can use it.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "font", + "description": "The font that was loaded", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "The request to be sent.", + "name": { + "type": "string", + "description": "The name of the font resource when it is loaded", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -62433,67 +59079,75 @@ "is_vector": false, "type_parameter": null }, - "message": { + "url": { "type": "string", - "description": "The message to be sent", + "description": "The URL path to the font resoure", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "port": { + "type": "unsigned short", + "description": "The port to connect to on the server", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "http_request", - "method": "send_response", - "group": "networking", - "static": "web_server", - "self": "r" + "group": "networking" }, "signatures": { - "python": [ - "def send_response(r, message):" - ], "cpp": [ - "void send_response(http_request r, const string &message)" + "font download_font(const string &name, const string &url, unsigned short port)" + ], + "python": [ + "def download_font(name, url, port):" ], "csharp": [ - "public void HttpRequest.SendResponse(string message);", - "public static void SplashKit.SendResponse(HttpRequest r, string message);" + "public static Font SplashKit.DownloadFont(string name, string url, ushort port);" ], "pascal": [ - "procedure SendResponse(r: HttpRequest; const message: String)" + "function DownloadFont(const name: String; const url: String; port: Word): Font" ] } }, { - "signature": "void send_response(http_request r,http_status_code code);", - "name": "send_response", - "method_name": "send_response", - "unique_global_name": "send_response_json_with_status", - "unique_method_name": "http_request.send_response_json_with_status", + "signature": "music download_music(const string &name,const string &url,unsigned short port);", + "name": "download_music", + "method_name": null, + "unique_global_name": "download_music", + "unique_method_name": null, "suffix_name": null, - "description": "Sends a response code to a given `http_request`.", + "description": "Download a music file from a web server and load it into SplashKit so\nthat you can use it.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "music", + "description": "The music that was loaded", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "The `http_request` to send the response to", + "name": { + "type": "string", + "description": "The name of the music resource when it is loaded", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -62501,9 +59155,22 @@ "is_vector": false, "type_parameter": null }, - "code": { - "type": "http_status_code", - "description": "The [HTTP status code](See https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) to be sent.", + "url": { + "type": "string", + "description": "The URL path to the music resoure", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "port": { + "type": "unsigned short", + "description": "The port to connect to on the server", "is_pointer": false, "is_const": false, "is_reference": false, @@ -62516,53 +59183,47 @@ } }, "attributes": { - "class": "http_request", - "method": "send_response", - "self": "r", - "suffix": "json_with_status", - "group": "networking", - "static": "web_server" + "group": "networking" }, "signatures": { - "python": [ - "def send_response_json_with_status(r, code):" - ], "cpp": [ - "void send_response(http_request r, http_status_code code)" + "music download_music(const string &name, const string &url, unsigned short port)" + ], + "python": [ + "def download_music(name, url, port):" ], "csharp": [ - "public void HttpRequest.SendResponse(HttpStatusCode code);", - "public static void SplashKit.SendResponse(HttpRequest r, HttpStatusCode code);" + "public static Music SplashKit.DownloadMusic(string name, string url, ushort port);" ], "pascal": [ - "procedure SendResponse(r: HttpRequest; code: HttpStatusCode)" + "function DownloadMusic(const name: String; const url: String; port: Word): Music" ] } }, { - "signature": "void send_response(http_request r,http_status_code code,const string &message);", - "name": "send_response", - "method_name": "send_response", - "unique_global_name": "send_response_with_status", - "unique_method_name": "http_request.send_response_with_status", + "signature": "sound_effect download_sound_effect(const string &name,const string &url,unsigned short port);", + "name": "download_sound_effect", + "method_name": null, + "unique_global_name": "download_sound_effect", + "unique_method_name": null, "suffix_name": null, - "description": "Sends a message to a given `http_request` with the specified content type.", + "description": "Download a sound effect from a web server and load it into SplashKit so\nthat you can use it.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "sound_effect", + "description": "The sound effect that was loaded", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "The `http_request` to send the response to", + "name": { + "type": "string", + "description": "The name of the sound effect resource when it is loaded", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -62570,12 +59231,12 @@ "is_vector": false, "type_parameter": null }, - "code": { - "type": "http_status_code", - "description": "The [HTTP status code](See https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) to be sent.", + "url": { + "type": "string", + "description": "The URL path to the sound effect resoure", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -62583,12 +59244,12 @@ "is_vector": false, "type_parameter": null }, - "message": { - "type": "string", - "description": "The messsage, in the form of a `http_response`, to be sent.", + "port": { + "type": "unsigned short", + "description": "The port to connect to on the server", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -62598,37 +59259,31 @@ } }, "attributes": { - "class": "http_request", - "method": "send_response", - "self": "r", - "suffix": "with_status", - "group": "networking", - "static": "web_server" + "group": "networking" }, "signatures": { - "python": [ - "def send_response_with_status(r, code, message):" - ], "cpp": [ - "void send_response(http_request r, http_status_code code, const string &message)" + "sound_effect download_sound_effect(const string &name, const string &url, unsigned short port)" + ], + "python": [ + "def download_sound_effect(name, url, port):" ], "csharp": [ - "public void HttpRequest.SendResponse(HttpStatusCode code, string message);", - "public static void SplashKit.SendResponse(HttpRequest r, HttpStatusCode code, string message);" + "public static SoundEffect SplashKit.DownloadSoundEffect(string name, string url, ushort port);" ], "pascal": [ - "procedure SendResponse(r: HttpRequest; code: HttpStatusCode; const message: String)" + "function DownloadSoundEffect(const name: String; const url: String; port: Word): SoundEffect" ] } }, { - "signature": "void send_response(http_request r,http_status_code code,const string &message,const string &content_type);", - "name": "send_response", - "method_name": "send_response", - "unique_global_name": "send_response_with_status_and_content_type", - "unique_method_name": "http_request.send_response_with_status_and_content_type", + "signature": "void free_response (http_response response);", + "name": "free_response", + "method_name": "free", + "unique_global_name": "free_response", + "unique_method_name": "http_response.free", "suffix_name": null, - "description": "Sends a message to a given `http_request` with the specified content type.", + "description": "Free the response resource.", "brief": null, "return": { "type": "void", @@ -62639,22 +59294,9 @@ "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "The `http_request` to send the response to", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "code": { - "type": "http_status_code", - "description": "The [HTTP status code](See https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) to be sent.", + "response": { + "type": "http_response", + "description": "The response to free", "is_pointer": false, "is_const": false, "is_reference": false, @@ -62664,10 +59306,52 @@ ], "is_vector": false, "type_parameter": null - }, - "message": { + } + }, + "attributes": { + "class": "http_response", + "destructor": true, + "method": "free", + "group": "networking", + "self": "response" + }, + "signatures": { + "cpp": [ + "void free_response(http_response response)" + ], + "python": [ + "def free_response(response):" + ], + "csharp": [ + "public void HttpResponse.Free();", + "public static void SplashKit.FreeResponse(HttpResponse response);" + ], + "pascal": [ + "procedure FreeResponse(response: HttpResponse)" + ] + } + }, + { + "signature": "http_response http_get(const string &url,unsigned short port);", + "name": "http_get", + "method_name": null, + "unique_global_name": "http_get", + "unique_method_name": null, + "suffix_name": null, + "description": "Make a get request to access a resource on the internet.", + "brief": null, + "return": { + "type": "http_response", + "description": "The response with all of the data received", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "url": { "type": "string", - "description": "The messsage, in the form of a `http_response`, to be sent.", + "description": "The path to the resource, for example http://splashkit.io", "is_pointer": false, "is_const": true, "is_reference": true, @@ -62678,12 +59362,12 @@ "is_vector": false, "type_parameter": null }, - "content_type": { - "type": "string", - "description": "The content type of the response.", + "port": { + "type": "unsigned short", + "description": "The port on the server (80 for http, 443 for https)", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -62693,53 +59377,47 @@ } }, "attributes": { - "class": "http_request", - "method": "send_response", - "self": "r", - "suffix": "with_status_and_content_type", - "group": "networking", - "static": "web_server" + "group": "networking" }, "signatures": { - "python": [ - "def send_response_with_status_and_content_type(r, code, message, content_type):" - ], "cpp": [ - "void send_response(http_request r, http_status_code code, const string &message, const string &content_type)" + "http_response http_get(const string &url, unsigned short port)" + ], + "python": [ + "def http_get(url, port):" ], "csharp": [ - "public void HttpRequest.SendResponse(HttpStatusCode code, string message, string contentType);", - "public static void SplashKit.SendResponse(HttpRequest r, HttpStatusCode code, string message, string contentType);" + "public static HttpResponse SplashKit.HttpGet(string url, ushort port);" ], "pascal": [ - "procedure SendResponse(r: HttpRequest; code: HttpStatusCode; const message: String; const contentType: String)" + "function HttpGet(const url: String; port: Word): HttpResponse" ] } }, { - "signature": "void send_response(http_request r,http_status_code code,const string &message,const string &content_type,const vector &headers);", - "name": "send_response", - "method_name": "send_response", - "unique_global_name": "send_response_with_status_and_content_type_and_headers", - "unique_method_name": "http_request.send_response_with_status_and_content_type_and_headers", + "signature": "http_response http_post(const string &url,unsigned short port,const string &body,const vector &headers);", + "name": "http_post", + "method_name": null, + "unique_global_name": "http_post_with_headers", + "unique_method_name": null, "suffix_name": null, - "description": "Sends a message to a given `http_request` with the specified content type.", + "description": "Post the supplied information to the indicated url with the given headers.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "http_response", + "description": "The response from the server", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "The `http_request` to send the response to", + "url": { + "type": "string", + "description": "The url of the server to post the data to", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -62747,9 +59425,9 @@ "is_vector": false, "type_parameter": null }, - "code": { - "type": "http_status_code", - "description": "The [HTTP status code](See https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) to be sent.", + "port": { + "type": "unsigned short", + "description": "The port to connect to on the server", "is_pointer": false, "is_const": false, "is_reference": false, @@ -62760,22 +59438,9 @@ "is_vector": false, "type_parameter": null }, - "message": { - "type": "string", - "description": "The messsage, in the form of a `http_response`, to be sent.", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "content_type": { + "body": { "type": "string", - "description": "The content type of the response.", + "description": "The body of the message to post", "is_pointer": false, "is_const": true, "is_reference": true, @@ -62788,7 +59453,7 @@ }, "headers": { "type": "vector", - "description": "The response headers", + "description": "The headers of the request", "is_pointer": false, "is_const": true, "is_reference": true, @@ -62801,50 +59466,58 @@ } }, "attributes": { - "class": "http_request", - "method": "send_response", - "self": "r", - "suffix": "with_status_and_content_type_and_headers", - "group": "networking", - "static": "web_server" + "suffix": "with_headers", + "group": "networking" }, "signatures": { - "python": [ - "def send_response_with_status_and_content_type_and_headers(r, code, message, content_type, headers):" - ], "cpp": [ - "void send_response(http_request r, http_status_code code, const string &message, const string &content_type, const vector &headers)" + "http_response http_post(const string &url, unsigned short port, const string &body, const vector &headers)" + ], + "python": [ + "def http_post_with_headers(url, port, body, headers):" ], "csharp": [ - "public void HttpRequest.SendResponse(HttpStatusCode code, string message, string contentType, List headers);", - "public static void SplashKit.SendResponse(HttpRequest r, HttpStatusCode code, string message, string contentType, List headers);" + "public static HttpResponse SplashKit.HttpPost(string url, ushort port, string body, List headers);" ], "pascal": [ - "procedure SendResponse(r: HttpRequest; code: HttpStatusCode; const message: String; const contentType: String; const headers: ArrayOfString)" + "function HttpPost(const url: String; port: Word; const body: String; const headers: ArrayOfString): HttpResponse" ] } }, { - "signature": "void send_response(http_request r,json j);", - "name": "send_response", - "method_name": "send_response", - "unique_global_name": "send_response_json", - "unique_method_name": "http_request.send_response_json", + "signature": "http_response http_post(const string &url,unsigned short port,string body);", + "name": "http_post", + "method_name": null, + "unique_global_name": "http_post", + "unique_method_name": null, "suffix_name": null, - "description": "Send a JSON response to a given `http_request`", + "description": "Post the supplied information to the indicated url.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "http_response", + "description": "The response from the server", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "r": { - "type": "http_request", - "description": "The request the response belongs to.", + "url": { + "type": "string", + "description": "The url of the server to post the data to", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "port": { + "type": "unsigned short", + "description": "The port to connect to on the server", "is_pointer": false, "is_const": false, "is_reference": false, @@ -62855,9 +59528,9 @@ "is_vector": false, "type_parameter": null }, - "j": { - "type": "json", - "description": "The json to be sent.", + "body": { + "type": "string", + "description": "The body of the message to post", "is_pointer": false, "is_const": false, "is_reference": false, @@ -62870,53 +59543,47 @@ } }, "attributes": { - "class": "http_request", - "method": "send_response", - "suffix": "json", - "group": "networking", - "static": "web_server", - "self": "r" + "group": "networking" }, "signatures": { - "python": [ - "def send_response_json(r, j):" - ], "cpp": [ - "void send_response(http_request r, json j)" + "http_response http_post(const string &url, unsigned short port, string body)" + ], + "python": [ + "def http_post(url, port, body):" ], "csharp": [ - "public void HttpRequest.SendResponse(Json j);", - "public static void SplashKit.SendResponse(HttpRequest r, Json j);" + "public static HttpResponse SplashKit.HttpPost(string url, ushort port, string body);" ], "pascal": [ - "procedure SendResponse(r: HttpRequest; j: Json)" + "function HttpPost(const url: String; port: Word; body: String): HttpResponse" ] } }, { - "signature": "vector split_uri_stubs(const string &uri);", - "name": "split_uri_stubs", + "signature": "string http_response_to_string(http_response response);", + "name": "http_response_to_string", "method_name": null, - "unique_global_name": "split_uri_stubs", + "unique_global_name": "http_response_to_string", "unique_method_name": null, "suffix_name": null, - "description": "Returns an array of strings representing each stub of the URI.\n\nFor example a request sent to `http://localhost:8080/names/0` returns...\n\n[\"names\", \"0\"]", + "description": "Read the HTTP response and convert it to text", "brief": null, "return": { - "type": "vector", - "description": "The array of stubs as strings.", + "type": "string", + "description": "The data from the response as text", "is_pointer": false, "is_reference": false, - "is_vector": true, - "type_parameter": "string" + "is_vector": false, + "type_parameter": null }, "parameters": { - "uri": { - "type": "string", - "description": "The URI to split into stubs.", + "response": { + "type": "http_response", + "description": "The response from the server", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -62926,87 +59593,57 @@ } }, "attributes": { - "group": "networking", - "static": "web_server" + "group": "networking" }, "signatures": { - "python": [ - "def split_uri_stubs(uri):" - ], "cpp": [ - "vector split_uri_stubs(const string &uri)" - ], - "csharp": [ - "public static List SplashKit.SplitURIStubs(string uri);" + "string http_response_to_string(http_response response)" ], - "pascal": [ - "function SplitURIStubs(const uri: String): ArrayOfString" - ] - } - }, - { - "signature": "web_server start_web_server();", - "name": "start_web_server", - "method_name": null, - "unique_global_name": "start_web_server_with_default_port", - "unique_method_name": null, - "suffix_name": null, - "description": "Creates a new web server listening for connections on port 8080.", - "brief": null, - "return": { - "type": "web_server", - "description": "Returns a new `web_sever` instance.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "class": "web_server", - "constructor": true, - "suffix": "with_default_port", - "group": "networking", - "static": "web_server" - }, - "signatures": { "python": [ - "def start_web_server_with_default_port():" - ], - "cpp": [ - "web_server start_web_server()" + "def http_response_to_string(response):" ], "csharp": [ - "public static WebServer SplashKit.StartWebServer();", - "public WebServer();" + "public static string SplashKit.HttpResponseToString(HttpResponse response);" ], "pascal": [ - "function StartWebServer(): WebServer" + "function HttpResponseToString(response: HttpResponse): String" ] } }, { - "signature": "web_server start_web_server(unsigned short port);", - "name": "start_web_server", + "signature": "void save_response_to_file(http_response response,string path);", + "name": "save_response_to_file", "method_name": null, - "unique_global_name": "start_web_server", + "unique_global_name": "save_response_to_file", "unique_method_name": null, "suffix_name": null, - "description": "Starts the web server on a given port number.", + "description": "Save the HTTP response downloaded into a file.", "brief": null, "return": { - "type": "web_server", - "description": "Returns a new `web_server` instance.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "port": { - "type": "unsigned short", - "description": "The port number to connect through.", + "response": { + "type": "http_response", + "description": "The response from the server", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "path": { + "type": "string", + "description": "The path to the file where the response should be saved", "is_pointer": false, "is_const": false, "is_reference": false, @@ -63019,39 +59656,35 @@ } }, "attributes": { - "class": "web_server", - "constructor": true, - "group": "networking", - "static": "web_server" + "group": "networking" }, "signatures": { - "python": [ - "def start_web_server(port):" - ], "cpp": [ - "web_server start_web_server(unsigned short port)" + "void save_response_to_file(http_response response, string path)" + ], + "python": [ + "def save_response_to_file(response, path):" ], "csharp": [ - "public static WebServer SplashKit.StartWebServer(ushort port);", - "public WebServer(ushort port);" + "public static void SplashKit.SaveResponseToFile(HttpResponse response, string path);" ], "pascal": [ - "function StartWebServer(port: Word): WebServer" + "procedure SaveResponseToFile(response: HttpResponse; path: String)" ] } }, { - "signature": "void stop_web_server(web_server server);", - "name": "stop_web_server", - "method_name": "stop", - "unique_global_name": "stop_web_server", - "unique_method_name": "web_server.stop", + "signature": "bool has_incoming_requests(web_server server);", + "name": "has_incoming_requests", + "method_name": null, + "unique_global_name": "has_incoming_requests", + "unique_method_name": null, "suffix_name": null, - "description": "Stops a given `web_server` instance.", + "description": "Returns true if the given `web_sever` has pending requests.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "Returns a `bool` denoting whether the `web_server` has pending requests.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -63060,7 +59693,7 @@ "parameters": { "server": { "type": "web_server", - "description": "The server instance to stop.", + "description": "The `web_server` to check for waiting requests.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -63074,227 +59707,48 @@ }, "attributes": { "class": "web_server", - "destructor": true, - "method": "stop", + "getter": "has_incoming_requests", "self": "server", "group": "networking", "static": "web_server" }, "signatures": { - "python": [ - "def stop_web_server(server):" - ], "cpp": [ - "void stop_web_server(web_server server)" + "bool has_incoming_requests(web_server server)" + ], + "python": [ + "def has_incoming_requests(server):" ], "csharp": [ - "public void WebServer.Stop();", - "public static void SplashKit.StopWebServer(WebServer server);" + "public bool WebServer.HasIncomingRequests { get }", + "public static bool SplashKit.HasIncomingRequests(WebServer server);" ], "pascal": [ - "procedure StopWebServer(server: WebServer)" + "function HasIncomingRequests(server: WebServer): Boolean" ] } - } - ], - "typedefs": [ - { - "signature": "typedef struct sk_connection_data *connection;", - "name": "connection", - "description": "A connection represents the communication channel from a client going to\na server. This can be used for the client and the server to send and\nreceive messages.", - "brief": null, - "attributes": { - "class": "connection", - "group": "networking", - "static": "networking" - }, - "is_function_pointer": false, - "aliased_type": null, - "aliased_identifier": null, - "is_pointer": false, - "new_identifier": null - }, - { - "signature": "typedef struct sk_message *message;", - "name": "message", - "description": "A message contains data that has been transferred between a client\nconnection and a server (or visa versa).", - "brief": null, - "attributes": { - "class": "message", - "group": "networking", - "static": "networking" - }, - "is_function_pointer": false, - "aliased_type": null, - "aliased_identifier": null, - "is_pointer": false, - "new_identifier": null - }, - { - "signature": "typedef struct sk_server_data *server_socket;", - "name": "server_socket", - "description": "A server represents a network resource that clients can connect to. The\nserver will receive messages from all of the client connections, and can\nbe used to access the clients connected to the server.", - "brief": null, - "attributes": { - "class": "server_socket", - "group": "networking", - "static": "networking" - }, - "is_function_pointer": false, - "aliased_type": null, - "aliased_identifier": null, - "is_pointer": false, - "new_identifier": null - }, - { - "signature": "typedef struct sk_http_response *http_response;", - "name": "http_response", - "description": "A HTTP response is a resource that comes back from a HTTP request. This\nmay be the text related to a web page, or the data related to a resource.\nOnce you have used the response, you need to make sure to call\n`free_response`.", - "brief": null, - "attributes": { - "class": "http_response", - "group": "networking" - }, - "is_function_pointer": false, - "aliased_type": null, - "aliased_identifier": null, - "is_pointer": false, - "new_identifier": null - }, - { - "signature": "typedef struct sk_http_request *http_request;", - "name": "http_request", - "description": "The request contains the details of the resource the user is requesting.", - "brief": null, - "attributes": { - "class": "http_request", - "no_destructor": true, - "group": "networking", - "static": "web_server" - }, - "is_function_pointer": false, - "aliased_type": null, - "aliased_identifier": null, - "is_pointer": false, - "new_identifier": null - }, - { - "signature": "typedef struct sk_web_server *web_server;", - "name": "web_server", - "description": "The web server is able to listen for incoming requests, and you can then provide the response.", - "brief": null, - "attributes": { - "class": "web_server", - "group": "networking", - "static": "web_server" - }, - "is_function_pointer": false, - "aliased_type": null, - "aliased_identifier": null, - "is_pointer": false, - "new_identifier": null - } - ], - "structs": [ - - ], - "enums": [ - { - "signature": "enum connection_type {TCP,UDP,UNKNOWN};", - "name": "connection_type", - "description": "The kind of protocol used for a server of connection.", - "brief": null, - "constants": { - "TCP": { - "description": "Uses the TCP protocol. SplashKit can send messages of any\nsize, and repackage it from you at the other end. Messages\nare reliably transferred." - }, - "UDP": { - "description": "Uses the UDP protocol. SplashKit will send messages of up\nto 1024 bytes (by default). You need to handle packaging\nanything larger than this." - }, - "UNKNOWN": { - "description": "The protocol is unknown, usually due to the connection\nor server being invalid or closed." - } - }, - "attributes": { - "group": "networking", - "static": "networking" - }, - "signatures": { - "python": "public enum {ConnectionType.tcp = 0, ConnectionType.udp = 0, ConnectionType.unknown = 0}", - "cpp": "class connection_type {TCP = 0, UDP = 0, UNKNOWN = 0};", - "csharp": "public enum {ConnectionType.TCP = 0, ConnectionType.UDP = 0, ConnectionType.Unknown = 0}", - "pascal": "public enum {ConnectionType.TCP = 0, ConnectionType.UDP = 0, ConnectionType.Unknown = 0}" - } }, { - "signature": "enum http_method {HTTP_GET_METHOD,HTTP_POST_METHOD,HTTP_PUT_METHOD,HTTP_DELETE_METHOD,HTTP_OPTIONS_METHOD,HTTP_TRACE_METHOD,UNKNOWN_HTTP_METHOD};", - "name": "http_method", - "description": "The method token is used to indicate the kind of action to be performed\non the server. See [W3 specifications](https://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html).", - "brief": null, - "constants": { - "HTTP_GET_METHOD": { - "description": "A get method" - }, - "HTTP_POST_METHOD": { - "description": "A post method" - }, - "HTTP_PUT_METHOD": { - "description": "A put method" - }, - "HTTP_DELETE_METHOD": { - "description": "A delete method" - }, - "HTTP_OPTIONS_METHOD": { - "description": "An options method" - }, - "HTTP_TRACE_METHOD": { - "description": "A trace method" - }, - "UNKNOWN_HTTP_METHOD": { - "description": "A method not recognised by SplashKit" - } - }, - "attributes": { - "group": "networking", - "static": "web_server" - }, - "signatures": { - "python": "public enum {HttpMethod.http_get_method = 0, HttpMethod.http_post_method = 0, HttpMethod.http_put_method = 0, HttpMethod.http_delete_method = 0, HttpMethod.http_options_method = 0, HttpMethod.http_trace_method = 0, HttpMethod.unknown_http_method = 0}", - "cpp": "class http_method {HTTP_GET_METHOD = 0, HTTP_POST_METHOD = 0, HTTP_PUT_METHOD = 0, HTTP_DELETE_METHOD = 0, HTTP_OPTIONS_METHOD = 0, HTTP_TRACE_METHOD = 0, UNKNOWN_HTTP_METHOD = 0};", - "csharp": "public enum {HttpMethod.HttpGetMethod = 0, HttpMethod.HttpPostMethod = 0, HttpMethod.HttpPutMethod = 0, HttpMethod.HttpDeleteMethod = 0, HttpMethod.HttpOptionsMethod = 0, HttpMethod.HttpTraceMethod = 0, HttpMethod.UnknownHttpMethod = 0}", - "pascal": "public enum {HttpMethod.HttpGetMethod = 0, HttpMethod.HttpPostMethod = 0, HttpMethod.HttpPutMethod = 0, HttpMethod.HttpDeleteMethod = 0, HttpMethod.HttpOptionsMethod = 0, HttpMethod.HttpTraceMethod = 0, HttpMethod.UnknownHttpMethod = 0}" - } - } - ], - "defines": [ - - ] - }, - "physics": { - "brief": "SplashKit Collisions library allow you to perform tests between\nbitmaps, sprites and shapes to determin if a collision has occured.Provides matrix functions to work on 2d coordinates.Provides vector functions to work on vectors.", - "description": "", - "functions": [ - { - "signature": "bool bitmap_circle_collision(bitmap bmp,const point_2d &pt,const circle &circ);", - "name": "bitmap_circle_collision", - "method_name": "circle_collision", - "unique_global_name": "bitmap_circle_collision_at_point", - "unique_method_name": "bitmap.circle_collision_at_point", + "signature": "bool is_delete_request_for(http_request request,const string &path);", + "name": "is_delete_request_for", + "method_name": "is_delete_request_for", + "unique_global_name": "is_delete_request_for", + "unique_method_name": "http_request.is_delete_request_for", "suffix_name": null, - "description": "Tests if a bitmap drawn at `pt` would intersect with a circle.", + "description": "Checks if a request wants to delete a given resource.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `circ` when drawn.", + "description": "True if the request is a HTTP DELETE request for `path`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to test", + "request": { + "type": "http_request", + "description": "The request to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -63305,22 +59759,9 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The location where the bitmap is drawn", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "circ": { - "type": "circle", - "description": "The circle to test", + "path": { + "type": "string", + "description": "The resource/route path", "is_pointer": false, "is_const": true, "is_reference": true, @@ -63333,50 +59774,49 @@ } }, "attributes": { - "class": "bitmap", - "method": "circle_collision", - "suffix": "at_point", - "group": "physics", - "static": "collisions", - "self": "bmp" + "class": "http_request", + "method": "is_delete_request_for", + "group": "networking", + "static": "web_server", + "self": "request" }, "signatures": { - "python": [ - "def bitmap_circle_collision_at_point(bmp, pt, circ):" - ], "cpp": [ - "bool bitmap_circle_collision(bitmap bmp, const point_2d &pt, const circle &circ)" + "bool is_delete_request_for(http_request request, const string &path)" + ], + "python": [ + "def is_delete_request_for(request, path):" ], "csharp": [ - "public bool Bitmap.CircleCollision(Point2D pt, Circle circ);", - "public static bool SplashKit.BitmapCircleCollision(Bitmap bmp, Point2D pt, Circle circ);" + "public bool HttpRequest.IsDeleteRequestFor(string path);", + "public static bool SplashKit.IsDeleteRequestFor(HttpRequest request, string path);" ], "pascal": [ - "function BitmapCircleCollision(bmp: Bitmap; const pt: Point2D; const circ: Circle): Boolean" + "function IsDeleteRequestFor(request: HttpRequest; const path: String): Boolean" ] } }, { - "signature": "bool bitmap_circle_collision(bitmap bmp,double x,double y,const circle &circ);", - "name": "bitmap_circle_collision", - "method_name": "circle_collision", - "unique_global_name": "bitmap_circle_collision", - "unique_method_name": "bitmap.circle_collision", + "signature": "bool is_get_request_for(http_request request,const string &path);", + "name": "is_get_request_for", + "method_name": "is_get_request_for", + "unique_global_name": "is_get_request_for", + "unique_method_name": "http_request.is_get_request_for", "suffix_name": null, - "description": "Tests if a bitmap drawn at `x`, `y` would intersect with a circle.", + "description": "Checks if a request wants to get a given resource.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the bitmap will\nintersect with `circ` when drawn.", + "description": "True if the request is a HTTP GET request for `path`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to test", + "request": { + "type": "http_request", + "description": "The request to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -63387,22 +59827,64 @@ "is_vector": false, "type_parameter": null }, - "x": { - "type": "double", - "description": "The x location where the bitmap is drawn", + "path": { + "type": "string", + "description": "The resource/route path", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location where the bitmap is drawn", + } + }, + "attributes": { + "class": "http_request", + "method": "is_get_request_for", + "group": "networking", + "static": "web_server", + "self": "request" + }, + "signatures": { + "cpp": [ + "bool is_get_request_for(http_request request, const string &path)" + ], + "python": [ + "def is_get_request_for(request, path):" + ], + "csharp": [ + "public bool HttpRequest.IsGetRequestFor(string path);", + "public static bool SplashKit.IsGetRequestFor(HttpRequest request, string path);" + ], + "pascal": [ + "function IsGetRequestFor(request: HttpRequest; const path: String): Boolean" + ] + } + }, + { + "signature": "bool is_options_request_for(http_request request,const string &path);", + "name": "is_options_request_for", + "method_name": "is_options_request_for", + "unique_global_name": "is_options_request_for", + "unique_method_name": "http_request.is_options_request_for", + "suffix_name": null, + "description": "Checks if a request wants to check options for given resource.", + "brief": null, + "return": { + "type": "bool", + "description": "True if the request is a HTTP OPTIONS request for `path`", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "request": { + "type": "http_request", + "description": "The request to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -63413,9 +59895,9 @@ "is_vector": false, "type_parameter": null }, - "circ": { - "type": "circle", - "description": "The circle to test", + "path": { + "type": "string", + "description": "The resource/route path", "is_pointer": false, "is_const": true, "is_reference": true, @@ -63428,49 +59910,49 @@ } }, "attributes": { - "class": "bitmap", - "method": "circle_collision", - "group": "physics", - "static": "collisions", - "self": "bmp" + "class": "http_request", + "method": "is_options_request_for", + "group": "networking", + "static": "web_server", + "self": "request" }, "signatures": { - "python": [ - "def bitmap_circle_collision(bmp, x, y, circ):" - ], "cpp": [ - "bool bitmap_circle_collision(bitmap bmp, double x, double y, const circle &circ)" + "bool is_options_request_for(http_request request, const string &path)" + ], + "python": [ + "def is_options_request_for(request, path):" ], "csharp": [ - "public bool Bitmap.CircleCollision(double x, double y, Circle circ);", - "public static bool SplashKit.BitmapCircleCollision(Bitmap bmp, double x, double y, Circle circ);" + "public bool HttpRequest.IsOptionsRequestFor(string path);", + "public static bool SplashKit.IsOptionsRequestFor(HttpRequest request, string path);" ], "pascal": [ - "function BitmapCircleCollision(bmp: Bitmap; x: Double; y: Double; const circ: Circle): Boolean" + "function IsOptionsRequestFor(request: HttpRequest; const path: String): Boolean" ] } }, { - "signature": "bool bitmap_circle_collision(bitmap bmp,int cell,const matrix_2d &translation,const circle &circ);", - "name": "bitmap_circle_collision", - "method_name": "circle_collision", - "unique_global_name": "bitmap_circle_collision_for_cell_with_translation", - "unique_method_name": "bitmap.circle_collision_for_cell_with_translation", + "signature": "bool is_post_request_for(http_request request,const string &path);", + "name": "is_post_request_for", + "method_name": "is_post_request_for", + "unique_global_name": "is_post_request_for", + "unique_method_name": "http_request.is_post_request_for", "suffix_name": null, - "description": "Tests if a bitmap cell drawn using a passed in translation, will\nintersect with a circle. You can use this to detect collisions between\nbitmaps and circles.", + "description": "Checks if a request wants to create (post) a given resource.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `circ` when drawn.", + "description": "True if the request is a HTTP POST request for `path`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to test", + "request": { + "type": "http_request", + "description": "The request to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -63481,9 +59963,64 @@ "is_vector": false, "type_parameter": null }, - "cell": { - "type": "int", - "description": "The cell of the bitmap to check", + "path": { + "type": "string", + "description": "The resource/route path", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } + }, + "attributes": { + "class": "http_request", + "method": "is_post_request_for", + "group": "networking", + "static": "web_server", + "self": "request" + }, + "signatures": { + "cpp": [ + "bool is_post_request_for(http_request request, const string &path)" + ], + "python": [ + "def is_post_request_for(request, path):" + ], + "csharp": [ + "public bool HttpRequest.IsPostRequestFor(string path);", + "public static bool SplashKit.IsPostRequestFor(HttpRequest request, string path);" + ], + "pascal": [ + "function IsPostRequestFor(request: HttpRequest; const path: String): Boolean" + ] + } + }, + { + "signature": "bool is_put_request_for(http_request request,const string &path);", + "name": "is_put_request_for", + "method_name": "is_put_request_for", + "unique_global_name": "is_put_request_for", + "unique_method_name": "http_request.is_put_request_for", + "suffix_name": null, + "description": "Checks if a request wants to update (put) a given resource.", + "brief": null, + "return": { + "type": "bool", + "description": "True if the request is a HTTP PUT request for `path`", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "request": { + "type": "http_request", + "description": "The request to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -63494,22 +60031,9 @@ "is_vector": false, "type_parameter": null }, - "translation": { - "type": "matrix_2d", - "description": "The matrix used to transfrom the bitmap when drawing", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "circ": { - "type": "circle", - "description": "The circle to test", + "path": { + "type": "string", + "description": "The resource/route path", "is_pointer": false, "is_const": true, "is_reference": true, @@ -63522,50 +60046,49 @@ } }, "attributes": { - "class": "bitmap", - "method": "circle_collision", - "suffix": "for_cell_with_translation", - "group": "physics", - "static": "collisions", - "self": "bmp" + "class": "http_request", + "method": "is_put_request_for", + "group": "networking", + "static": "web_server", + "self": "request" }, "signatures": { - "python": [ - "def bitmap_circle_collision_for_cell_with_translation(bmp, cell, translation, circ):" - ], "cpp": [ - "bool bitmap_circle_collision(bitmap bmp, int cell, const matrix_2d &translation, const circle &circ)" + "bool is_put_request_for(http_request request, const string &path)" + ], + "python": [ + "def is_put_request_for(request, path):" ], "csharp": [ - "public bool Bitmap.CircleCollision(int cell, Matrix2D translation, Circle circ);", - "public static bool SplashKit.BitmapCircleCollision(Bitmap bmp, int cell, Matrix2D translation, Circle circ);" + "public bool HttpRequest.IsPutRequestFor(string path);", + "public static bool SplashKit.IsPutRequestFor(HttpRequest request, string path);" ], "pascal": [ - "function BitmapCircleCollision(bmp: Bitmap; cell: Integer; const translation: Matrix2D; const circ: Circle): Boolean" + "function IsPutRequestFor(request: HttpRequest; const path: String): Boolean" ] } }, { - "signature": "bool bitmap_circle_collision(bitmap bmp,int cell,const point_2d &pt,const circle &circ);", - "name": "bitmap_circle_collision", - "method_name": "circle_collision", - "unique_global_name": "bitmap_circle_collision_for_cell_at_point", - "unique_method_name": "bitmap.circle_collision_for_cell_at_point", + "signature": "bool is_request_for(http_request request,http_method method,const string &path);", + "name": "is_request_for", + "method_name": "is_request_for", + "unique_global_name": "is_request_for", + "unique_method_name": "http_request.is_request_for", "suffix_name": null, - "description": "Tests if a bitmap cell drawn at `pt` would intersect with a circle.", + "description": "Checks if a request is after a given resource.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `circ` when drawn.", + "description": "True if the request is for the indicated method and path", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to test", + "request": { + "type": "http_request", + "description": "The request to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -63576,9 +60099,9 @@ "is_vector": false, "type_parameter": null }, - "cell": { - "type": "int", - "description": "The cell of the bitmap to check", + "method": { + "type": "http_method", + "description": "The kind of request", "is_pointer": false, "is_const": false, "is_reference": false, @@ -63589,22 +60112,9 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The location where the bitmap is drawn", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "circ": { - "type": "circle", - "description": "The circle to test", + "path": { + "type": "string", + "description": "The resource/route path", "is_pointer": false, "is_const": true, "is_reference": true, @@ -63617,89 +60127,49 @@ } }, "attributes": { - "class": "bitmap", - "method": "circle_collision", - "suffix": "for_cell_at_point", - "group": "physics", - "static": "collisions", - "self": "bmp" + "class": "http_request", + "method": "is_request_for", + "group": "networking", + "static": "web_server", + "self": "request" }, "signatures": { - "python": [ - "def bitmap_circle_collision_for_cell_at_point(bmp, cell, pt, circ):" - ], "cpp": [ - "bool bitmap_circle_collision(bitmap bmp, int cell, const point_2d &pt, const circle &circ)" + "bool is_request_for(http_request request, http_method method, const string &path)" + ], + "python": [ + "def is_request_for(request, method, path):" ], "csharp": [ - "public bool Bitmap.CircleCollision(int cell, Point2D pt, Circle circ);", - "public static bool SplashKit.BitmapCircleCollision(Bitmap bmp, int cell, Point2D pt, Circle circ);" + "public bool HttpRequest.IsRequestFor(HttpMethod method, string path);", + "public static bool SplashKit.IsRequestFor(HttpRequest request, HttpMethod method, string path);" ], "pascal": [ - "function BitmapCircleCollision(bmp: Bitmap; cell: Integer; const pt: Point2D; const circ: Circle): Boolean" + "function IsRequestFor(request: HttpRequest; method: HttpMethod; const path: String): Boolean" ] } }, { - "signature": "bool bitmap_circle_collision(bitmap bmp,int cell,double x,double y,const circle &circ);", - "name": "bitmap_circle_collision", - "method_name": "circle_collision", - "unique_global_name": "bitmap_circle_collision_for_cell", - "unique_method_name": "bitmap.circle_collision_for_cell", + "signature": "bool is_trace_request_for(http_request request,const string &path);", + "name": "is_trace_request_for", + "method_name": "is_trace_request_for", + "unique_global_name": "is_trace_request_for", + "unique_method_name": "http_request.is_trace_request_for", "suffix_name": null, - "description": "Tests if a bitmap cell drawn at `x`, `y` would intersect with a circle.", + "description": "Checks if a request wants to trace a given resource.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the bitmap will\nintersect with `circ` when drawn.", + "description": "True if the request is a HTTP TRACE request for `path`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to test", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "cell": { - "type": "int", - "description": "The cell of the bitmap to check", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The x location where the bitmap is drawn", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location where the bitmap is drawn", + "request": { + "type": "http_request", + "description": "The request to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -63710,9 +60180,9 @@ "is_vector": false, "type_parameter": null }, - "circ": { - "type": "circle", - "description": "The circle to test", + "path": { + "type": "string", + "description": "The resource/route path", "is_pointer": false, "is_const": true, "is_reference": true, @@ -63725,102 +60195,49 @@ } }, "attributes": { - "class": "bitmap", - "method": "circle_collision", - "suffix": "for_cell", - "group": "physics", - "static": "collisions", - "self": "bmp" + "class": "http_request", + "method": "is_trace_request_for", + "group": "networking", + "static": "web_server", + "self": "request" }, "signatures": { - "python": [ - "def bitmap_circle_collision_for_cell(bmp, cell, x, y, circ):" - ], "cpp": [ - "bool bitmap_circle_collision(bitmap bmp, int cell, double x, double y, const circle &circ)" + "bool is_trace_request_for(http_request request, const string &path)" + ], + "python": [ + "def is_trace_request_for(request, path):" ], "csharp": [ - "public bool Bitmap.CircleCollision(int cell, double x, double y, Circle circ);", - "public static bool SplashKit.BitmapCircleCollision(Bitmap bmp, int cell, double x, double y, Circle circ);" + "public bool HttpRequest.IsTraceRequestFor(string path);", + "public static bool SplashKit.IsTraceRequestFor(HttpRequest request, string path);" ], "pascal": [ - "function BitmapCircleCollision(bmp: Bitmap; cell: Integer; x: Double; y: Double; const circ: Circle): Boolean" + "function IsTraceRequestFor(request: HttpRequest; const path: String): Boolean" ] } }, { - "signature": "bool bitmap_collision(bitmap bmp1,double x1,double y1,bitmap bmp2,double x2,double y2);", - "name": "bitmap_collision", - "method_name": "bitmap_collision", - "unique_global_name": "bitmap_collision", - "unique_method_name": "bitmap.bitmap_collision", + "signature": "http_request next_web_request(web_server server);", + "name": "next_web_request", + "method_name": null, + "unique_global_name": "next_web_request", + "unique_method_name": null, "suffix_name": null, - "description": "Check if two bitmaps collide.", + "description": "Returns the next request on a given `web_server` instance", "brief": null, "return": { - "type": "bool", - "description": "True if pixels in the two bitmaps would collide/overlap", + "type": "http_request", + "description": "Returns the next request on the given `web_server` instance.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp1": { - "type": "bitmap", - "description": "The first bitmap", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x1": { - "type": "double", - "description": "The x location where the first bitmap is drawn", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y1": { - "type": "double", - "description": "The y location where the first bitmap is drawn", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "bmp2": { - "type": "bitmap", - "description": "The second bitmap", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x2": { - "type": "double", - "description": "The x location where the second bitmap is drawn", + "server": { + "type": "web_server", + "description": "The `web_server` to get the `http_request` from.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -63830,10 +60247,52 @@ ], "is_vector": false, "type_parameter": null - }, - "y2": { - "type": "double", - "description": "The y location where the second bitmap is drawn", + } + }, + "attributes": { + "class": "web_server", + "getter": "next_web_request", + "self": "server", + "group": "networking", + "static": "web_server" + }, + "signatures": { + "cpp": [ + "http_request next_web_request(web_server server)" + ], + "python": [ + "def next_web_request(server):" + ], + "csharp": [ + "public HttpRequest WebServer.NextWebRequest { get }", + "public static HttpRequest SplashKit.NextWebRequest(WebServer server);" + ], + "pascal": [ + "function NextWebRequest(server: WebServer): HttpRequest" + ] + } + }, + { + "signature": "string request_body(http_request r);", + "name": "request_body", + "method_name": null, + "unique_global_name": "request_body", + "unique_method_name": null, + "suffix_name": null, + "description": "Returns the body of the request.", + "brief": null, + "return": { + "type": "string", + "description": "The body of the request.", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "r": { + "type": "http_request", + "description": "A request object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -63846,49 +60305,49 @@ } }, "attributes": { - "class": "bitmap", - "method": "bitmap_collision", - "group": "physics", - "static": "collisions", - "self": "bmp1" + "class": "http_request", + "getter": "body", + "group": "networking", + "static": "web_server", + "self": "r" }, "signatures": { - "python": [ - "def bitmap_collision(bmp1, x1, y1, bmp2, x2, y2):" - ], "cpp": [ - "bool bitmap_collision(bitmap bmp1, double x1, double y1, bitmap bmp2, double x2, double y2)" + "string request_body(http_request r)" + ], + "python": [ + "def request_body(r):" ], "csharp": [ - "public bool Bitmap.BitmapCollision(double x1, double y1, Bitmap bmp2, double x2, double y2);", - "public static bool SplashKit.BitmapCollision(Bitmap bmp1, double x1, double y1, Bitmap bmp2, double x2, double y2);" + "public string HttpRequest.Body { get }", + "public static string SplashKit.RequestBody(HttpRequest r);" ], "pascal": [ - "function BitmapCollision(bmp1: Bitmap; x1: Double; y1: Double; bmp2: Bitmap; x2: Double; y2: Double): Boolean" + "function RequestBody(r: HttpRequest): String" ] } }, { - "signature": "bool bitmap_collision(bitmap bmp1,const point_2d &pt1,bitmap bmp2,const point_2d &pt2);", - "name": "bitmap_collision", - "method_name": "bitmap_collision", - "unique_global_name": "bitmap_collision_at_points", - "unique_method_name": "bitmap.bitmap_collision_at_points", + "signature": "bool request_has_query_parameter(http_request r,const string &name);", + "name": "request_has_query_parameter", + "method_name": "has_query_parameter", + "unique_global_name": "request_has_query_parameter", + "unique_method_name": "http_request.has_query_parameter", "suffix_name": null, - "description": "Check if two bitmaps collide.", + "description": "Returns true if the parameter exists in the query string.", "brief": null, "return": { "type": "bool", - "description": "True if pixels in the two bitmaps would collide/overlap", + "description": "True if the parameter exists in the user's request.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp1": { - "type": "bitmap", - "description": "The first bitmap", + "r": { + "type": "http_request", + "description": "A request object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -63899,9 +60358,9 @@ "is_vector": false, "type_parameter": null }, - "pt1": { - "type": "point_2d", - "description": "The point where bitmap 1 is drawn", + "name": { + "type": "string", + "description": "The name of the parameter to check", "is_pointer": false, "is_const": true, "is_reference": true, @@ -63911,10 +60370,52 @@ ], "is_vector": false, "type_parameter": null - }, - "bmp2": { - "type": "bitmap", - "description": "The second bitmap", + } + }, + "attributes": { + "class": "http_request", + "method": "has_query_parameter", + "group": "networking", + "static": "web_server", + "self": "r" + }, + "signatures": { + "cpp": [ + "bool request_has_query_parameter(http_request r, const string &name)" + ], + "python": [ + "def request_has_query_parameter(r, name):" + ], + "csharp": [ + "public bool HttpRequest.HasQueryParameter(string name);", + "public static bool SplashKit.RequestHasQueryParameter(HttpRequest r, string name);" + ], + "pascal": [ + "function RequestHasQueryParameter(r: HttpRequest; const name: String): Boolean" + ] + } + }, + { + "signature": "vector request_headers(http_request r);", + "name": "request_headers", + "method_name": null, + "unique_global_name": "request_headers", + "unique_method_name": null, + "suffix_name": null, + "description": "Returns the headers of the request.", + "brief": null, + "return": { + "type": "vector", + "description": "The headers of the request.", + "is_pointer": false, + "is_reference": false, + "is_vector": true, + "type_parameter": "string" + }, + "parameters": { + "r": { + "type": "http_request", + "description": "A request object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -63924,13 +60425,55 @@ ], "is_vector": false, "type_parameter": null - }, - "pt2": { - "type": "point_2d", - "description": "The point where bitmap 2 is drawn", + } + }, + "attributes": { + "class": "http_request", + "getter": "headers", + "group": "networking", + "static": "web_server", + "self": "r" + }, + "signatures": { + "cpp": [ + "vector request_headers(http_request r)" + ], + "python": [ + "def request_headers(r):" + ], + "csharp": [ + "public List HttpRequest.Headers { get }", + "public static List SplashKit.RequestHeaders(HttpRequest r);" + ], + "pascal": [ + "function RequestHeaders(r: HttpRequest): ArrayOfString" + ] + } + }, + { + "signature": "http_method request_method(http_request r);", + "name": "request_method", + "method_name": null, + "unique_global_name": "request_method", + "unique_method_name": null, + "suffix_name": null, + "description": "Returns the HTTP method of the client request.", + "brief": null, + "return": { + "type": "http_method", + "description": "Returns the request method.", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "r": { + "type": "http_request", + "description": "A request object.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -63940,63 +60483,49 @@ } }, "attributes": { - "class": "bitmap", - "method": "bitmap_collision", - "suffix": "at_points", - "group": "physics", - "static": "collisions", - "self": "bmp1" + "class": "http_request", + "getter": "method", + "group": "networking", + "static": "web_server", + "self": "r" }, "signatures": { - "python": [ - "def bitmap_collision_at_points(bmp1, pt1, bmp2, pt2):" - ], "cpp": [ - "bool bitmap_collision(bitmap bmp1, const point_2d &pt1, bitmap bmp2, const point_2d &pt2)" + "http_method request_method(http_request r)" + ], + "python": [ + "def request_method(r):" ], "csharp": [ - "public bool Bitmap.BitmapCollision(Point2D pt1, Bitmap bmp2, Point2D pt2);", - "public static bool SplashKit.BitmapCollision(Bitmap bmp1, Point2D pt1, Bitmap bmp2, Point2D pt2);" + "public HttpMethod HttpRequest.Method { get }", + "public static HttpMethod SplashKit.RequestMethod(HttpRequest r);" ], "pascal": [ - "function BitmapCollision(bmp1: Bitmap; const pt1: Point2D; bmp2: Bitmap; const pt2: Point2D): Boolean" + "function RequestMethod(r: HttpRequest): HttpMethod" ] } }, { - "signature": "bool bitmap_collision(bitmap bmp1,int cell1,const matrix_2d &matrix1,bitmap bmp2,int cell2,const matrix_2d &matrix2);", - "name": "bitmap_collision", - "method_name": "bitmap_collision", - "unique_global_name": "bitmap_collision_for_cells_with_translations", - "unique_method_name": "bitmap.bitmap_collision_for_cells_with_translations", + "signature": "string request_query_parameter(http_request r,const string &name,const string &default_value);", + "name": "request_query_parameter", + "method_name": "query_parameter", + "unique_global_name": "request_query_parameter", + "unique_method_name": "http_request.query_parameter", "suffix_name": null, - "description": "Check if two bitmaps collide, based on their cell and transform\nmatricies.", + "description": "Returns the value of a parameter from within the query string, or the supplied default\nif no matching parameter is found.", "brief": null, "return": { - "type": "bool", - "description": "True if pixels in the two bitmaps would collide/overlap", + "type": "string", + "description": "Returns value of the parameter from the query string, or the default value if the parameter is not found.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp1": { - "type": "bitmap", - "description": "The first bitmap", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "cell1": { - "type": "int", - "description": "The cell of the first bitmap.", + "r": { + "type": "http_request", + "description": "A request object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64007,9 +60536,9 @@ "is_vector": false, "type_parameter": null }, - "matrix1": { - "type": "matrix_2d", - "description": "The transformation for the first matrix", + "name": { + "type": "string", + "description": "The name of the parameter to fetch", "is_pointer": false, "is_const": true, "is_reference": true, @@ -64020,35 +60549,9 @@ "is_vector": false, "type_parameter": null }, - "bmp2": { - "type": "bitmap", - "description": "The second bitmap", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "cell2": { - "type": "int", - "description": "The cell of the second bitmap.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "matrix2": { - "type": "matrix_2d", - "description": "The transformation for the second matrix", + "default_value": { + "type": "string", + "description": "The value to return if the named parameter is not in the query string.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -64061,50 +60564,49 @@ } }, "attributes": { - "class": "bitmap", - "method": "bitmap_collision", - "suffix": "for_cells_with_translations", - "group": "physics", - "static": "collisions", - "self": "bmp1" + "class": "http_request", + "method": "query_parameter", + "group": "networking", + "static": "web_server", + "self": "r" }, "signatures": { - "python": [ - "def bitmap_collision_for_cells_with_translations(bmp1, cell1, matrix1, bmp2, cell2, matrix2):" - ], "cpp": [ - "bool bitmap_collision(bitmap bmp1, int cell1, const matrix_2d &matrix1, bitmap bmp2, int cell2, const matrix_2d &matrix2)" + "string request_query_parameter(http_request r, const string &name, const string &default_value)" + ], + "python": [ + "def request_query_parameter(r, name, default_value):" ], "csharp": [ - "public bool Bitmap.BitmapCollision(int cell1, Matrix2D matrix1, Bitmap bmp2, int cell2, Matrix2D matrix2);", - "public static bool SplashKit.BitmapCollision(Bitmap bmp1, int cell1, Matrix2D matrix1, Bitmap bmp2, int cell2, Matrix2D matrix2);" + "public string HttpRequest.QueryParameter(string name, string defaultValue);", + "public static string SplashKit.RequestQueryParameter(HttpRequest r, string name, string defaultValue);" ], "pascal": [ - "function BitmapCollision(bmp1: Bitmap; cell1: Integer; const matrix1: Matrix2D; bmp2: Bitmap; cell2: Integer; const matrix2: Matrix2D): Boolean" + "function RequestQueryParameter(r: HttpRequest; const name: String; const defaultValue: String): String" ] } }, { - "signature": "bool bitmap_collision(bitmap bmp1,int cell1,const point_2d &pt1,bitmap bmp2,int cell2,const point_2d &pt2);", - "name": "bitmap_collision", - "method_name": "bitmap_collision", - "unique_global_name": "bitmap_collision_for_cells_at_points", - "unique_method_name": "bitmap.bitmap_collision_for_cells_at_points", + "signature": "string request_query_string(http_request r);", + "name": "request_query_string", + "method_name": null, + "unique_global_name": "request_query_string", + "unique_method_name": null, "suffix_name": null, - "description": "Check if two bitmaps collide.", + "description": "Returns the URI query string of the client request.", "brief": null, "return": { - "type": "bool", - "description": "True if pixels in the two bitmaps would collide/overlap", + "type": "string", + "description": "Returns the requested URI queries in the form of a string.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp1": { - "type": "bitmap", - "description": "The first bitmap", + "r": { + "type": "http_request", + "description": "A request object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64114,10 +60616,52 @@ ], "is_vector": false, "type_parameter": null - }, - "cell1": { - "type": "int", - "description": "The cell of the first bitmap.", + } + }, + "attributes": { + "class": "http_request", + "getter": "query_string", + "group": "networking", + "static": "web_server", + "self": "r" + }, + "signatures": { + "cpp": [ + "string request_query_string(http_request r)" + ], + "python": [ + "def request_query_string(r):" + ], + "csharp": [ + "public string HttpRequest.QueryString { get }", + "public static string SplashKit.RequestQueryString(HttpRequest r);" + ], + "pascal": [ + "function RequestQueryString(r: HttpRequest): String" + ] + } + }, + { + "signature": "string request_uri(http_request r);", + "name": "request_uri", + "method_name": null, + "unique_global_name": "request_uri", + "unique_method_name": null, + "suffix_name": null, + "description": "Returns the server URI of the client request.", + "brief": null, + "return": { + "type": "string", + "description": "Returns the requested URI in the form of a string.", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "r": { + "type": "http_request", + "description": "A request object.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64127,23 +60671,52 @@ ], "is_vector": false, "type_parameter": null - }, - "pt1": { - "type": "point_2d", - "description": "The point where bitmap 1 is drawn", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "bmp2": { - "type": "bitmap", - "description": "The second bitmap", + } + }, + "attributes": { + "class": "http_request", + "getter": "uri", + "group": "networking", + "static": "web_server", + "self": "r" + }, + "signatures": { + "cpp": [ + "string request_uri(http_request r)" + ], + "python": [ + "def request_uri(r):" + ], + "csharp": [ + "public string HttpRequest.URI { get }", + "public static string SplashKit.RequestURI(HttpRequest r);" + ], + "pascal": [ + "function RequestURI(r: HttpRequest): String" + ] + } + }, + { + "signature": "vector request_uri_stubs(http_request r);", + "name": "request_uri_stubs", + "method_name": null, + "unique_global_name": "request_uri_stubs", + "unique_method_name": null, + "suffix_name": null, + "description": "Returns an array of strings representing each stub of the URI.\n\nFor example a request sent to `http://localhost:8080/names/0` returns...\n\n[\"names\", \"0\"]", + "brief": null, + "return": { + "type": "vector", + "description": "The array of stubs as strings.", + "is_pointer": false, + "is_reference": false, + "is_vector": true, + "type_parameter": "string" + }, + "parameters": { + "r": { + "type": "http_request", + "description": "The request for retrieving URI to split into stubs.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64153,10 +60726,52 @@ ], "is_vector": false, "type_parameter": null - }, - "cell2": { - "type": "int", - "description": "The cell of the second bitmap.", + } + }, + "attributes": { + "class": "http_request", + "getter": "uri_stubs", + "group": "networking", + "static": "web_server", + "self": "r" + }, + "signatures": { + "cpp": [ + "vector request_uri_stubs(http_request r)" + ], + "python": [ + "def request_uri_stubs(r):" + ], + "csharp": [ + "public List HttpRequest.URIStubs { get }", + "public static List SplashKit.RequestURIStubs(HttpRequest r);" + ], + "pascal": [ + "function RequestURIStubs(r: HttpRequest): ArrayOfString" + ] + } + }, + { + "signature": "void send_css_file_response(http_request r,const string &filename);", + "name": "send_css_file_response", + "method_name": "send_css_file_response", + "unique_global_name": "send_css_file_response", + "unique_method_name": "http_request.send_css_file_response", + "suffix_name": null, + "description": "Serves a css file to the given `http_request`.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "r": { + "type": "http_request", + "description": "The request which is asking for the resource.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64167,9 +60782,9 @@ "is_vector": false, "type_parameter": null }, - "pt2": { - "type": "point_2d", - "description": "The point where bitmap 2 is drawn", + "filename": { + "type": "string", + "description": "The name of the file in Resources/server", "is_pointer": false, "is_const": true, "is_reference": true, @@ -64182,50 +60797,49 @@ } }, "attributes": { - "class": "bitmap", - "method": "bitmap_collision", - "suffix": "for_cells_at_points", - "group": "physics", - "static": "collisions", - "self": "bmp1" + "class": "http_request", + "method": "send_css_file_response", + "group": "networking", + "static": "web_server", + "self": "r" }, "signatures": { - "python": [ - "def bitmap_collision_for_cells_at_points(bmp1, cell1, pt1, bmp2, cell2, pt2):" - ], "cpp": [ - "bool bitmap_collision(bitmap bmp1, int cell1, const point_2d &pt1, bitmap bmp2, int cell2, const point_2d &pt2)" + "void send_css_file_response(http_request r, const string &filename)" + ], + "python": [ + "def send_css_file_response(r, filename):" ], "csharp": [ - "public bool Bitmap.BitmapCollision(int cell1, Point2D pt1, Bitmap bmp2, int cell2, Point2D pt2);", - "public static bool SplashKit.BitmapCollision(Bitmap bmp1, int cell1, Point2D pt1, Bitmap bmp2, int cell2, Point2D pt2);" + "public void HttpRequest.SendCSSFileResponse(string filename);", + "public static void SplashKit.SendCSSFileResponse(HttpRequest r, string filename);" ], "pascal": [ - "function BitmapCollision(bmp1: Bitmap; cell1: Integer; const pt1: Point2D; bmp2: Bitmap; cell2: Integer; const pt2: Point2D): Boolean" + "procedure SendCSSFileResponse(r: HttpRequest; const filename: String)" ] } }, { - "signature": "bool bitmap_collision(bitmap bmp1,int cell1,double x1,double y1,bitmap bmp2,int cell2,double x2,double y2);", - "name": "bitmap_collision", - "method_name": "bitmap_collision", - "unique_global_name": "bitmap_collision_for_cells", - "unique_method_name": "bitmap.bitmap_collision_for_cells", + "signature": "void send_file_response(http_request r,const string &filename,const string &content_type);", + "name": "send_file_response", + "method_name": "send_file_response", + "unique_global_name": "send_file_response", + "unique_method_name": "http_request.send_file_response", "suffix_name": null, - "description": "Check if two bitmaps collide.", + "description": "Serves a file to the given `http_request`.", "brief": null, "return": { - "type": "bool", - "description": "True if pixels in the two bitmaps would collide/overlap", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp1": { - "type": "bitmap", - "description": "The first bitmap", + "r": { + "type": "http_request", + "description": "The request which is asking for the resource.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64236,12 +60850,12 @@ "is_vector": false, "type_parameter": null }, - "cell1": { - "type": "int", - "description": "The cell of the first bitmap.", + "filename": { + "type": "string", + "description": "The name of the file in Resources/server", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -64249,22 +60863,64 @@ "is_vector": false, "type_parameter": null }, - "x1": { - "type": "double", - "description": "The x location where the first bitmap is drawn", + "content_type": { + "type": "string", + "description": "The type of content being send:", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - }, - "y1": { - "type": "double", - "description": "The y location where the first bitmap is drawn", + } + }, + "attributes": { + "class": "http_request", + "method": "send_file_response", + "group": "networking", + "static": "web_server", + "self": "r" + }, + "signatures": { + "cpp": [ + "void send_file_response(http_request r, const string &filename, const string &content_type)" + ], + "python": [ + "def send_file_response(r, filename, content_type):" + ], + "csharp": [ + "public void HttpRequest.SendFileResponse(string filename, string contentType);", + "public static void SplashKit.SendFileResponse(HttpRequest r, string filename, string contentType);" + ], + "pascal": [ + "procedure SendFileResponse(r: HttpRequest; const filename: String; const contentType: String)" + ] + } + }, + { + "signature": "void send_html_file_response(http_request r,const string &filename);", + "name": "send_html_file_response", + "method_name": "send_html_file_response", + "unique_global_name": "send_html_file_response", + "unique_method_name": "http_request.send_html_file_response", + "suffix_name": null, + "description": "Serves a HTML file to the given `http_request`.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "r": { + "type": "http_request", + "description": "The request which is asking for the resource.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64275,22 +60931,64 @@ "is_vector": false, "type_parameter": null }, - "bmp2": { - "type": "bitmap", - "description": "The second bitmap", + "filename": { + "type": "string", + "description": "The name of the file in Resources/server", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - }, - "cell2": { - "type": "int", - "description": "The cell of the second bitmap.", + } + }, + "attributes": { + "class": "http_request", + "method": "send_html_file_response", + "group": "networking", + "static": "web_server", + "self": "r" + }, + "signatures": { + "cpp": [ + "void send_html_file_response(http_request r, const string &filename)" + ], + "python": [ + "def send_html_file_response(r, filename):" + ], + "csharp": [ + "public void HttpRequest.SendHtmlFileResponse(string filename);", + "public static void SplashKit.SendHtmlFileResponse(HttpRequest r, string filename);" + ], + "pascal": [ + "procedure SendHtmlFileResponse(r: HttpRequest; const filename: String)" + ] + } + }, + { + "signature": "void send_javascript_file_response(http_request r,const string &filename);", + "name": "send_javascript_file_response", + "method_name": "send_javascript_file_response", + "unique_global_name": "send_javascript_file_response", + "unique_method_name": "http_request.send_javascript_file_response", + "suffix_name": null, + "description": "Serves a javascript file to the given `http_request`.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "r": { + "type": "http_request", + "description": "The request which is asking for the resource.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64301,22 +60999,64 @@ "is_vector": false, "type_parameter": null }, - "x2": { - "type": "double", - "description": "The x location where the second bitmap is drawn", + "filename": { + "type": "string", + "description": "The name of the file in Resources/server", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - }, - "y2": { - "type": "double", - "description": "The y location where the second bitmap is drawn", + } + }, + "attributes": { + "class": "http_request", + "method": "send_javascript_file_response", + "group": "networking", + "static": "web_server", + "self": "r" + }, + "signatures": { + "cpp": [ + "void send_javascript_file_response(http_request r, const string &filename)" + ], + "python": [ + "def send_javascript_file_response(r, filename):" + ], + "csharp": [ + "public void HttpRequest.SendJavascriptFileResponse(string filename);", + "public static void SplashKit.SendJavascriptFileResponse(HttpRequest r, string filename);" + ], + "pascal": [ + "procedure SendJavascriptFileResponse(r: HttpRequest; const filename: String)" + ] + } + }, + { + "signature": "void send_response(http_request r);", + "name": "send_response", + "method_name": "send_response", + "unique_global_name": "send_response_empty", + "unique_method_name": "http_request.send_response_empty", + "suffix_name": null, + "description": "Sends a response with no content to a `http_request`.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "r": { + "type": "http_request", + "description": "The `http_request` to send the response to", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64329,50 +61069,50 @@ } }, "attributes": { - "class": "bitmap", - "method": "bitmap_collision", - "suffix": "for_cells", - "group": "physics", - "static": "collisions", - "self": "bmp1" + "class": "http_request", + "method": "send_response", + "self": "r", + "suffix": "empty", + "group": "networking", + "static": "web_server" }, "signatures": { - "python": [ - "def bitmap_collision_for_cells(bmp1, cell1, x1, y1, bmp2, cell2, x2, y2):" - ], "cpp": [ - "bool bitmap_collision(bitmap bmp1, int cell1, double x1, double y1, bitmap bmp2, int cell2, double x2, double y2)" + "void send_response(http_request r)" + ], + "python": [ + "def send_response_empty(r):" ], "csharp": [ - "public bool Bitmap.BitmapCollision(int cell1, double x1, double y1, Bitmap bmp2, int cell2, double x2, double y2);", - "public static bool SplashKit.BitmapCollision(Bitmap bmp1, int cell1, double x1, double y1, Bitmap bmp2, int cell2, double x2, double y2);" + "public void HttpRequest.SendResponse();", + "public static void SplashKit.SendResponse(HttpRequest r);" ], "pascal": [ - "function BitmapCollision(bmp1: Bitmap; cell1: Integer; x1: Double; y1: Double; bmp2: Bitmap; cell2: Integer; x2: Double; y2: Double): Boolean" + "procedure SendResponse(r: HttpRequest)" ] } }, { - "signature": "bool bitmap_point_collision(bitmap bmp,const matrix_2d &translation,const point_2d &pt);", - "name": "bitmap_point_collision", - "method_name": "point_collision", - "unique_global_name": "bitmap_point_collision_with_translation", - "unique_method_name": "bitmap.point_collision_with_translation", + "signature": "void send_response(http_request r,const string &message);", + "name": "send_response", + "method_name": "send_response", + "unique_global_name": "send_response", + "unique_method_name": "http_request.send_response", "suffix_name": null, - "description": "Tests if a bitmap drawn using the passed in translation matrix would draw a pixel\nat the passed in point. Use to check collisions between a point and a bitmap.", + "description": "Sends a message to a given `http_request`.", "brief": null, "return": { - "type": "bool", - "description": "True if drawing the bitmap, using the passed in translation,\nwill draw a pixel at the indicated point.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to test.", + "r": { + "type": "http_request", + "description": "The request to be sent.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64383,22 +61123,9 @@ "is_vector": false, "type_parameter": null }, - "translation": { - "type": "matrix_2d", - "description": "The translation matrix that represents the position, scale,\nand rotation of the bitmap when it is drawn.", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "pt": { - "type": "point_2d", - "description": "The point in the resulting drawing that is being tested.", + "message": { + "type": "string", + "description": "The message to be sent", "is_pointer": false, "is_const": true, "is_reference": true, @@ -64411,50 +61138,49 @@ } }, "attributes": { - "class": "bitmap", - "method": "point_collision", - "suffix": "with_translation", - "group": "physics", - "static": "collisions", - "self": "bmp" + "class": "http_request", + "method": "send_response", + "group": "networking", + "static": "web_server", + "self": "r" }, "signatures": { - "python": [ - "def bitmap_point_collision_with_translation(bmp, translation, pt):" - ], "cpp": [ - "bool bitmap_point_collision(bitmap bmp, const matrix_2d &translation, const point_2d &pt)" + "void send_response(http_request r, const string &message)" + ], + "python": [ + "def send_response(r, message):" ], "csharp": [ - "public bool Bitmap.PointCollision(Matrix2D translation, Point2D pt);", - "public static bool SplashKit.BitmapPointCollision(Bitmap bmp, Matrix2D translation, Point2D pt);" + "public void HttpRequest.SendResponse(string message);", + "public static void SplashKit.SendResponse(HttpRequest r, string message);" ], "pascal": [ - "function BitmapPointCollision(bmp: Bitmap; const translation: Matrix2D; const pt: Point2D): Boolean" + "procedure SendResponse(r: HttpRequest; const message: String)" ] } }, { - "signature": "bool bitmap_point_collision(bitmap bmp,const point_2d &bmp_pt,const point_2d &pt);", - "name": "bitmap_point_collision", - "method_name": "point_collision", - "unique_global_name": "bitmap_point_collision_at_point", - "unique_method_name": "bitmap.point_collision_at_point", + "signature": "void send_response(http_request r,http_status_code code);", + "name": "send_response", + "method_name": "send_response", + "unique_global_name": "send_response_json_with_status", + "unique_method_name": "http_request.send_response_json_with_status", "suffix_name": null, - "description": "Tests if a bitmap drawn at the `bmp_pt` point would draw a pixel\nat point `pt`. Use to check collisions between a point and a bitmap.", + "description": "Sends a response code to a given `http_request`.", "brief": null, "return": { - "type": "bool", - "description": "True if drawing the bitmap, at `bmp_pt`,\nwill draw a pixel at the indicated point (`pt`).", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to test.", + "r": { + "type": "http_request", + "description": "The `http_request` to send the response to", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64465,25 +61191,12 @@ "is_vector": false, "type_parameter": null }, - "bmp_pt": { - "type": "point_2d", - "description": "The point where the bitmap is drawn.", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "pt": { - "type": "point_2d", - "description": "The point in the resulting drawing that is being tested.", + "code": { + "type": "http_status_code", + "description": "The [HTTP status code](See https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) to be sent.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -64493,76 +61206,50 @@ } }, "attributes": { - "class": "bitmap", - "method": "point_collision", - "suffix": "at_point", - "group": "physics", - "static": "collisions", - "self": "bmp" + "class": "http_request", + "method": "send_response", + "self": "r", + "suffix": "json_with_status", + "group": "networking", + "static": "web_server" }, "signatures": { - "python": [ - "def bitmap_point_collision_at_point(bmp, bmp_pt, pt):" - ], "cpp": [ - "bool bitmap_point_collision(bitmap bmp, const point_2d &bmp_pt, const point_2d &pt)" + "void send_response(http_request r, http_status_code code)" + ], + "python": [ + "def send_response_json_with_status(r, code):" ], "csharp": [ - "public bool Bitmap.PointCollision(Point2D bmpPt, Point2D pt);", - "public static bool SplashKit.BitmapPointCollision(Bitmap bmp, Point2D bmpPt, Point2D pt);" + "public void HttpRequest.SendResponse(HttpStatusCode code);", + "public static void SplashKit.SendResponse(HttpRequest r, HttpStatusCode code);" ], "pascal": [ - "function BitmapPointCollision(bmp: Bitmap; const bmpPt: Point2D; const pt: Point2D): Boolean" + "procedure SendResponse(r: HttpRequest; code: HttpStatusCode)" ] } }, { - "signature": "bool bitmap_point_collision(bitmap bmp,double bmp_x,double bmp_y,double x,double y);", - "name": "bitmap_point_collision", - "method_name": "point_collision", - "unique_global_name": "bitmap_point_collision", - "unique_method_name": "bitmap.point_collision", + "signature": "void send_response(http_request r,http_status_code code,const string &message);", + "name": "send_response", + "method_name": "send_response", + "unique_global_name": "send_response_with_status", + "unique_method_name": "http_request.send_response_with_status", "suffix_name": null, - "description": "Tests if a bitmap drawn at x,y would draw a pixel at the passed in point. Use\nto check collisions between a point and a bitmap.", + "description": "Sends a message to a given `http_request` with the specified content type.", "brief": null, "return": { - "type": "bool", - "description": "True if drawing the bitmap, at the indicated location,\nwill draw a pixel at the indicated point.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to test.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "bmp_x": { - "type": "double", - "description": "The x location where the bitmap is drawn", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "bmp_y": { - "type": "double", - "description": "The y location where the bitmap is drawn", + "r": { + "type": "http_request", + "description": "The `http_request` to send the response to", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64573,9 +61260,9 @@ "is_vector": false, "type_parameter": null }, - "x": { - "type": "double", - "description": "The x location of the point to test", + "code": { + "type": "http_status_code", + "description": "The [HTTP status code](See https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) to be sent.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64586,12 +61273,12 @@ "is_vector": false, "type_parameter": null }, - "y": { - "type": "double", - "description": "The y location of the point to test", + "message": { + "type": "string", + "description": "The messsage, in the form of a `http_response`, to be sent.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -64601,49 +61288,50 @@ } }, "attributes": { - "class": "bitmap", - "method": "point_collision", - "group": "physics", - "static": "collisions", - "self": "bmp" + "class": "http_request", + "method": "send_response", + "self": "r", + "suffix": "with_status", + "group": "networking", + "static": "web_server" }, "signatures": { - "python": [ - "def bitmap_point_collision(bmp, bmp_x, bmp_y, x, y):" - ], "cpp": [ - "bool bitmap_point_collision(bitmap bmp, double bmp_x, double bmp_y, double x, double y)" + "void send_response(http_request r, http_status_code code, const string &message)" + ], + "python": [ + "def send_response_with_status(r, code, message):" ], "csharp": [ - "public bool Bitmap.PointCollision(double bmpX, double bmpY, double x, double y);", - "public static bool SplashKit.BitmapPointCollision(Bitmap bmp, double bmpX, double bmpY, double x, double y);" + "public void HttpRequest.SendResponse(HttpStatusCode code, string message);", + "public static void SplashKit.SendResponse(HttpRequest r, HttpStatusCode code, string message);" ], "pascal": [ - "function BitmapPointCollision(bmp: Bitmap; bmpX: Double; bmpY: Double; x: Double; y: Double): Boolean" + "procedure SendResponse(r: HttpRequest; code: HttpStatusCode; const message: String)" ] } }, { - "signature": "bool bitmap_point_collision(bitmap bmp,int cell,const matrix_2d &translation,const point_2d &pt);", - "name": "bitmap_point_collision", - "method_name": "point_collision", - "unique_global_name": "bitmap_point_collision_for_cell_with_translation", - "unique_method_name": "bitmap.point_collision_for_cell_with_translation", + "signature": "void send_response(http_request r,http_status_code code,const string &message,const string &content_type);", + "name": "send_response", + "method_name": "send_response", + "unique_global_name": "send_response_with_status_and_content_type", + "unique_method_name": "http_request.send_response_with_status_and_content_type", "suffix_name": null, - "description": "Tests if a bitmap cell drawn using the passed in translation matrix would draw a pixel\nat the passed in point.", + "description": "Sends a message to a given `http_request` with the specified content type.", "brief": null, "return": { - "type": "bool", - "description": "True if drawing the bitmap, using the passed in translation,\nwill draw a pixel at the indicated point.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to test.", + "r": { + "type": "http_request", + "description": "The `http_request` to send the response to", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64654,9 +61342,9 @@ "is_vector": false, "type_parameter": null }, - "cell": { - "type": "int", - "description": "The cell of the bitmap to check.", + "code": { + "type": "http_status_code", + "description": "The [HTTP status code](See https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) to be sent.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64667,9 +61355,9 @@ "is_vector": false, "type_parameter": null }, - "translation": { - "type": "matrix_2d", - "description": "The translation matrix that represents the position, scale,\nand rotation of the bitmap when it is drawn.", + "message": { + "type": "string", + "description": "The messsage, in the form of a `http_response`, to be sent.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -64680,9 +61368,9 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The point in the resulting drawing that is being tested.", + "content_type": { + "type": "string", + "description": "The content type of the response.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -64695,50 +61383,50 @@ } }, "attributes": { - "class": "bitmap", - "method": "point_collision", - "suffix": "for_cell_with_translation", - "group": "physics", - "static": "collisions", - "self": "bmp" + "class": "http_request", + "method": "send_response", + "self": "r", + "suffix": "with_status_and_content_type", + "group": "networking", + "static": "web_server" }, "signatures": { - "python": [ - "def bitmap_point_collision_for_cell_with_translation(bmp, cell, translation, pt):" - ], "cpp": [ - "bool bitmap_point_collision(bitmap bmp, int cell, const matrix_2d &translation, const point_2d &pt)" + "void send_response(http_request r, http_status_code code, const string &message, const string &content_type)" + ], + "python": [ + "def send_response_with_status_and_content_type(r, code, message, content_type):" ], "csharp": [ - "public bool Bitmap.PointCollision(int cell, Matrix2D translation, Point2D pt);", - "public static bool SplashKit.BitmapPointCollision(Bitmap bmp, int cell, Matrix2D translation, Point2D pt);" + "public void HttpRequest.SendResponse(HttpStatusCode code, string message, string contentType);", + "public static void SplashKit.SendResponse(HttpRequest r, HttpStatusCode code, string message, string contentType);" ], "pascal": [ - "function BitmapPointCollision(bmp: Bitmap; cell: Integer; const translation: Matrix2D; const pt: Point2D): Boolean" + "procedure SendResponse(r: HttpRequest; code: HttpStatusCode; const message: String; const contentType: String)" ] } }, { - "signature": "bool bitmap_point_collision(bitmap bmp,int cell,const point_2d &bmp_pt,const point_2d &pt);", - "name": "bitmap_point_collision", - "method_name": "point_collision", - "unique_global_name": "bitmap_point_collision_for_cell_at_point", - "unique_method_name": "bitmap.point_collision_for_cell_at_point", + "signature": "void send_response(http_request r,http_status_code code,const string &message,const string &content_type,const vector &headers);", + "name": "send_response", + "method_name": "send_response", + "unique_global_name": "send_response_with_status_and_content_type_and_headers", + "unique_method_name": "http_request.send_response_with_status_and_content_type_and_headers", "suffix_name": null, - "description": "Tests if a cell of a bitmap drawn at x,y would draw a pixel at the passed in point. Use\nto check collisions between a point and a bitmap.", + "description": "Sends a message to a given `http_request` with the specified content type.", "brief": null, "return": { - "type": "bool", - "description": "True if drawing the bitmap cell, at the indicated location,\nwill draw a pixel at the indicated point.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to test", + "r": { + "type": "http_request", + "description": "The `http_request` to send the response to", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64749,9 +61437,9 @@ "is_vector": false, "type_parameter": null }, - "cell": { - "type": "int", - "description": "The cell of the bitmap to test", + "code": { + "type": "http_status_code", + "description": "The [HTTP status code](See https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) to be sent.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64762,9 +61450,9 @@ "is_vector": false, "type_parameter": null }, - "bmp_pt": { - "type": "point_2d", - "description": "The point where the bitmap is drawn.", + "message": { + "type": "string", + "description": "The messsage, in the form of a `http_response`, to be sent.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -64775,9 +61463,9 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The point in the resulting drawing that is being tested.", + "content_type": { + "type": "string", + "description": "The content type of the response.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -64787,92 +61475,66 @@ ], "is_vector": false, "type_parameter": null + }, + "headers": { + "type": "vector", + "description": "The response headers", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": true, + "type_parameter": "string" } }, "attributes": { - "class": "bitmap", - "method": "point_collision", - "suffix": "for_cell_at_point", - "group": "physics", - "static": "collisions", - "self": "bmp" + "class": "http_request", + "method": "send_response", + "self": "r", + "suffix": "with_status_and_content_type_and_headers", + "group": "networking", + "static": "web_server" }, "signatures": { - "python": [ - "def bitmap_point_collision_for_cell_at_point(bmp, cell, bmp_pt, pt):" - ], "cpp": [ - "bool bitmap_point_collision(bitmap bmp, int cell, const point_2d &bmp_pt, const point_2d &pt)" + "void send_response(http_request r, http_status_code code, const string &message, const string &content_type, const vector &headers)" + ], + "python": [ + "def send_response_with_status_and_content_type_and_headers(r, code, message, content_type, headers):" ], "csharp": [ - "public bool Bitmap.PointCollision(int cell, Point2D bmpPt, Point2D pt);", - "public static bool SplashKit.BitmapPointCollision(Bitmap bmp, int cell, Point2D bmpPt, Point2D pt);" + "public void HttpRequest.SendResponse(HttpStatusCode code, string message, string contentType, List headers);", + "public static void SplashKit.SendResponse(HttpRequest r, HttpStatusCode code, string message, string contentType, List headers);" ], "pascal": [ - "function BitmapPointCollision(bmp: Bitmap; cell: Integer; const bmpPt: Point2D; const pt: Point2D): Boolean" + "procedure SendResponse(r: HttpRequest; code: HttpStatusCode; const message: String; const contentType: String; const headers: ArrayOfString)" ] } }, { - "signature": "bool bitmap_point_collision(bitmap bmp,int cell,double bmp_x,double bmp_y,double x,double y);", - "name": "bitmap_point_collision", - "method_name": "point_collision", - "unique_global_name": "bitmap_point_collision_for_cell", - "unique_method_name": "bitmap.point_collision_for_cell", + "signature": "void send_response(http_request r,json j);", + "name": "send_response", + "method_name": "send_response", + "unique_global_name": "send_response_json", + "unique_method_name": "http_request.send_response_json", "suffix_name": null, - "description": "Tests if a cell of a bitmap drawn at x,y would draw a pixel at the passed in point. Use\nto check collisions between a point and a bitmap.", + "description": "Send a JSON response to a given `http_request`", "brief": null, "return": { - "type": "bool", - "description": "True if drawing the bitmap cell, at the indicated location,\nwill draw a pixel at the indicated point.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to test", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "cell": { - "type": "int", - "description": "The cell of the bitmap to test", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "bmp_x": { - "type": "double", - "description": "The x location where the bitmap is drawn", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "bmp_y": { - "type": "double", - "description": "The y location where the bitmap is drawn", + "r": { + "type": "http_request", + "description": "The request the response belongs to.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64883,9 +61545,9 @@ "is_vector": false, "type_parameter": null }, - "x": { - "type": "double", - "description": "The x location of the point to test", + "j": { + "type": "json", + "description": "The json to be sent.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -64895,13 +61557,56 @@ ], "is_vector": false, "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location of the point to test", + } + }, + "attributes": { + "class": "http_request", + "method": "send_response", + "suffix": "json", + "group": "networking", + "static": "web_server", + "self": "r" + }, + "signatures": { + "cpp": [ + "void send_response(http_request r, json j)" + ], + "python": [ + "def send_response_json(r, j):" + ], + "csharp": [ + "public void HttpRequest.SendResponse(Json j);", + "public static void SplashKit.SendResponse(HttpRequest r, Json j);" + ], + "pascal": [ + "procedure SendResponse(r: HttpRequest; j: Json)" + ] + } + }, + { + "signature": "vector split_uri_stubs(const string &uri);", + "name": "split_uri_stubs", + "method_name": null, + "unique_global_name": "split_uri_stubs", + "unique_method_name": null, + "suffix_name": null, + "description": "Returns an array of strings representing each stub of the URI.\n\nFor example a request sent to `http://localhost:8080/names/0` returns...\n\n[\"names\", \"0\"]", + "brief": null, + "return": { + "type": "vector", + "description": "The array of stubs as strings.", + "is_pointer": false, + "is_reference": false, + "is_vector": true, + "type_parameter": "string" + }, + "parameters": { + "uri": { + "type": "string", + "description": "The URI to split into stubs.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -64911,217 +61616,366 @@ } }, "attributes": { - "class": "bitmap", - "method": "point_collision", - "suffix": "for_cell", - "group": "physics", - "static": "collisions", - "self": "bmp" + "group": "networking", + "static": "web_server" }, "signatures": { + "cpp": [ + "vector split_uri_stubs(const string &uri)" + ], "python": [ - "def bitmap_point_collision_for_cell(bmp, cell, bmp_x, bmp_y, x, y):" + "def split_uri_stubs(uri):" + ], + "csharp": [ + "public static List SplashKit.SplitURIStubs(string uri);" ], + "pascal": [ + "function SplitURIStubs(const uri: String): ArrayOfString" + ] + } + }, + { + "signature": "web_server start_web_server();", + "name": "start_web_server", + "method_name": null, + "unique_global_name": "start_web_server_with_default_port", + "unique_method_name": null, + "suffix_name": null, + "description": "Creates a new web server listening for connections on port 8080.", + "brief": null, + "return": { + "type": "web_server", + "description": "Returns a new `web_sever` instance.", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + }, + "attributes": { + "class": "web_server", + "constructor": true, + "suffix": "with_default_port", + "group": "networking", + "static": "web_server" + }, + "signatures": { "cpp": [ - "bool bitmap_point_collision(bitmap bmp, int cell, double bmp_x, double bmp_y, double x, double y)" + "web_server start_web_server()" + ], + "python": [ + "def start_web_server_with_default_port():" ], "csharp": [ - "public bool Bitmap.PointCollision(int cell, double bmpX, double bmpY, double x, double y);", - "public static bool SplashKit.BitmapPointCollision(Bitmap bmp, int cell, double bmpX, double bmpY, double x, double y);" + "public static WebServer SplashKit.StartWebServer();", + "public WebServer();" ], "pascal": [ - "function BitmapPointCollision(bmp: Bitmap; cell: Integer; bmpX: Double; bmpY: Double; x: Double; y: Double): Boolean" + "function StartWebServer(): WebServer" ] } }, { - "signature": "bool bitmap_quad_collision(bitmap bmp,const point_2d &pt,const quad &q);", - "name": "bitmap_quad_collision", - "method_name": "quad_collision", - "unique_global_name": "bitmap_quad_collision_at_point", - "unique_method_name": "bitmap.quad_collision_at_point", + "signature": "web_server start_web_server(unsigned short port);", + "name": "start_web_server", + "method_name": null, + "unique_global_name": "start_web_server", + "unique_method_name": null, "suffix_name": null, - "description": "Tests if a bitmap drawn at `pt` would intersect with a quad.", + "description": "Starts the web server on a given port number.", "brief": null, "return": { - "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `q` when drawn.", + "type": "web_server", + "description": "Returns a new `web_server` instance.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to test", + "port": { + "type": "unsigned short", + "description": "The port number to connect through.", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "pt": { - "type": "point_2d", - "description": "The location where the bitmap is drawn", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "q": { - "type": "quad", - "description": "The quad to test", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "bitmap", - "method": "quad_collision", - "suffix": "at_point", - "group": "physics", - "static": "collisions", - "self": "bmp" + "class": "web_server", + "constructor": true, + "group": "networking", + "static": "web_server" }, "signatures": { - "python": [ - "def bitmap_quad_collision_at_point(bmp, pt, q):" - ], "cpp": [ - "bool bitmap_quad_collision(bitmap bmp, const point_2d &pt, const quad &q)" + "web_server start_web_server(unsigned short port)" + ], + "python": [ + "def start_web_server(port):" ], "csharp": [ - "public bool Bitmap.QuadCollision(Point2D pt, Quad q);", - "public static bool SplashKit.BitmapQuadCollision(Bitmap bmp, Point2D pt, Quad q);" + "public static WebServer SplashKit.StartWebServer(ushort port);", + "public WebServer(ushort port);" ], "pascal": [ - "function BitmapQuadCollision(bmp: Bitmap; const pt: Point2D; const q: Quad): Boolean" + "function StartWebServer(port: Word): WebServer" ] } }, { - "signature": "bool bitmap_quad_collision(bitmap bmp,double x,double y,const quad &q);", - "name": "bitmap_quad_collision", - "method_name": "quad_collision", - "unique_global_name": "bitmap_quad_collision", - "unique_method_name": "bitmap.quad_collision", + "signature": "void stop_web_server(web_server server);", + "name": "stop_web_server", + "method_name": "stop", + "unique_global_name": "stop_web_server", + "unique_method_name": "web_server.stop", "suffix_name": null, - "description": "Tests if a bitmap drawn at `x`, `y` would intersect with a quad.", + "description": "Stops a given `web_server` instance.", "brief": null, "return": { - "type": "bool", - "description": "True if a drawn pixel in the bitmap will\nintersect with `q` when drawn.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to test", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The x location where the bitmap is drawn", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location where the bitmap is drawn", + "server": { + "type": "web_server", + "description": "The server instance to stop.", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "q": { - "type": "quad", - "description": "The quad to test", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "bitmap", - "method": "quad_collision", - "group": "physics", - "static": "collisions", - "self": "bmp" + "class": "web_server", + "destructor": true, + "method": "stop", + "self": "server", + "group": "networking", + "static": "web_server" }, "signatures": { - "python": [ - "def bitmap_quad_collision(bmp, x, y, q):" - ], "cpp": [ - "bool bitmap_quad_collision(bitmap bmp, double x, double y, const quad &q)" + "void stop_web_server(web_server server)" + ], + "python": [ + "def stop_web_server(server):" ], "csharp": [ - "public bool Bitmap.QuadCollision(double x, double y, Quad q);", - "public static bool SplashKit.BitmapQuadCollision(Bitmap bmp, double x, double y, Quad q);" + "public void WebServer.Stop();", + "public static void SplashKit.StopWebServer(WebServer server);" ], "pascal": [ - "function BitmapQuadCollision(bmp: Bitmap; x: Double; y: Double; const q: Quad): Boolean" + "procedure StopWebServer(server: WebServer)" ] } + } + ], + "typedefs": [ + { + "signature": "typedef struct sk_connection_data *connection;", + "name": "connection", + "description": "A connection represents the communication channel from a client going to\na server. This can be used for the client and the server to send and\nreceive messages.", + "brief": null, + "attributes": { + "class": "connection", + "group": "networking", + "static": "networking" + }, + "is_function_pointer": false, + "aliased_type": null, + "aliased_identifier": null, + "is_pointer": false, + "new_identifier": null + }, + { + "signature": "typedef struct sk_message *message;", + "name": "message", + "description": "A message contains data that has been transferred between a client\nconnection and a server (or visa versa).", + "brief": null, + "attributes": { + "class": "message", + "group": "networking", + "static": "networking" + }, + "is_function_pointer": false, + "aliased_type": null, + "aliased_identifier": null, + "is_pointer": false, + "new_identifier": null + }, + { + "signature": "typedef struct sk_server_data *server_socket;", + "name": "server_socket", + "description": "A server represents a network resource that clients can connect to. The\nserver will receive messages from all of the client connections, and can\nbe used to access the clients connected to the server.", + "brief": null, + "attributes": { + "class": "server_socket", + "group": "networking", + "static": "networking" + }, + "is_function_pointer": false, + "aliased_type": null, + "aliased_identifier": null, + "is_pointer": false, + "new_identifier": null + }, + { + "signature": "typedef struct sk_http_response *http_response;", + "name": "http_response", + "description": "A HTTP response is a resource that comes back from a HTTP request. This\nmay be the text related to a web page, or the data related to a resource.\nOnce you have used the response, you need to make sure to call\n`free_response`.", + "brief": null, + "attributes": { + "class": "http_response", + "group": "networking" + }, + "is_function_pointer": false, + "aliased_type": null, + "aliased_identifier": null, + "is_pointer": false, + "new_identifier": null + }, + { + "signature": "typedef struct sk_http_request *http_request;", + "name": "http_request", + "description": "The request contains the details of the resource the user is requesting.", + "brief": null, + "attributes": { + "class": "http_request", + "no_destructor": true, + "group": "networking", + "static": "web_server" + }, + "is_function_pointer": false, + "aliased_type": null, + "aliased_identifier": null, + "is_pointer": false, + "new_identifier": null + }, + { + "signature": "typedef struct sk_web_server *web_server;", + "name": "web_server", + "description": "The web server is able to listen for incoming requests, and you can then provide the response.", + "brief": null, + "attributes": { + "class": "web_server", + "group": "networking", + "static": "web_server" + }, + "is_function_pointer": false, + "aliased_type": null, + "aliased_identifier": null, + "is_pointer": false, + "new_identifier": null + } + ], + "structs": [ + + ], + "enums": [ + { + "signature": "enum connection_type {TCP,UDP,UNKNOWN};", + "name": "connection_type", + "description": "The kind of protocol used for a server of connection.", + "brief": null, + "constants": { + "TCP": { + "description": "Uses the TCP protocol. SplashKit can send messages of any\nsize, and repackage it from you at the other end. Messages\nare reliably transferred." + }, + "UDP": { + "description": "Uses the UDP protocol. SplashKit will send messages of up\nto 1024 bytes (by default). You need to handle packaging\nanything larger than this." + }, + "UNKNOWN": { + "description": "The protocol is unknown, usually due to the connection\nor server being invalid or closed." + } + }, + "attributes": { + "group": "networking", + "static": "networking" + }, + "signatures": { + "cpp": "class connection_type {TCP = 0, UDP = 0, UNKNOWN = 0};", + "python": "public enum {ConnectionType.tcp = 0, ConnectionType.udp = 0, ConnectionType.unknown = 0}", + "csharp": "public enum {ConnectionType.TCP = 0, ConnectionType.UDP = 0, ConnectionType.Unknown = 0}", + "pascal": "public enum {ConnectionType.TCP = 0, ConnectionType.UDP = 0, ConnectionType.Unknown = 0}" + } }, { - "signature": "bool bitmap_quad_collision(bitmap bmp,int cell,const matrix_2d &translation,const quad &q);", - "name": "bitmap_quad_collision", - "method_name": "quad_collision", - "unique_global_name": "bitmap_quad_collision_for_cell_with_translation", - "unique_method_name": "bitmap.quad_collision_for_cell_with_translation", + "signature": "enum http_method {HTTP_GET_METHOD,HTTP_POST_METHOD,HTTP_PUT_METHOD,HTTP_DELETE_METHOD,HTTP_OPTIONS_METHOD,HTTP_TRACE_METHOD,UNKNOWN_HTTP_METHOD};", + "name": "http_method", + "description": "The method token is used to indicate the kind of action to be performed\non the server. See [W3 specifications](https://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html).", + "brief": null, + "constants": { + "HTTP_GET_METHOD": { + "description": "A get method" + }, + "HTTP_POST_METHOD": { + "description": "A post method" + }, + "HTTP_PUT_METHOD": { + "description": "A put method" + }, + "HTTP_DELETE_METHOD": { + "description": "A delete method" + }, + "HTTP_OPTIONS_METHOD": { + "description": "An options method" + }, + "HTTP_TRACE_METHOD": { + "description": "A trace method" + }, + "UNKNOWN_HTTP_METHOD": { + "description": "A method not recognised by SplashKit" + } + }, + "attributes": { + "group": "networking", + "static": "web_server" + }, + "signatures": { + "cpp": "class http_method {HTTP_GET_METHOD = 0, HTTP_POST_METHOD = 0, HTTP_PUT_METHOD = 0, HTTP_DELETE_METHOD = 0, HTTP_OPTIONS_METHOD = 0, HTTP_TRACE_METHOD = 0, UNKNOWN_HTTP_METHOD = 0};", + "python": "public enum {HttpMethod.http_get_method = 0, HttpMethod.http_post_method = 0, HttpMethod.http_put_method = 0, HttpMethod.http_delete_method = 0, HttpMethod.http_options_method = 0, HttpMethod.http_trace_method = 0, HttpMethod.unknown_http_method = 0}", + "csharp": "public enum {HttpMethod.HttpGetMethod = 0, HttpMethod.HttpPostMethod = 0, HttpMethod.HttpPutMethod = 0, HttpMethod.HttpDeleteMethod = 0, HttpMethod.HttpOptionsMethod = 0, HttpMethod.HttpTraceMethod = 0, HttpMethod.UnknownHttpMethod = 0}", + "pascal": "public enum {HttpMethod.HttpGetMethod = 0, HttpMethod.HttpPostMethod = 0, HttpMethod.HttpPutMethod = 0, HttpMethod.HttpDeleteMethod = 0, HttpMethod.HttpOptionsMethod = 0, HttpMethod.HttpTraceMethod = 0, HttpMethod.UnknownHttpMethod = 0}" + } + } + ], + "defines": [ + + ] + }, + "physics": { + "brief": "SplashKit Collisions library allow you to perform tests between\nbitmaps, sprites and shapes to determin if a collision has occured.Provides matrix functions to work on 2d coordinates.Provides vector functions to work on vectors.", + "description": "", + "functions": [ + { + "signature": "bool bitmap_circle_collision(bitmap bmp,const point_2d &pt,const circle &circ);", + "name": "bitmap_circle_collision", + "method_name": "circle_collision", + "unique_global_name": "bitmap_circle_collision_at_point", + "unique_method_name": "bitmap.circle_collision_at_point", "suffix_name": null, - "description": "Tests if a bitmap cell drawn using a passed in translation, will\nintersect with a quad. You can use this to detect collisions between\nbitmaps and quads.", + "description": "Tests if a bitmap drawn at `pt` would intersect with a circle.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `q` when drawn.", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `circ` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -65141,22 +61995,9 @@ "is_vector": false, "type_parameter": null }, - "cell": { - "type": "int", - "description": "The cell of the bitmap to check", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "translation": { - "type": "matrix_2d", - "description": "The matrix used to transfrom the bitmap when drawing", + "pt": { + "type": "point_2d", + "description": "The location where the bitmap is drawn", "is_pointer": false, "is_const": true, "is_reference": true, @@ -65167,9 +62008,9 @@ "is_vector": false, "type_parameter": null }, - "q": { - "type": "quad", - "description": "The quad to test", + "circ": { + "type": "circle", + "description": "The circle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -65183,40 +62024,40 @@ }, "attributes": { "class": "bitmap", - "method": "quad_collision", - "suffix": "for_cell_with_translation", + "method": "circle_collision", + "suffix": "at_point", "group": "physics", "static": "collisions", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_quad_collision_for_cell_with_translation(bmp, cell, translation, q):" - ], "cpp": [ - "bool bitmap_quad_collision(bitmap bmp, int cell, const matrix_2d &translation, const quad &q)" + "bool bitmap_circle_collision(bitmap bmp, const point_2d &pt, const circle &circ)" + ], + "python": [ + "def bitmap_circle_collision_at_point(bmp, pt, circ):" ], "csharp": [ - "public bool Bitmap.QuadCollision(int cell, Matrix2D translation, Quad q);", - "public static bool SplashKit.BitmapQuadCollision(Bitmap bmp, int cell, Matrix2D translation, Quad q);" + "public bool Bitmap.CircleCollision(Point2D pt, Circle circ);", + "public static bool SplashKit.BitmapCircleCollision(Bitmap bmp, Point2D pt, Circle circ);" ], "pascal": [ - "function BitmapQuadCollision(bmp: Bitmap; cell: Integer; const translation: Matrix2D; const q: Quad): Boolean" + "function BitmapCircleCollision(bmp: Bitmap; const pt: Point2D; const circ: Circle): Boolean" ] } }, { - "signature": "bool bitmap_quad_collision(bitmap bmp,int cell,const point_2d &pt,const quad &q);", - "name": "bitmap_quad_collision", - "method_name": "quad_collision", - "unique_global_name": "bitmap_quad_collision_for_cell_at_point", - "unique_method_name": "bitmap.quad_collision_for_cell_at_point", + "signature": "bool bitmap_circle_collision(bitmap bmp,double x,double y,const circle &circ);", + "name": "bitmap_circle_collision", + "method_name": "circle_collision", + "unique_global_name": "bitmap_circle_collision", + "unique_method_name": "bitmap.circle_collision", "suffix_name": null, - "description": "Tests if a bitmap cell drawn at `pt` would intersect with a quad.", + "description": "Tests if a bitmap drawn at `x`, `y` would intersect with a circle.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `q` when drawn.", + "description": "True if a drawn pixel in the bitmap will\nintersect with `circ` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -65236,9 +62077,9 @@ "is_vector": false, "type_parameter": null }, - "cell": { - "type": "int", - "description": "The cell of the bitmap to check", + "x": { + "type": "double", + "description": "The x location where the bitmap is drawn", "is_pointer": false, "is_const": false, "is_reference": false, @@ -65249,12 +62090,12 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The location where the bitmap is drawn", + "y": { + "type": "double", + "description": "The y location where the bitmap is drawn", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -65262,9 +62103,9 @@ "is_vector": false, "type_parameter": null }, - "q": { - "type": "quad", - "description": "The quad to test", + "circ": { + "type": "circle", + "description": "The circle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -65278,40 +62119,39 @@ }, "attributes": { "class": "bitmap", - "method": "quad_collision", - "suffix": "for_cell_at_point", + "method": "circle_collision", "group": "physics", "static": "collisions", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_quad_collision_for_cell_at_point(bmp, cell, pt, q):" - ], "cpp": [ - "bool bitmap_quad_collision(bitmap bmp, int cell, const point_2d &pt, const quad &q)" + "bool bitmap_circle_collision(bitmap bmp, double x, double y, const circle &circ)" + ], + "python": [ + "def bitmap_circle_collision(bmp, x, y, circ):" ], "csharp": [ - "public bool Bitmap.QuadCollision(int cell, Point2D pt, Quad q);", - "public static bool SplashKit.BitmapQuadCollision(Bitmap bmp, int cell, Point2D pt, Quad q);" + "public bool Bitmap.CircleCollision(double x, double y, Circle circ);", + "public static bool SplashKit.BitmapCircleCollision(Bitmap bmp, double x, double y, Circle circ);" ], "pascal": [ - "function BitmapQuadCollision(bmp: Bitmap; cell: Integer; const pt: Point2D; const q: Quad): Boolean" + "function BitmapCircleCollision(bmp: Bitmap; x: Double; y: Double; const circ: Circle): Boolean" ] } }, { - "signature": "bool bitmap_quad_collision(bitmap bmp,int cell,double x,double y,const quad &q);", - "name": "bitmap_quad_collision", - "method_name": "quad_collision", - "unique_global_name": "bitmap_quad_collision_for_cell", - "unique_method_name": "bitmap.quad_collision_for_cell", + "signature": "bool bitmap_circle_collision(bitmap bmp,int cell,const matrix_2d &translation,const circle &circ);", + "name": "bitmap_circle_collision", + "method_name": "circle_collision", + "unique_global_name": "bitmap_circle_collision_for_cell_with_translation", + "unique_method_name": "bitmap.circle_collision_for_cell_with_translation", "suffix_name": null, - "description": "Tests if a bitmap cell drawn at `x`, `y` would intersect with a quad.", + "description": "Tests if a bitmap cell drawn using a passed in translation, will\nintersect with a circle. You can use this to detect collisions between\nbitmaps and circles.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the bitmap will\nintersect with `q` when drawn.", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `circ` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -65344,25 +62184,12 @@ "is_vector": false, "type_parameter": null }, - "x": { - "type": "double", - "description": "The x location where the bitmap is drawn", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "y": { - "type": "double", - "description": "The y location where the bitmap is drawn", + "translation": { + "type": "matrix_2d", + "description": "The matrix used to transfrom the bitmap when drawing", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -65370,9 +62197,9 @@ "is_vector": false, "type_parameter": null }, - "q": { - "type": "quad", - "description": "The quad to test", + "circ": { + "type": "circle", + "description": "The circle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -65386,40 +62213,40 @@ }, "attributes": { "class": "bitmap", - "method": "quad_collision", - "suffix": "for_cell", + "method": "circle_collision", + "suffix": "for_cell_with_translation", "group": "physics", "static": "collisions", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_quad_collision_for_cell(bmp, cell, x, y, q):" - ], "cpp": [ - "bool bitmap_quad_collision(bitmap bmp, int cell, double x, double y, const quad &q)" + "bool bitmap_circle_collision(bitmap bmp, int cell, const matrix_2d &translation, const circle &circ)" + ], + "python": [ + "def bitmap_circle_collision_for_cell_with_translation(bmp, cell, translation, circ):" ], "csharp": [ - "public bool Bitmap.QuadCollision(int cell, double x, double y, Quad q);", - "public static bool SplashKit.BitmapQuadCollision(Bitmap bmp, int cell, double x, double y, Quad q);" + "public bool Bitmap.CircleCollision(int cell, Matrix2D translation, Circle circ);", + "public static bool SplashKit.BitmapCircleCollision(Bitmap bmp, int cell, Matrix2D translation, Circle circ);" ], "pascal": [ - "function BitmapQuadCollision(bmp: Bitmap; cell: Integer; x: Double; y: Double; const q: Quad): Boolean" + "function BitmapCircleCollision(bmp: Bitmap; cell: Integer; const translation: Matrix2D; const circ: Circle): Boolean" ] } }, { - "signature": "bool bitmap_ray_collision(bitmap bmp,const point_2d &pt,const point_2d &origin,const vector_2d &heading);", - "name": "bitmap_ray_collision", - "method_name": "ray_collision", - "unique_global_name": "bitmap_ray_collision_at_point", - "unique_method_name": "bitmap.ray_collision_at_point", + "signature": "bool bitmap_circle_collision(bitmap bmp,int cell,const point_2d &pt,const circle &circ);", + "name": "bitmap_circle_collision", + "method_name": "circle_collision", + "unique_global_name": "bitmap_circle_collision_for_cell_at_point", + "unique_method_name": "bitmap.circle_collision_for_cell_at_point", "suffix_name": null, - "description": "Tests if a bitmap drawn at `pt` would intersect with a ray.", + "description": "Tests if a bitmap cell drawn at `pt` would intersect with a circle.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with the ray when drawn.", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `circ` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -65439,12 +62266,12 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The location where the bitmap is drawn", + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -65452,9 +62279,9 @@ "is_vector": false, "type_parameter": null }, - "origin": { + "pt": { "type": "point_2d", - "description": "The origin of the ray", + "description": "The location where the bitmap is drawn", "is_pointer": false, "is_const": true, "is_reference": true, @@ -65465,9 +62292,9 @@ "is_vector": false, "type_parameter": null }, - "heading": { - "type": "vector_2d", - "description": "The heading of the ray", + "circ": { + "type": "circle", + "description": "The circle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -65481,40 +62308,40 @@ }, "attributes": { "class": "bitmap", - "method": "ray_collision", - "suffix": "at_point", + "method": "circle_collision", + "suffix": "for_cell_at_point", "group": "physics", "static": "collisions", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_ray_collision_at_point(bmp, pt, origin, heading):" - ], "cpp": [ - "bool bitmap_ray_collision(bitmap bmp, const point_2d &pt, const point_2d &origin, const vector_2d &heading)" + "bool bitmap_circle_collision(bitmap bmp, int cell, const point_2d &pt, const circle &circ)" + ], + "python": [ + "def bitmap_circle_collision_for_cell_at_point(bmp, cell, pt, circ):" ], "csharp": [ - "public bool Bitmap.RayCollision(Point2D pt, Point2D origin, Vector2D heading);", - "public static bool SplashKit.BitmapRayCollision(Bitmap bmp, Point2D pt, Point2D origin, Vector2D heading);" + "public bool Bitmap.CircleCollision(int cell, Point2D pt, Circle circ);", + "public static bool SplashKit.BitmapCircleCollision(Bitmap bmp, int cell, Point2D pt, Circle circ);" ], "pascal": [ - "function BitmapRayCollision(bmp: Bitmap; const pt: Point2D; const origin: Point2D; const heading: Vector2D): Boolean" + "function BitmapCircleCollision(bmp: Bitmap; cell: Integer; const pt: Point2D; const circ: Circle): Boolean" ] } }, { - "signature": "bool bitmap_ray_collision(bitmap bmp,double x,double y,const point_2d &origin,const vector_2d &heading);", - "name": "bitmap_ray_collision", - "method_name": "ray_collision", - "unique_global_name": "bitmap_ray_collision", - "unique_method_name": "bitmap.ray_collision", + "signature": "bool bitmap_circle_collision(bitmap bmp,int cell,double x,double y,const circle &circ);", + "name": "bitmap_circle_collision", + "method_name": "circle_collision", + "unique_global_name": "bitmap_circle_collision_for_cell", + "unique_method_name": "bitmap.circle_collision_for_cell", "suffix_name": null, - "description": "Tests if a bitmap drawn at `x`, `y` would intersect with a ray.", + "description": "Tests if a bitmap cell drawn at `x`, `y` would intersect with a circle.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the bitmap will\nintersect with the ray when drawn.", + "description": "True if a drawn pixel in the bitmap will\nintersect with `circ` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -65534,9 +62361,9 @@ "is_vector": false, "type_parameter": null }, - "x": { - "type": "double", - "description": "The x location where the bitmap is drawn", + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", "is_pointer": false, "is_const": false, "is_reference": false, @@ -65547,9 +62374,9 @@ "is_vector": false, "type_parameter": null }, - "y": { + "x": { "type": "double", - "description": "The y location where the bitmap is drawn", + "description": "The x location where the bitmap is drawn", "is_pointer": false, "is_const": false, "is_reference": false, @@ -65560,12 +62387,12 @@ "is_vector": false, "type_parameter": null }, - "origin": { - "type": "point_2d", - "description": "The origin of the ray", + "y": { + "type": "double", + "description": "The y location where the bitmap is drawn", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -65573,9 +62400,9 @@ "is_vector": false, "type_parameter": null }, - "heading": { - "type": "vector_2d", - "description": "The heading of the ray", + "circ": { + "type": "circle", + "description": "The circle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -65589,48 +62416,49 @@ }, "attributes": { "class": "bitmap", - "method": "ray_collision", + "method": "circle_collision", + "suffix": "for_cell", "group": "physics", "static": "collisions", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_ray_collision(bmp, x, y, origin, heading):" - ], "cpp": [ - "bool bitmap_ray_collision(bitmap bmp, double x, double y, const point_2d &origin, const vector_2d &heading)" + "bool bitmap_circle_collision(bitmap bmp, int cell, double x, double y, const circle &circ)" + ], + "python": [ + "def bitmap_circle_collision_for_cell(bmp, cell, x, y, circ):" ], "csharp": [ - "public bool Bitmap.RayCollision(double x, double y, Point2D origin, Vector2D heading);", - "public static bool SplashKit.BitmapRayCollision(Bitmap bmp, double x, double y, Point2D origin, Vector2D heading);" + "public bool Bitmap.CircleCollision(int cell, double x, double y, Circle circ);", + "public static bool SplashKit.BitmapCircleCollision(Bitmap bmp, int cell, double x, double y, Circle circ);" ], "pascal": [ - "function BitmapRayCollision(bmp: Bitmap; x: Double; y: Double; const origin: Point2D; const heading: Vector2D): Boolean" + "function BitmapCircleCollision(bmp: Bitmap; cell: Integer; x: Double; y: Double; const circ: Circle): Boolean" ] } }, { - "signature": "bool bitmap_ray_collision(bitmap bmp,int cell,const matrix_2d &translation,const point_2d &origin,const vector_2d &heading);", - "name": "bitmap_ray_collision", - "method_name": "ray_collision", - "unique_global_name": "bitmap_ray_collision_for_cell_with_translation", - "unique_method_name": "bitmap.ray_collision_for_cell_with_translation", + "signature": "bool bitmap_collision(bitmap bmp1,double x1,double y1,bitmap bmp2,double x2,double y2);", + "name": "bitmap_collision", + "method_name": "bitmap_collision", + "unique_global_name": "bitmap_collision", + "unique_method_name": "bitmap.bitmap_collision", "suffix_name": null, - "description": "Tests if a bitmap cell drawn using a passed in translation, will\nintersect with a ray. You can use this to detect collisions between\nbitmaps and rays.", + "description": "Check if two bitmaps collide.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with the ray when drawn.", + "description": "True if pixels in the two bitmaps would collide/overlap", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { + "bmp1": { "type": "bitmap", - "description": "The bitmap to test", + "description": "The first bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -65641,9 +62469,9 @@ "is_vector": false, "type_parameter": null }, - "cell": { - "type": "int", - "description": "The cell of the bitmap to check", + "x1": { + "type": "double", + "description": "The x location where the first bitmap is drawn", "is_pointer": false, "is_const": false, "is_reference": false, @@ -65654,12 +62482,12 @@ "is_vector": false, "type_parameter": null }, - "translation": { - "type": "matrix_2d", - "description": "The matrix used to transfrom the bitmap when drawing", + "y1": { + "type": "double", + "description": "The y location where the first bitmap is drawn", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -65667,12 +62495,12 @@ "is_vector": false, "type_parameter": null }, - "origin": { - "type": "point_2d", - "description": "The origin of the ray", + "bmp2": { + "type": "bitmap", + "description": "The second bitmap", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -65680,12 +62508,25 @@ "is_vector": false, "type_parameter": null }, - "heading": { - "type": "vector_2d", - "description": "The heading of the ray", + "x2": { + "type": "double", + "description": "The x location where the second bitmap is drawn", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y2": { + "type": "double", + "description": "The y location where the second bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -65696,62 +62537,48 @@ }, "attributes": { "class": "bitmap", - "method": "ray_collision", - "suffix": "for_cell_with_translation", + "method": "bitmap_collision", "group": "physics", "static": "collisions", - "self": "bmp" + "self": "bmp1" }, "signatures": { - "python": [ - "def bitmap_ray_collision_for_cell_with_translation(bmp, cell, translation, origin, heading):" - ], "cpp": [ - "bool bitmap_ray_collision(bitmap bmp, int cell, const matrix_2d &translation, const point_2d &origin, const vector_2d &heading)" + "bool bitmap_collision(bitmap bmp1, double x1, double y1, bitmap bmp2, double x2, double y2)" + ], + "python": [ + "def bitmap_collision(bmp1, x1, y1, bmp2, x2, y2):" ], "csharp": [ - "public bool Bitmap.RayCollision(int cell, Matrix2D translation, Point2D origin, Vector2D heading);", - "public static bool SplashKit.BitmapRayCollision(Bitmap bmp, int cell, Matrix2D translation, Point2D origin, Vector2D heading);" + "public bool Bitmap.BitmapCollision(double x1, double y1, Bitmap bmp2, double x2, double y2);", + "public static bool SplashKit.BitmapCollision(Bitmap bmp1, double x1, double y1, Bitmap bmp2, double x2, double y2);" ], "pascal": [ - "function BitmapRayCollision(bmp: Bitmap; cell: Integer; const translation: Matrix2D; const origin: Point2D; const heading: Vector2D): Boolean" + "function BitmapCollision(bmp1: Bitmap; x1: Double; y1: Double; bmp2: Bitmap; x2: Double; y2: Double): Boolean" ] } }, { - "signature": "bool bitmap_ray_collision(bitmap bmp,int cell,const point_2d &pt,const point_2d &origin,const vector_2d &heading);", - "name": "bitmap_ray_collision", - "method_name": "ray_collision", - "unique_global_name": "bitmap_ray_collision_for_cell_at_point", - "unique_method_name": "bitmap.ray_collision_for_cell_at_point", + "signature": "bool bitmap_collision(bitmap bmp1,const point_2d &pt1,bitmap bmp2,const point_2d &pt2);", + "name": "bitmap_collision", + "method_name": "bitmap_collision", + "unique_global_name": "bitmap_collision_at_points", + "unique_method_name": "bitmap.bitmap_collision_at_points", "suffix_name": null, - "description": "Tests if a bitmap cell drawn at `pt` would intersect with a ray.", + "description": "Check if two bitmaps collide.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with the ray when drawn.", + "description": "True if pixels in the two bitmaps would collide/overlap", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { + "bmp1": { "type": "bitmap", - "description": "The bitmap to test", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "cell": { - "type": "int", - "description": "The cell of the bitmap to check", + "description": "The first bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -65762,9 +62589,9 @@ "is_vector": false, "type_parameter": null }, - "pt": { + "pt1": { "type": "point_2d", - "description": "The location where the bitmap is drawn", + "description": "The point where bitmap 1 is drawn", "is_pointer": false, "is_const": true, "is_reference": true, @@ -65775,12 +62602,12 @@ "is_vector": false, "type_parameter": null }, - "origin": { - "type": "point_2d", - "description": "The origin of the ray", + "bmp2": { + "type": "bitmap", + "description": "The second bitmap", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -65788,9 +62615,9 @@ "is_vector": false, "type_parameter": null }, - "heading": { - "type": "vector_2d", - "description": "The heading of the ray", + "pt2": { + "type": "point_2d", + "description": "The point where bitmap 2 is drawn", "is_pointer": false, "is_const": true, "is_reference": true, @@ -65804,49 +62631,49 @@ }, "attributes": { "class": "bitmap", - "method": "ray_collision", - "suffix": "for_cell_at_point", + "method": "bitmap_collision", + "suffix": "at_points", "group": "physics", "static": "collisions", - "self": "bmp" + "self": "bmp1" }, "signatures": { - "python": [ - "def bitmap_ray_collision_for_cell_at_point(bmp, cell, pt, origin, heading):" - ], "cpp": [ - "bool bitmap_ray_collision(bitmap bmp, int cell, const point_2d &pt, const point_2d &origin, const vector_2d &heading)" + "bool bitmap_collision(bitmap bmp1, const point_2d &pt1, bitmap bmp2, const point_2d &pt2)" + ], + "python": [ + "def bitmap_collision_at_points(bmp1, pt1, bmp2, pt2):" ], "csharp": [ - "public bool Bitmap.RayCollision(int cell, Point2D pt, Point2D origin, Vector2D heading);", - "public static bool SplashKit.BitmapRayCollision(Bitmap bmp, int cell, Point2D pt, Point2D origin, Vector2D heading);" + "public bool Bitmap.BitmapCollision(Point2D pt1, Bitmap bmp2, Point2D pt2);", + "public static bool SplashKit.BitmapCollision(Bitmap bmp1, Point2D pt1, Bitmap bmp2, Point2D pt2);" ], "pascal": [ - "function BitmapRayCollision(bmp: Bitmap; cell: Integer; const pt: Point2D; const origin: Point2D; const heading: Vector2D): Boolean" + "function BitmapCollision(bmp1: Bitmap; const pt1: Point2D; bmp2: Bitmap; const pt2: Point2D): Boolean" ] } }, { - "signature": "bool bitmap_ray_collision(bitmap bmp,int cell,double x,double y,const point_2d &origin,const vector_2d &heading);", - "name": "bitmap_ray_collision", - "method_name": "ray_collision", - "unique_global_name": "bitmap_ray_collision_for_cell", - "unique_method_name": "bitmap.ray_collision_for_cell", + "signature": "bool bitmap_collision(bitmap bmp1,int cell1,const matrix_2d &matrix1,bitmap bmp2,int cell2,const matrix_2d &matrix2);", + "name": "bitmap_collision", + "method_name": "bitmap_collision", + "unique_global_name": "bitmap_collision_for_cells_with_translations", + "unique_method_name": "bitmap.bitmap_collision_for_cells_with_translations", "suffix_name": null, - "description": "Tests if a bitmap cell drawn at `x`, `y` would intersect with a ray.", + "description": "Check if two bitmaps collide, based on their cell and transform\nmatricies.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with the ray when drawn.", + "description": "True if pixels in the two bitmaps would collide/overlap", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { + "bmp1": { "type": "bitmap", - "description": "The bitmap to test", + "description": "The first bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -65857,9 +62684,9 @@ "is_vector": false, "type_parameter": null }, - "cell": { + "cell1": { "type": "int", - "description": "The cell of the bitmap to check", + "description": "The cell of the first bitmap.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -65870,12 +62697,12 @@ "is_vector": false, "type_parameter": null }, - "x": { - "type": "double", - "description": "The x location where the bitmap is drawn", + "matrix1": { + "type": "matrix_2d", + "description": "The transformation for the first matrix", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -65883,9 +62710,9 @@ "is_vector": false, "type_parameter": null }, - "y": { - "type": "double", - "description": "The y location where the bitmap is drawn", + "bmp2": { + "type": "bitmap", + "description": "The second bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -65896,12 +62723,12 @@ "is_vector": false, "type_parameter": null }, - "origin": { - "type": "point_2d", - "description": "The origin of the ray", + "cell2": { + "type": "int", + "description": "The cell of the second bitmap.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -65909,9 +62736,9 @@ "is_vector": false, "type_parameter": null }, - "heading": { - "type": "vector_2d", - "description": "The heading of the ray", + "matrix2": { + "type": "matrix_2d", + "description": "The transformation for the second matrix", "is_pointer": false, "is_const": true, "is_reference": true, @@ -65925,49 +62752,49 @@ }, "attributes": { "class": "bitmap", - "method": "ray_collision", - "suffix": "for_cell", + "method": "bitmap_collision", + "suffix": "for_cells_with_translations", "group": "physics", "static": "collisions", - "self": "bmp" + "self": "bmp1" }, "signatures": { - "python": [ - "def bitmap_ray_collision_for_cell(bmp, cell, x, y, origin, heading):" - ], "cpp": [ - "bool bitmap_ray_collision(bitmap bmp, int cell, double x, double y, const point_2d &origin, const vector_2d &heading)" + "bool bitmap_collision(bitmap bmp1, int cell1, const matrix_2d &matrix1, bitmap bmp2, int cell2, const matrix_2d &matrix2)" + ], + "python": [ + "def bitmap_collision_for_cells_with_translations(bmp1, cell1, matrix1, bmp2, cell2, matrix2):" ], "csharp": [ - "public bool Bitmap.RayCollision(int cell, double x, double y, Point2D origin, Vector2D heading);", - "public static bool SplashKit.BitmapRayCollision(Bitmap bmp, int cell, double x, double y, Point2D origin, Vector2D heading);" + "public bool Bitmap.BitmapCollision(int cell1, Matrix2D matrix1, Bitmap bmp2, int cell2, Matrix2D matrix2);", + "public static bool SplashKit.BitmapCollision(Bitmap bmp1, int cell1, Matrix2D matrix1, Bitmap bmp2, int cell2, Matrix2D matrix2);" ], "pascal": [ - "function BitmapRayCollision(bmp: Bitmap; cell: Integer; x: Double; y: Double; const origin: Point2D; const heading: Vector2D): Boolean" + "function BitmapCollision(bmp1: Bitmap; cell1: Integer; const matrix1: Matrix2D; bmp2: Bitmap; cell2: Integer; const matrix2: Matrix2D): Boolean" ] } }, { - "signature": "bool bitmap_rectangle_collision(bitmap bmp,const point_2d &pt,const rectangle &rect);", - "name": "bitmap_rectangle_collision", - "method_name": "rectangle_collision", - "unique_global_name": "bitmap_rectangle_collision_at_point", - "unique_method_name": "bitmap.rectangle_collision_at_point", + "signature": "bool bitmap_collision(bitmap bmp1,int cell1,const point_2d &pt1,bitmap bmp2,int cell2,const point_2d &pt2);", + "name": "bitmap_collision", + "method_name": "bitmap_collision", + "unique_global_name": "bitmap_collision_for_cells_at_points", + "unique_method_name": "bitmap.bitmap_collision_for_cells_at_points", "suffix_name": null, - "description": "Tests if a bitmap drawn at `pt` would intersect with a rectangle.", + "description": "Check if two bitmaps collide.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `rect` when drawn.", + "description": "True if pixels in the two bitmaps would collide/overlap", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { + "bmp1": { "type": "bitmap", - "description": "The bitmap to test", + "description": "The first bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -65978,12 +62805,12 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The location where the bitmap is drawn", + "cell1": { + "type": "int", + "description": "The cell of the first bitmap.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -65991,9 +62818,9 @@ "is_vector": false, "type_parameter": null }, - "rect": { - "type": "rectangle", - "description": "The rectangle to test", + "pt1": { + "type": "point_2d", + "description": "The point where bitmap 1 is drawn", "is_pointer": false, "is_const": true, "is_reference": true, @@ -66003,66 +62830,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "bitmap", - "method": "rectangle_collision", - "suffix": "at_point", - "group": "physics", - "static": "collisions", - "self": "bmp" - }, - "signatures": { - "python": [ - "def bitmap_rectangle_collision_at_point(bmp, pt, rect):" - ], - "cpp": [ - "bool bitmap_rectangle_collision(bitmap bmp, const point_2d &pt, const rectangle &rect)" - ], - "csharp": [ - "public bool Bitmap.RectangleCollision(Point2D pt, Rectangle rect);", - "public static bool SplashKit.BitmapRectangleCollision(Bitmap bmp, Point2D pt, Rectangle rect);" - ], - "pascal": [ - "function BitmapRectangleCollision(bmp: Bitmap; const pt: Point2D; const rect: Rectangle): Boolean" - ] - } - }, - { - "signature": "bool bitmap_rectangle_collision(bitmap bmp,double x,double y,const rectangle &rect);", - "name": "bitmap_rectangle_collision", - "method_name": "rectangle_collision", - "unique_global_name": "bitmap_rectangle_collision", - "unique_method_name": "bitmap.rectangle_collision", - "suffix_name": null, - "description": "Tests if a bitmap drawn at `x`, `y` would intersect with a rectangle.", - "brief": null, - "return": { - "type": "bool", - "description": "True if a drawn pixel in the bitmap will\nintersect with `rect` when drawn.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "bmp": { - "type": "bitmap", - "description": "The bitmap to test", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The x location where the bitmap is drawn", + }, + "bmp2": { + "type": "bitmap", + "description": "The second bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -66073,9 +62844,9 @@ "is_vector": false, "type_parameter": null }, - "y": { - "type": "double", - "description": "The y location where the bitmap is drawn", + "cell2": { + "type": "int", + "description": "The cell of the second bitmap.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -66086,9 +62857,9 @@ "is_vector": false, "type_parameter": null }, - "rect": { - "type": "rectangle", - "description": "The rectangle to test", + "pt2": { + "type": "point_2d", + "description": "The point where bitmap 2 is drawn", "is_pointer": false, "is_const": true, "is_reference": true, @@ -66102,48 +62873,49 @@ }, "attributes": { "class": "bitmap", - "method": "rectangle_collision", + "method": "bitmap_collision", + "suffix": "for_cells_at_points", "group": "physics", "static": "collisions", - "self": "bmp" + "self": "bmp1" }, "signatures": { - "python": [ - "def bitmap_rectangle_collision(bmp, x, y, rect):" - ], "cpp": [ - "bool bitmap_rectangle_collision(bitmap bmp, double x, double y, const rectangle &rect)" + "bool bitmap_collision(bitmap bmp1, int cell1, const point_2d &pt1, bitmap bmp2, int cell2, const point_2d &pt2)" + ], + "python": [ + "def bitmap_collision_for_cells_at_points(bmp1, cell1, pt1, bmp2, cell2, pt2):" ], "csharp": [ - "public bool Bitmap.RectangleCollision(double x, double y, Rectangle rect);", - "public static bool SplashKit.BitmapRectangleCollision(Bitmap bmp, double x, double y, Rectangle rect);" + "public bool Bitmap.BitmapCollision(int cell1, Point2D pt1, Bitmap bmp2, int cell2, Point2D pt2);", + "public static bool SplashKit.BitmapCollision(Bitmap bmp1, int cell1, Point2D pt1, Bitmap bmp2, int cell2, Point2D pt2);" ], "pascal": [ - "function BitmapRectangleCollision(bmp: Bitmap; x: Double; y: Double; const rect: Rectangle): Boolean" + "function BitmapCollision(bmp1: Bitmap; cell1: Integer; const pt1: Point2D; bmp2: Bitmap; cell2: Integer; const pt2: Point2D): Boolean" ] } }, { - "signature": "bool bitmap_rectangle_collision(bitmap bmp,int cell,const matrix_2d &translation,const rectangle &rect);", - "name": "bitmap_rectangle_collision", - "method_name": "rectangle_collision", - "unique_global_name": "bitmap_rectangle_collision_for_cell_with_translation", - "unique_method_name": "bitmap.rectangle_collision_for_cell_with_translation", + "signature": "bool bitmap_collision(bitmap bmp1,int cell1,double x1,double y1,bitmap bmp2,int cell2,double x2,double y2);", + "name": "bitmap_collision", + "method_name": "bitmap_collision", + "unique_global_name": "bitmap_collision_for_cells", + "unique_method_name": "bitmap.bitmap_collision_for_cells", "suffix_name": null, - "description": "Tests if a bitmap cell drawn using a passed in translation, will\nintersect with a rectangle. You can use this to detect collisions between\nbitmaps and rectangles.", + "description": "Check if two bitmaps collide.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `rect` when drawn.", + "description": "True if pixels in the two bitmaps would collide/overlap", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bmp": { + "bmp1": { "type": "bitmap", - "description": "The bitmap to test", + "description": "The first bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -66154,9 +62926,9 @@ "is_vector": false, "type_parameter": null }, - "cell": { + "cell1": { "type": "int", - "description": "The cell of the bitmap to check", + "description": "The cell of the first bitmap.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -66167,12 +62939,12 @@ "is_vector": false, "type_parameter": null }, - "translation": { - "type": "matrix_2d", - "description": "The matrix used to transfrom the bitmap when drawing", + "x1": { + "type": "double", + "description": "The x location where the first bitmap is drawn", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -66180,65 +62952,22 @@ "is_vector": false, "type_parameter": null }, - "rect": { - "type": "rectangle", - "description": "The rectangle to test", + "y1": { + "type": "double", + "description": "The y location where the first bitmap is drawn", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "bitmap", - "method": "rectangle_collision", - "suffix": "for_cell_with_translation", - "group": "physics", - "static": "collisions", - "self": "bmp" - }, - "signatures": { - "python": [ - "def bitmap_rectangle_collision_for_cell_with_translation(bmp, cell, translation, rect):" - ], - "cpp": [ - "bool bitmap_rectangle_collision(bitmap bmp, int cell, const matrix_2d &translation, const rectangle &rect)" - ], - "csharp": [ - "public bool Bitmap.RectangleCollision(int cell, Matrix2D translation, Rectangle rect);", - "public static bool SplashKit.BitmapRectangleCollision(Bitmap bmp, int cell, Matrix2D translation, Rectangle rect);" - ], - "pascal": [ - "function BitmapRectangleCollision(bmp: Bitmap; cell: Integer; const translation: Matrix2D; const rect: Rectangle): Boolean" - ] - } - }, - { - "signature": "bool bitmap_rectangle_collision(bitmap bmp,int cell,const point_2d &pt,const rectangle &rect);", - "name": "bitmap_rectangle_collision", - "method_name": "rectangle_collision", - "unique_global_name": "bitmap_rectangle_collision_for_cell_at_point", - "unique_method_name": "bitmap.rectangle_collision_for_cell_at_point", - "suffix_name": null, - "description": "Tests if a bitmap cell drawn at `pt` would intersect with a rectangle.", - "brief": null, - "return": { - "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `rect` when drawn.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "bmp": { + }, + "bmp2": { "type": "bitmap", - "description": "The bitmap to test", + "description": "The second bitmap", "is_pointer": false, "is_const": false, "is_reference": false, @@ -66249,9 +62978,9 @@ "is_vector": false, "type_parameter": null }, - "cell": { + "cell2": { "type": "int", - "description": "The cell of the bitmap to check", + "description": "The cell of the second bitmap.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -66262,12 +62991,12 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The location where the bitmap is drawn", + "x2": { + "type": "double", + "description": "The x location where the second bitmap is drawn", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -66275,12 +63004,12 @@ "is_vector": false, "type_parameter": null }, - "rect": { - "type": "rectangle", - "description": "The rectangle to test", + "y2": { + "type": "double", + "description": "The y location where the second bitmap is drawn", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -66291,40 +63020,40 @@ }, "attributes": { "class": "bitmap", - "method": "rectangle_collision", - "suffix": "for_cell_at_point", + "method": "bitmap_collision", + "suffix": "for_cells", "group": "physics", "static": "collisions", - "self": "bmp" + "self": "bmp1" }, "signatures": { - "python": [ - "def bitmap_rectangle_collision_for_cell_at_point(bmp, cell, pt, rect):" - ], "cpp": [ - "bool bitmap_rectangle_collision(bitmap bmp, int cell, const point_2d &pt, const rectangle &rect)" + "bool bitmap_collision(bitmap bmp1, int cell1, double x1, double y1, bitmap bmp2, int cell2, double x2, double y2)" + ], + "python": [ + "def bitmap_collision_for_cells(bmp1, cell1, x1, y1, bmp2, cell2, x2, y2):" ], "csharp": [ - "public bool Bitmap.RectangleCollision(int cell, Point2D pt, Rectangle rect);", - "public static bool SplashKit.BitmapRectangleCollision(Bitmap bmp, int cell, Point2D pt, Rectangle rect);" + "public bool Bitmap.BitmapCollision(int cell1, double x1, double y1, Bitmap bmp2, int cell2, double x2, double y2);", + "public static bool SplashKit.BitmapCollision(Bitmap bmp1, int cell1, double x1, double y1, Bitmap bmp2, int cell2, double x2, double y2);" ], "pascal": [ - "function BitmapRectangleCollision(bmp: Bitmap; cell: Integer; const pt: Point2D; const rect: Rectangle): Boolean" + "function BitmapCollision(bmp1: Bitmap; cell1: Integer; x1: Double; y1: Double; bmp2: Bitmap; cell2: Integer; x2: Double; y2: Double): Boolean" ] } }, { - "signature": "bool bitmap_rectangle_collision(bitmap bmp,int cell,double x,double y,const rectangle &rect);", - "name": "bitmap_rectangle_collision", - "method_name": "rectangle_collision", - "unique_global_name": "bitmap_rectangle_collision_for_cell", - "unique_method_name": "bitmap.rectangle_collision_for_cell", + "signature": "bool bitmap_point_collision(bitmap bmp,const matrix_2d &translation,const point_2d &pt);", + "name": "bitmap_point_collision", + "method_name": "point_collision", + "unique_global_name": "bitmap_point_collision_with_translation", + "unique_method_name": "bitmap.point_collision_with_translation", "suffix_name": null, - "description": "Tests if a cell of the bitmap drawn at `x`, `y` would intersect with a rectangle.", + "description": "Tests if a bitmap drawn using the passed in translation matrix would draw a pixel\nat the passed in point. Use to check collisions between a point and a bitmap.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the bitmap will\nintersect with `rect` when drawn.", + "description": "True if drawing the bitmap, using the passed in translation,\nwill draw a pixel at the indicated point.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -66333,33 +63062,7 @@ "parameters": { "bmp": { "type": "bitmap", - "description": "The bitmap to test", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "cell": { - "type": "int", - "description": "The cell of the bitmap to check", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The x location where the bitmap is drawn", + "description": "The bitmap to test.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -66370,12 +63073,12 @@ "is_vector": false, "type_parameter": null }, - "y": { - "type": "double", - "description": "The y location where the bitmap is drawn", + "translation": { + "type": "matrix_2d", + "description": "The translation matrix that represents the position, scale,\nand rotation of the bitmap when it is drawn.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -66383,9 +63086,9 @@ "is_vector": false, "type_parameter": null }, - "rect": { - "type": "rectangle", - "description": "The rectangle to test", + "pt": { + "type": "point_2d", + "description": "The point in the resulting drawing that is being tested.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -66399,40 +63102,40 @@ }, "attributes": { "class": "bitmap", - "method": "rectangle_collision", - "suffix": "for_cell", + "method": "point_collision", + "suffix": "with_translation", "group": "physics", "static": "collisions", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_rectangle_collision_for_cell(bmp, cell, x, y, rect):" - ], "cpp": [ - "bool bitmap_rectangle_collision(bitmap bmp, int cell, double x, double y, const rectangle &rect)" + "bool bitmap_point_collision(bitmap bmp, const matrix_2d &translation, const point_2d &pt)" + ], + "python": [ + "def bitmap_point_collision_with_translation(bmp, translation, pt):" ], "csharp": [ - "public bool Bitmap.RectangleCollision(int cell, double x, double y, Rectangle rect);", - "public static bool SplashKit.BitmapRectangleCollision(Bitmap bmp, int cell, double x, double y, Rectangle rect);" + "public bool Bitmap.PointCollision(Matrix2D translation, Point2D pt);", + "public static bool SplashKit.BitmapPointCollision(Bitmap bmp, Matrix2D translation, Point2D pt);" ], "pascal": [ - "function BitmapRectangleCollision(bmp: Bitmap; cell: Integer; x: Double; y: Double; const rect: Rectangle): Boolean" + "function BitmapPointCollision(bmp: Bitmap; const translation: Matrix2D; const pt: Point2D): Boolean" ] } }, { - "signature": "bool bitmap_triangle_collision(bitmap bmp,const point_2d &pt,const triangle &tri);", - "name": "bitmap_triangle_collision", - "method_name": "triangle_collision", - "unique_global_name": "bitmap_triangle_collision_at_point", - "unique_method_name": "bitmap.triangle_collision_at_point", + "signature": "bool bitmap_point_collision(bitmap bmp,const point_2d &bmp_pt,const point_2d &pt);", + "name": "bitmap_point_collision", + "method_name": "point_collision", + "unique_global_name": "bitmap_point_collision_at_point", + "unique_method_name": "bitmap.point_collision_at_point", "suffix_name": null, - "description": "Tests if a bitmap drawn at `pt` would intersect with a triangle.", + "description": "Tests if a bitmap drawn at the `bmp_pt` point would draw a pixel\nat point `pt`. Use to check collisions between a point and a bitmap.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `tri` when drawn.", + "description": "True if drawing the bitmap, at `bmp_pt`,\nwill draw a pixel at the indicated point (`pt`).", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -66441,7 +63144,7 @@ "parameters": { "bmp": { "type": "bitmap", - "description": "The bitmap to test", + "description": "The bitmap to test.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -66452,9 +63155,9 @@ "is_vector": false, "type_parameter": null }, - "pt": { + "bmp_pt": { "type": "point_2d", - "description": "The location where the bitmap is drawn", + "description": "The point where the bitmap is drawn.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -66465,9 +63168,9 @@ "is_vector": false, "type_parameter": null }, - "tri": { - "type": "triangle", - "description": "The triangle to test", + "pt": { + "type": "point_2d", + "description": "The point in the resulting drawing that is being tested.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -66481,40 +63184,40 @@ }, "attributes": { "class": "bitmap", - "method": "triangle_collision", + "method": "point_collision", "suffix": "at_point", "group": "physics", "static": "collisions", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_triangle_collision_at_point(bmp, pt, tri):" - ], "cpp": [ - "bool bitmap_triangle_collision(bitmap bmp, const point_2d &pt, const triangle &tri)" + "bool bitmap_point_collision(bitmap bmp, const point_2d &bmp_pt, const point_2d &pt)" + ], + "python": [ + "def bitmap_point_collision_at_point(bmp, bmp_pt, pt):" ], "csharp": [ - "public bool Bitmap.TriangleCollision(Point2D pt, Triangle tri);", - "public static bool SplashKit.BitmapTriangleCollision(Bitmap bmp, Point2D pt, Triangle tri);" + "public bool Bitmap.PointCollision(Point2D bmpPt, Point2D pt);", + "public static bool SplashKit.BitmapPointCollision(Bitmap bmp, Point2D bmpPt, Point2D pt);" ], "pascal": [ - "function BitmapTriangleCollision(bmp: Bitmap; const pt: Point2D; const tri: Triangle): Boolean" + "function BitmapPointCollision(bmp: Bitmap; const bmpPt: Point2D; const pt: Point2D): Boolean" ] } }, { - "signature": "bool bitmap_triangle_collision(bitmap bmp,double x,double y,const triangle &tri);", - "name": "bitmap_triangle_collision", - "method_name": "triangle_collision", - "unique_global_name": "bitmap_triangle_collision", - "unique_method_name": "bitmap.triangle_collision", + "signature": "bool bitmap_point_collision(bitmap bmp,double bmp_x,double bmp_y,double x,double y);", + "name": "bitmap_point_collision", + "method_name": "point_collision", + "unique_global_name": "bitmap_point_collision", + "unique_method_name": "bitmap.point_collision", "suffix_name": null, - "description": "Tests if a bitmap drawn at `x`, `y` would intersect with a triangle.", + "description": "Tests if a bitmap drawn at x,y would draw a pixel at the passed in point. Use\nto check collisions between a point and a bitmap.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the bitmap will\nintersect with `tri` when drawn.", + "description": "True if drawing the bitmap, at the indicated location,\nwill draw a pixel at the indicated point.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -66523,7 +63226,7 @@ "parameters": { "bmp": { "type": "bitmap", - "description": "The bitmap to test", + "description": "The bitmap to test.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -66534,7 +63237,7 @@ "is_vector": false, "type_parameter": null }, - "x": { + "bmp_x": { "type": "double", "description": "The x location where the bitmap is drawn", "is_pointer": false, @@ -66547,7 +63250,7 @@ "is_vector": false, "type_parameter": null }, - "y": { + "bmp_y": { "type": "double", "description": "The y location where the bitmap is drawn", "is_pointer": false, @@ -66560,12 +63263,25 @@ "is_vector": false, "type_parameter": null }, - "tri": { - "type": "triangle", - "description": "The triangle to test", + "x": { + "type": "double", + "description": "The x location of the point to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y location of the point to test", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -66576,39 +63292,39 @@ }, "attributes": { "class": "bitmap", - "method": "triangle_collision", + "method": "point_collision", "group": "physics", "static": "collisions", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_triangle_collision(bmp, x, y, tri):" - ], "cpp": [ - "bool bitmap_triangle_collision(bitmap bmp, double x, double y, const triangle &tri)" + "bool bitmap_point_collision(bitmap bmp, double bmp_x, double bmp_y, double x, double y)" + ], + "python": [ + "def bitmap_point_collision(bmp, bmp_x, bmp_y, x, y):" ], "csharp": [ - "public bool Bitmap.TriangleCollision(double x, double y, Triangle tri);", - "public static bool SplashKit.BitmapTriangleCollision(Bitmap bmp, double x, double y, Triangle tri);" + "public bool Bitmap.PointCollision(double bmpX, double bmpY, double x, double y);", + "public static bool SplashKit.BitmapPointCollision(Bitmap bmp, double bmpX, double bmpY, double x, double y);" ], "pascal": [ - "function BitmapTriangleCollision(bmp: Bitmap; x: Double; y: Double; const tri: Triangle): Boolean" + "function BitmapPointCollision(bmp: Bitmap; bmpX: Double; bmpY: Double; x: Double; y: Double): Boolean" ] } }, { - "signature": "bool bitmap_triangle_collision(bitmap bmp,int cell,const matrix_2d &translation,const triangle &tri);", - "name": "bitmap_triangle_collision", - "method_name": "triangle_collision", - "unique_global_name": "bitmap_triangle_collision_for_cell_with_translation", - "unique_method_name": "bitmap.triangle_collision_for_cell_with_translation", + "signature": "bool bitmap_point_collision(bitmap bmp,int cell,const matrix_2d &translation,const point_2d &pt);", + "name": "bitmap_point_collision", + "method_name": "point_collision", + "unique_global_name": "bitmap_point_collision_for_cell_with_translation", + "unique_method_name": "bitmap.point_collision_for_cell_with_translation", "suffix_name": null, - "description": "Tests if a bitmap cell drawn using a passed in translation, will\nintersect with a triangle. You can use this to detect collisions between\nbitmaps and triangles.", + "description": "Tests if a bitmap cell drawn using the passed in translation matrix would draw a pixel\nat the passed in point.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `tri` when drawn.", + "description": "True if drawing the bitmap, using the passed in translation,\nwill draw a pixel at the indicated point.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -66617,7 +63333,7 @@ "parameters": { "bmp": { "type": "bitmap", - "description": "The bitmap to test", + "description": "The bitmap to test.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -66630,7 +63346,7 @@ }, "cell": { "type": "int", - "description": "The cell of the bitmap to check", + "description": "The cell of the bitmap to check.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -66643,7 +63359,7 @@ }, "translation": { "type": "matrix_2d", - "description": "The matrix used to transfrom the bitmap when drawing", + "description": "The translation matrix that represents the position, scale,\nand rotation of the bitmap when it is drawn.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -66654,9 +63370,9 @@ "is_vector": false, "type_parameter": null }, - "tri": { - "type": "triangle", - "description": "The triangle to test", + "pt": { + "type": "point_2d", + "description": "The point in the resulting drawing that is being tested.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -66670,40 +63386,40 @@ }, "attributes": { "class": "bitmap", - "method": "triangle_collision", + "method": "point_collision", "suffix": "for_cell_with_translation", "group": "physics", "static": "collisions", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_triangle_collision_for_cell_with_translation(bmp, cell, translation, tri):" - ], "cpp": [ - "bool bitmap_triangle_collision(bitmap bmp, int cell, const matrix_2d &translation, const triangle &tri)" + "bool bitmap_point_collision(bitmap bmp, int cell, const matrix_2d &translation, const point_2d &pt)" + ], + "python": [ + "def bitmap_point_collision_for_cell_with_translation(bmp, cell, translation, pt):" ], "csharp": [ - "public bool Bitmap.TriangleCollision(int cell, Matrix2D translation, Triangle tri);", - "public static bool SplashKit.BitmapTriangleCollision(Bitmap bmp, int cell, Matrix2D translation, Triangle tri);" + "public bool Bitmap.PointCollision(int cell, Matrix2D translation, Point2D pt);", + "public static bool SplashKit.BitmapPointCollision(Bitmap bmp, int cell, Matrix2D translation, Point2D pt);" ], "pascal": [ - "function BitmapTriangleCollision(bmp: Bitmap; cell: Integer; const translation: Matrix2D; const tri: Triangle): Boolean" + "function BitmapPointCollision(bmp: Bitmap; cell: Integer; const translation: Matrix2D; const pt: Point2D): Boolean" ] } }, { - "signature": "bool bitmap_triangle_collision(bitmap bmp,int cell,const point_2d &pt,const triangle &tri);", - "name": "bitmap_triangle_collision", - "method_name": "triangle_collision", - "unique_global_name": "bitmap_triangle_collision_for_cell_at_point", - "unique_method_name": "bitmap.triangle_collision_for_cell_at_point", + "signature": "bool bitmap_point_collision(bitmap bmp,int cell,const point_2d &bmp_pt,const point_2d &pt);", + "name": "bitmap_point_collision", + "method_name": "point_collision", + "unique_global_name": "bitmap_point_collision_for_cell_at_point", + "unique_method_name": "bitmap.point_collision_for_cell_at_point", "suffix_name": null, - "description": "Tests if a bitmap cell drawn at `pt` would intersect with a triangle.", + "description": "Tests if a cell of a bitmap drawn at x,y would draw a pixel at the passed in point. Use\nto check collisions between a point and a bitmap.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `tri` when drawn.", + "description": "True if drawing the bitmap cell, at the indicated location,\nwill draw a pixel at the indicated point.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -66725,7 +63441,7 @@ }, "cell": { "type": "int", - "description": "The cell of the bitmap to check", + "description": "The cell of the bitmap to test", "is_pointer": false, "is_const": false, "is_reference": false, @@ -66736,9 +63452,9 @@ "is_vector": false, "type_parameter": null }, - "pt": { + "bmp_pt": { "type": "point_2d", - "description": "The location where the bitmap is drawn", + "description": "The point where the bitmap is drawn.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -66749,9 +63465,9 @@ "is_vector": false, "type_parameter": null }, - "tri": { - "type": "triangle", - "description": "The triangle to test", + "pt": { + "type": "point_2d", + "description": "The point in the resulting drawing that is being tested.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -66765,40 +63481,40 @@ }, "attributes": { "class": "bitmap", - "method": "triangle_collision", + "method": "point_collision", "suffix": "for_cell_at_point", "group": "physics", "static": "collisions", "self": "bmp" }, "signatures": { - "python": [ - "def bitmap_triangle_collision_for_cell_at_point(bmp, cell, pt, tri):" - ], "cpp": [ - "bool bitmap_triangle_collision(bitmap bmp, int cell, const point_2d &pt, const triangle &tri)" + "bool bitmap_point_collision(bitmap bmp, int cell, const point_2d &bmp_pt, const point_2d &pt)" + ], + "python": [ + "def bitmap_point_collision_for_cell_at_point(bmp, cell, bmp_pt, pt):" ], "csharp": [ - "public bool Bitmap.TriangleCollision(int cell, Point2D pt, Triangle tri);", - "public static bool SplashKit.BitmapTriangleCollision(Bitmap bmp, int cell, Point2D pt, Triangle tri);" + "public bool Bitmap.PointCollision(int cell, Point2D bmpPt, Point2D pt);", + "public static bool SplashKit.BitmapPointCollision(Bitmap bmp, int cell, Point2D bmpPt, Point2D pt);" ], "pascal": [ - "function BitmapTriangleCollision(bmp: Bitmap; cell: Integer; const pt: Point2D; const tri: Triangle): Boolean" + "function BitmapPointCollision(bmp: Bitmap; cell: Integer; const bmpPt: Point2D; const pt: Point2D): Boolean" ] } }, { - "signature": "bool bitmap_triangle_collision(bitmap bmp,int cell,double x,double y,const triangle &tri);", - "name": "bitmap_triangle_collision", - "method_name": "triangle_collision", - "unique_global_name": "bitmap_triangle_collision_for_cell", - "unique_method_name": "bitmap.triangle_collision_for_cell", + "signature": "bool bitmap_point_collision(bitmap bmp,int cell,double bmp_x,double bmp_y,double x,double y);", + "name": "bitmap_point_collision", + "method_name": "point_collision", + "unique_global_name": "bitmap_point_collision_for_cell", + "unique_method_name": "bitmap.point_collision_for_cell", "suffix_name": null, - "description": "Tests if a bitmap cell drawn at `x`, `y` would intersect with a triangle.", + "description": "Tests if a cell of a bitmap drawn at x,y would draw a pixel at the passed in point. Use\nto check collisions between a point and a bitmap.", "brief": null, "return": { "type": "bool", - "description": "True if a drawn pixel in the bitmap will\nintersect with `tri` when drawn.", + "description": "True if drawing the bitmap cell, at the indicated location,\nwill draw a pixel at the indicated point.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -66820,7 +63536,7 @@ }, "cell": { "type": "int", - "description": "The cell of the bitmap to check", + "description": "The cell of the bitmap to test", "is_pointer": false, "is_const": false, "is_reference": false, @@ -66831,7 +63547,7 @@ "is_vector": false, "type_parameter": null }, - "x": { + "bmp_x": { "type": "double", "description": "The x location where the bitmap is drawn", "is_pointer": false, @@ -66844,7 +63560,7 @@ "is_vector": false, "type_parameter": null }, - "y": { + "bmp_y": { "type": "double", "description": "The y location where the bitmap is drawn", "is_pointer": false, @@ -66857,68 +63573,12 @@ "is_vector": false, "type_parameter": null }, - "tri": { - "type": "triangle", - "description": "The triangle to test", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "class": "bitmap", - "method": "triangle_collision", - "suffix": "for_cell", - "group": "physics", - "static": "collisions", - "self": "bmp" - }, - "signatures": { - "python": [ - "def bitmap_triangle_collision_for_cell(bmp, cell, x, y, tri):" - ], - "cpp": [ - "bool bitmap_triangle_collision(bitmap bmp, int cell, double x, double y, const triangle &tri)" - ], - "csharp": [ - "public bool Bitmap.TriangleCollision(int cell, double x, double y, Triangle tri);", - "public static bool SplashKit.BitmapTriangleCollision(Bitmap bmp, int cell, double x, double y, Triangle tri);" - ], - "pascal": [ - "function BitmapTriangleCollision(bmp: Bitmap; cell: Integer; x: Double; y: Double; const tri: Triangle): Boolean" - ] - } - }, - { - "signature": "vector_2d calculate_collision_direction(const quad &collider,const quad &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_quads", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns the direction of the collision between a collider quad\nand a collidee quad relative to the collider quad. If the quads are not\ncolliding, this function will return a zero vector.", - "brief": null, - "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the collider quad,\nexpressed as a unit vector. If the quads are not colliding, this function\nwill return a zero vector.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "collider": { - "type": "quad", - "description": "The quad that is colliding", + "x": { + "type": "double", + "description": "The x location of the point to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -66926,12 +63586,12 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "quad", - "description": "The quad that is being collided with", + "y": { + "type": "double", + "description": "The y location of the point to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -66941,47 +63601,63 @@ } }, "attributes": { - "class": "quad", - "suffix": "between_quads", + "class": "bitmap", + "method": "point_collision", + "suffix": "for_cell", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_quads(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const quad &collider, const quad &collidee)" + "bool bitmap_point_collision(bitmap bmp, int cell, double bmp_x, double bmp_y, double x, double y)" + ], + "python": [ + "def bitmap_point_collision_for_cell(bmp, cell, bmp_x, bmp_y, x, y):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Quad collider, Quad collidee);" + "public bool Bitmap.PointCollision(int cell, double bmpX, double bmpY, double x, double y);", + "public static bool SplashKit.BitmapPointCollision(Bitmap bmp, int cell, double bmpX, double bmpY, double x, double y);" ], "pascal": [ - "function CalculateCollisionDirection(const collider: Quad; const collidee: Quad): Vector2D" + "function BitmapPointCollision(bmp: Bitmap; cell: Integer; bmpX: Double; bmpY: Double; x: Double; y: Double): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const circle &collider,const circle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_circles", - "unique_method_name": null, + "signature": "bool bitmap_quad_collision(bitmap bmp,const point_2d &pt,const quad &q);", + "name": "bitmap_quad_collision", + "method_name": "quad_collision", + "unique_global_name": "bitmap_quad_collision_at_point", + "unique_method_name": "bitmap.quad_collision_at_point", "suffix_name": null, - "description": "Returns the direction of the collision between a collider circle\nand a collidee circle relative to the collider circle. If the circles are not\ncolliding, this function will return a zero vector.", + "description": "Tests if a bitmap drawn at `pt` would intersect with a quad.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the collider circle,\nexpressed as a unit vector. If the circles are not colliding, this function\nwill return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `q` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "circle", - "description": "The circle that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pt": { + "type": "point_2d", + "description": "The location where the bitmap is drawn", "is_pointer": false, "is_const": true, "is_reference": true, @@ -66992,9 +63668,9 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "circle", - "description": "The circle that is being collided with", + "q": { + "type": "quad", + "description": "The quad to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67007,50 +63683,53 @@ } }, "attributes": { - "class": "circle", - "suffix": "between_circles", + "class": "bitmap", + "method": "quad_collision", + "suffix": "at_point", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_circles(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const circle &collider, const circle &collidee)" + "bool bitmap_quad_collision(bitmap bmp, const point_2d &pt, const quad &q)" + ], + "python": [ + "def bitmap_quad_collision_at_point(bmp, pt, q):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Circle collider, Circle collidee);" + "public bool Bitmap.QuadCollision(Point2D pt, Quad q);", + "public static bool SplashKit.BitmapQuadCollision(Bitmap bmp, Point2D pt, Quad q);" ], "pascal": [ - "function CalculateCollisionDirection(const collider: Circle; const collidee: Circle): Vector2D" + "function BitmapQuadCollision(bmp: Bitmap; const pt: Point2D; const q: Quad): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const circle &collider,const quad &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_circle_and_quad", - "unique_method_name": null, + "signature": "bool bitmap_quad_collision(bitmap bmp,double x,double y,const quad &q);", + "name": "bitmap_quad_collision", + "method_name": "quad_collision", + "unique_global_name": "bitmap_quad_collision", + "unique_method_name": "bitmap.quad_collision", "suffix_name": null, - "description": "Returns the direction of the collision between a circle\nand a quad relative to the circle. If the circle and\nquad are not colliding, this function will return a zero vector.", + "description": "Tests if a bitmap drawn at `x`, `y` would intersect with a quad.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the circle,\nexpressed as a unit vector. If the circle and quad are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the bitmap will\nintersect with `q` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "circle", - "description": "The circle that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -67058,65 +63737,25 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "quad", - "description": "The quad that is being collided with", + "x": { + "type": "double", + "description": "The x location where the bitmap is drawn", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "circle", - "suffix": "between_circle_and_quad", - "group": "physics", - "static": "collisions" - }, - "signatures": { - "python": [ - "def calculate_collision_direction_between_circle_and_quad(collider, collidee):" - ], - "cpp": [ - "vector_2d calculate_collision_direction(const circle &collider, const quad &collidee)" - ], - "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Circle collider, Quad collidee);" - ], - "pascal": [ - "function CalculateCollisionDirection(const collider: Circle; const collidee: Quad): Vector2D" - ] - } - }, - { - "signature": "vector_2d calculate_collision_direction(const circle &collider,const rectangle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_circle_and_rectangle", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns the direction of the collision between a circle\nand a rectangle relative to the circle. If the circle and\nrectangle are not colliding, this function will return a zero vector.", - "brief": null, - "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the circle,\nexpressed as a unit vector. If the circle and rectangle are not colliding,\nthis function will return a zero vector.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "collider": { - "type": "circle", - "description": "The circle that is colliding", + }, + "y": { + "type": "double", + "description": "The y location where the bitmap is drawn", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -67124,9 +63763,9 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "rectangle", - "description": "The rectangle that is being collided with", + "q": { + "type": "quad", + "description": "The quad to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67139,50 +63778,52 @@ } }, "attributes": { - "class": "circle", - "suffix": "between_circle_and_rectangle", + "class": "bitmap", + "method": "quad_collision", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_circle_and_rectangle(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const circle &collider, const rectangle &collidee)" + "bool bitmap_quad_collision(bitmap bmp, double x, double y, const quad &q)" + ], + "python": [ + "def bitmap_quad_collision(bmp, x, y, q):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Circle collider, Rectangle collidee);" + "public bool Bitmap.QuadCollision(double x, double y, Quad q);", + "public static bool SplashKit.BitmapQuadCollision(Bitmap bmp, double x, double y, Quad q);" ], "pascal": [ - "function CalculateCollisionDirection(const collider: Circle; const collidee: Rectangle): Vector2D" + "function BitmapQuadCollision(bmp: Bitmap; x: Double; y: Double; const q: Quad): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const circle &collider,const sprite collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_circle_and_sprite", - "unique_method_name": null, + "signature": "bool bitmap_quad_collision(bitmap bmp,int cell,const matrix_2d &translation,const quad &q);", + "name": "bitmap_quad_collision", + "method_name": "quad_collision", + "unique_global_name": "bitmap_quad_collision_for_cell_with_translation", + "unique_method_name": "bitmap.quad_collision_for_cell_with_translation", "suffix_name": null, - "description": "Returns the direction of the collision between a circle\nand a sprite relative to the circle. If the circle and\nsprite are not colliding, this function will return a zero vector.", + "description": "Tests if a bitmap cell drawn using a passed in translation, will\nintersect with a quad. You can use this to detect collisions between\nbitmaps and quads.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the circle,\nexpressed as a unit vector. If the circle and sprite are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `q` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "circle", - "description": "The circle that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -67190,11 +63831,11 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "sprite", - "description": "The sprite that is being collided with", + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -67202,50 +63843,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "circle", - "suffix": "between_circle_and_sprite", - "group": "physics", - "static": "collisions" - }, - "signatures": { - "python": [ - "def calculate_collision_direction_between_circle_and_sprite(collider, collidee):" - ], - "cpp": [ - "vector_2d calculate_collision_direction(const circle &collider, const sprite collidee)" - ], - "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Circle collider, Sprite collidee);" - ], - "pascal": [ - "function CalculateCollisionDirection(const collider: Circle; collidee: Sprite): Vector2D" - ] - } - }, - { - "signature": "vector_2d calculate_collision_direction(const circle &collider,const triangle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_circle_and_triangle", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns the direction of the collision between a circle\nand a triangle relative to the circle. If the circle and\ntriangle are not colliding, this function will return a zero vector.", - "brief": null, - "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the circle,\nexpressed as a unit vector. If the circle and triangle are not colliding,\nthis function will return a zero vector.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "collider": { - "type": "circle", - "description": "The circle that is colliding", + }, + "translation": { + "type": "matrix_2d", + "description": "The matrix used to transfrom the bitmap when drawing", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67256,9 +63857,9 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "triangle", - "description": "The triangle that is being collided with", + "q": { + "type": "quad", + "description": "The quad to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67271,50 +63872,53 @@ } }, "attributes": { - "class": "circle", - "suffix": "between_circle_and_triangle", + "class": "bitmap", + "method": "quad_collision", + "suffix": "for_cell_with_translation", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_circle_and_triangle(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const circle &collider, const triangle &collidee)" + "bool bitmap_quad_collision(bitmap bmp, int cell, const matrix_2d &translation, const quad &q)" + ], + "python": [ + "def bitmap_quad_collision_for_cell_with_translation(bmp, cell, translation, q):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Circle collider, Triangle collidee);" + "public bool Bitmap.QuadCollision(int cell, Matrix2D translation, Quad q);", + "public static bool SplashKit.BitmapQuadCollision(Bitmap bmp, int cell, Matrix2D translation, Quad q);" ], "pascal": [ - "function CalculateCollisionDirection(const collider: Circle; const collidee: Triangle): Vector2D" + "function BitmapQuadCollision(bmp: Bitmap; cell: Integer; const translation: Matrix2D; const q: Quad): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const quad &collider,const circle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_quad_and_circle", - "unique_method_name": null, + "signature": "bool bitmap_quad_collision(bitmap bmp,int cell,const point_2d &pt,const quad &q);", + "name": "bitmap_quad_collision", + "method_name": "quad_collision", + "unique_global_name": "bitmap_quad_collision_for_cell_at_point", + "unique_method_name": "bitmap.quad_collision_for_cell_at_point", "suffix_name": null, - "description": "Returns the direction of the collision between a quad\nand a circle relative to the quad. If the quad and\ncircle are not colliding, this function will return a zero vector.", + "description": "Tests if a bitmap cell drawn at `pt` would intersect with a quad.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the quad,\nexpressed as a unit vector. If the quad and circle are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `q` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "quad", - "description": "The quad that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -67322,62 +63926,22 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "circle", - "description": "The circle that is being collided with", + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "quad", - "suffix": "between_quad_and_circle", - "group": "physics", - "static": "collisions" - }, - "signatures": { - "python": [ - "def calculate_collision_direction_between_quad_and_circle(collider, collidee):" - ], - "cpp": [ - "vector_2d calculate_collision_direction(const quad &collider, const circle &collidee)" - ], - "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Quad collider, Circle collidee);" - ], - "pascal": [ - "function CalculateCollisionDirection(const collider: Quad; const collidee: Circle): Vector2D" - ] - } - }, - { - "signature": "vector_2d calculate_collision_direction(const quad &collider,const rectangle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_quad_and_rectangle", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns the direction of the collision between a quad\nand a rectangle relative to the quad. If the quad and\nrectangle are not colliding, this function will return a zero vector.", - "brief": null, - "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the quad,\nexpressed as a unit vector. If the quad and rectangle are not colliding,\nthis function will return a zero vector.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "collider": { - "type": "quad", - "description": "The quad that is colliding", + }, + "pt": { + "type": "point_2d", + "description": "The location where the bitmap is drawn", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67388,9 +63952,9 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "rectangle", - "description": "The rectangle that is being collided with", + "q": { + "type": "quad", + "description": "The quad to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67403,50 +63967,53 @@ } }, "attributes": { - "class": "quad", - "suffix": "between_quad_and_rectangle", + "class": "bitmap", + "method": "quad_collision", + "suffix": "for_cell_at_point", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_quad_and_rectangle(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const quad &collider, const rectangle &collidee)" + "bool bitmap_quad_collision(bitmap bmp, int cell, const point_2d &pt, const quad &q)" + ], + "python": [ + "def bitmap_quad_collision_for_cell_at_point(bmp, cell, pt, q):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Quad collider, Rectangle collidee);" + "public bool Bitmap.QuadCollision(int cell, Point2D pt, Quad q);", + "public static bool SplashKit.BitmapQuadCollision(Bitmap bmp, int cell, Point2D pt, Quad q);" ], "pascal": [ - "function CalculateCollisionDirection(const collider: Quad; const collidee: Rectangle): Vector2D" + "function BitmapQuadCollision(bmp: Bitmap; cell: Integer; const pt: Point2D; const q: Quad): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const quad &collider,const sprite collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_quad_and_sprite", - "unique_method_name": null, + "signature": "bool bitmap_quad_collision(bitmap bmp,int cell,double x,double y,const quad &q);", + "name": "bitmap_quad_collision", + "method_name": "quad_collision", + "unique_global_name": "bitmap_quad_collision_for_cell", + "unique_method_name": "bitmap.quad_collision_for_cell", "suffix_name": null, - "description": "Returns the direction of the collision between a quad\nand a sprite relative to the quad. If the quad and\nsprite are not colliding, this function will return a zero vector.", + "description": "Tests if a bitmap cell drawn at `x`, `y` would intersect with a quad.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the quad,\nexpressed as a unit vector. If the quad and sprite are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the bitmap will\nintersect with `q` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "quad", - "description": "The quad that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -67454,11 +64021,11 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "sprite", - "description": "The sprite that is being collided with", + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -67466,53 +64033,13 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "quad", - "suffix": "between_quad_and_sprite", - "group": "physics", - "static": "collisions" - }, - "signatures": { - "python": [ - "def calculate_collision_direction_between_quad_and_sprite(collider, collidee):" - ], - "cpp": [ - "vector_2d calculate_collision_direction(const quad &collider, const sprite collidee)" - ], - "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Quad collider, Sprite collidee);" - ], - "pascal": [ - "function CalculateCollisionDirection(const collider: Quad; collidee: Sprite): Vector2D" - ] - } - }, - { - "signature": "vector_2d calculate_collision_direction(const quad &collider,const triangle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_quad_and_triangle", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns the direction of the collision between a quad\nand a triangle relative to the quad. If the quad and\ntriangle are not colliding, this function will return a zero vector.", - "brief": null, - "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the quad,\nexpressed as a unit vector. If the quad and triangle are not colliding,\nthis function will return a zero vector.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "collider": { - "type": "quad", - "description": "The quad that is colliding", + }, + "x": { + "type": "double", + "description": "The x location where the bitmap is drawn", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -67520,9 +64047,22 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "triangle", - "description": "The triangle that is being collided with", + "y": { + "type": "double", + "description": "The y location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "q": { + "type": "quad", + "description": "The quad to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67535,50 +64075,53 @@ } }, "attributes": { - "class": "quad", - "suffix": "between_quad_and_triangle", + "class": "bitmap", + "method": "quad_collision", + "suffix": "for_cell", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_quad_and_triangle(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const quad &collider, const triangle &collidee)" + "bool bitmap_quad_collision(bitmap bmp, int cell, double x, double y, const quad &q)" + ], + "python": [ + "def bitmap_quad_collision_for_cell(bmp, cell, x, y, q):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Quad collider, Triangle collidee);" + "public bool Bitmap.QuadCollision(int cell, double x, double y, Quad q);", + "public static bool SplashKit.BitmapQuadCollision(Bitmap bmp, int cell, double x, double y, Quad q);" ], "pascal": [ - "function CalculateCollisionDirection(const collider: Quad; const collidee: Triangle): Vector2D" + "function BitmapQuadCollision(bmp: Bitmap; cell: Integer; x: Double; y: Double; const q: Quad): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const rectangle &collider,const circle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_rectangle_and_circle", - "unique_method_name": null, + "signature": "bool bitmap_ray_collision(bitmap bmp,const point_2d &pt,const point_2d &origin,const vector_2d &heading);", + "name": "bitmap_ray_collision", + "method_name": "ray_collision", + "unique_global_name": "bitmap_ray_collision_at_point", + "unique_method_name": "bitmap.ray_collision_at_point", "suffix_name": null, - "description": "Returns the direction of the collision between a rectangle\nand a circle relative to the rectangle. If the rectangle and\nsprite are not colliding, this function will return a zero vector.", + "description": "Tests if a bitmap drawn at `pt` would intersect with a ray.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the rectangle,\nexpressed as a unit vector. If the rectangle and circle are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with the ray when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "rectangle", - "description": "The rectangle that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -67586,9 +64129,9 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "circle", - "description": "The circle that is being collided with", + "pt": { + "type": "point_2d", + "description": "The location where the bitmap is drawn", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67598,50 +64141,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "rectangle", - "suffix": "between_rectangle_and_circle", - "group": "physics", - "static": "collisions" - }, - "signatures": { - "python": [ - "def calculate_collision_direction_between_rectangle_and_circle(collider, collidee):" - ], - "cpp": [ - "vector_2d calculate_collision_direction(const rectangle &collider, const circle &collidee)" - ], - "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Rectangle collider, Circle collidee);" - ], - "pascal": [ - "function CalculateCollisionDirection(const collider: Rectangle; const collidee: Circle): Vector2D" - ] - } - }, - { - "signature": "vector_2d calculate_collision_direction(const rectangle &collider,const quad &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_rectangle_and_quad", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns the direction of the collision between a rectangle\nand a quad relative to the rectangle. If the rectangle and\nsprite are not colliding, this function will return a zero vector.", - "brief": null, - "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the rectangle,\nexpressed as a unit vector. If the rectangle and quad are not colliding,\nthis function will return a zero vector.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "collider": { - "type": "rectangle", - "description": "The rectangle that is colliding", + }, + "origin": { + "type": "point_2d", + "description": "The origin of the ray", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67652,9 +64155,9 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "quad", - "description": "The quad that is being collided with", + "heading": { + "type": "vector_2d", + "description": "The heading of the ray", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67667,47 +64170,89 @@ } }, "attributes": { - "class": "rectangle", - "suffix": "between_rectangle_and_quad", + "class": "bitmap", + "method": "ray_collision", + "suffix": "at_point", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_rectangle_and_quad(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const rectangle &collider, const quad &collidee)" + "bool bitmap_ray_collision(bitmap bmp, const point_2d &pt, const point_2d &origin, const vector_2d &heading)" + ], + "python": [ + "def bitmap_ray_collision_at_point(bmp, pt, origin, heading):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Rectangle collider, Quad collidee);" + "public bool Bitmap.RayCollision(Point2D pt, Point2D origin, Vector2D heading);", + "public static bool SplashKit.BitmapRayCollision(Bitmap bmp, Point2D pt, Point2D origin, Vector2D heading);" ], "pascal": [ - "function CalculateCollisionDirection(const collider: Rectangle; const collidee: Quad): Vector2D" + "function BitmapRayCollision(bmp: Bitmap; const pt: Point2D; const origin: Point2D; const heading: Vector2D): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const rectangle &collider,const rectangle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_rectangles", - "unique_method_name": null, + "signature": "bool bitmap_ray_collision(bitmap bmp,double x,double y,const point_2d &origin,const vector_2d &heading);", + "name": "bitmap_ray_collision", + "method_name": "ray_collision", + "unique_global_name": "bitmap_ray_collision", + "unique_method_name": "bitmap.ray_collision", "suffix_name": null, - "description": "Returns the direction of the collision between a collider rectangle\nand a collidee rectangle relative to the collider rectangle. If the rectangles are not\ncolliding, this function will return a zero vector.", + "description": "Tests if a bitmap drawn at `x`, `y` would intersect with a ray.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the collider rectangle,\nexpressed as a unit vector. If the rectangles are not colliding, this function\nwill return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the bitmap will\nintersect with the ray when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "rectangle", - "description": "The rectangle that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x": { + "type": "double", + "description": "The x location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "origin": { + "type": "point_2d", + "description": "The origin of the ray", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67718,9 +64263,9 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "rectangle", - "description": "The rectangle that is being collided with", + "heading": { + "type": "vector_2d", + "description": "The heading of the ray", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67733,47 +64278,75 @@ } }, "attributes": { - "class": "rectangle", - "suffix": "between_rectangles", + "class": "bitmap", + "method": "ray_collision", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_rectangles(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const rectangle &collider, const rectangle &collidee)" + "bool bitmap_ray_collision(bitmap bmp, double x, double y, const point_2d &origin, const vector_2d &heading)" + ], + "python": [ + "def bitmap_ray_collision(bmp, x, y, origin, heading):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Rectangle collider, Rectangle collidee);" + "public bool Bitmap.RayCollision(double x, double y, Point2D origin, Vector2D heading);", + "public static bool SplashKit.BitmapRayCollision(Bitmap bmp, double x, double y, Point2D origin, Vector2D heading);" ], "pascal": [ - "function CalculateCollisionDirection(const collider: Rectangle; const collidee: Rectangle): Vector2D" + "function BitmapRayCollision(bmp: Bitmap; x: Double; y: Double; const origin: Point2D; const heading: Vector2D): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const rectangle &collider,const sprite collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_rectangle_and_sprite", - "unique_method_name": null, + "signature": "bool bitmap_ray_collision(bitmap bmp,int cell,const matrix_2d &translation,const point_2d &origin,const vector_2d &heading);", + "name": "bitmap_ray_collision", + "method_name": "ray_collision", + "unique_global_name": "bitmap_ray_collision_for_cell_with_translation", + "unique_method_name": "bitmap.ray_collision_for_cell_with_translation", "suffix_name": null, - "description": "Returns the direction of the collision between a rectangle\nand a sprite relative to the rectangle. If the rectangle and\nsprite are not colliding, this function will return a zero vector.", + "description": "Tests if a bitmap cell drawn using a passed in translation, will\nintersect with a ray. You can use this to detect collisions between\nbitmaps and rays.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the rectangle,\nexpressed as a unit vector. If the rectangle and sprite are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with the ray when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "rectangle", - "description": "The rectangle that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "translation": { + "type": "matrix_2d", + "description": "The matrix used to transfrom the bitmap when drawing", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67784,12 +64357,25 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "sprite", - "description": "The sprite that is being collided with", + "origin": { + "type": "point_2d", + "description": "The origin of the ray", "is_pointer": false, "is_const": true, - "is_reference": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "heading": { + "type": "vector_2d", + "description": "The heading of the ray", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -67799,47 +64385,76 @@ } }, "attributes": { - "class": "rectangle", - "suffix": "between_rectangle_and_sprite", + "class": "bitmap", + "method": "ray_collision", + "suffix": "for_cell_with_translation", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_rectangle_and_sprite(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const rectangle &collider, const sprite collidee)" + "bool bitmap_ray_collision(bitmap bmp, int cell, const matrix_2d &translation, const point_2d &origin, const vector_2d &heading)" + ], + "python": [ + "def bitmap_ray_collision_for_cell_with_translation(bmp, cell, translation, origin, heading):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Rectangle collider, Sprite collidee);" + "public bool Bitmap.RayCollision(int cell, Matrix2D translation, Point2D origin, Vector2D heading);", + "public static bool SplashKit.BitmapRayCollision(Bitmap bmp, int cell, Matrix2D translation, Point2D origin, Vector2D heading);" ], "pascal": [ - "function CalculateCollisionDirection(const collider: Rectangle; collidee: Sprite): Vector2D" + "function BitmapRayCollision(bmp: Bitmap; cell: Integer; const translation: Matrix2D; const origin: Point2D; const heading: Vector2D): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const rectangle &collider,const triangle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_rectangle_and_triangle", - "unique_method_name": null, + "signature": "bool bitmap_ray_collision(bitmap bmp,int cell,const point_2d &pt,const point_2d &origin,const vector_2d &heading);", + "name": "bitmap_ray_collision", + "method_name": "ray_collision", + "unique_global_name": "bitmap_ray_collision_for_cell_at_point", + "unique_method_name": "bitmap.ray_collision_for_cell_at_point", "suffix_name": null, - "description": "Returns the direction of the collision between a rectangle\nand a triangle relative to the rectangle. If the rectangle and\nsprite are not colliding, this function will return a zero vector.", + "description": "Tests if a bitmap cell drawn at `pt` would intersect with a ray.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the rectangle,\nexpressed as a unit vector. If the rectangle and triangle are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with the ray when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "rectangle", - "description": "The rectangle that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pt": { + "type": "point_2d", + "description": "The location where the bitmap is drawn", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67850,9 +64465,22 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "triangle", - "description": "The triangle that is being collided with", + "origin": { + "type": "point_2d", + "description": "The origin of the ray", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "heading": { + "type": "vector_2d", + "description": "The heading of the ray", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67865,49 +64493,52 @@ } }, "attributes": { - "class": "rectangle", - "suffix": "between_rectangle_and_triangle", + "class": "bitmap", + "method": "ray_collision", + "suffix": "for_cell_at_point", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_rectangle_and_triangle(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const rectangle &collider, const triangle &collidee)" + "bool bitmap_ray_collision(bitmap bmp, int cell, const point_2d &pt, const point_2d &origin, const vector_2d &heading)" + ], + "python": [ + "def bitmap_ray_collision_for_cell_at_point(bmp, cell, pt, origin, heading):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Rectangle collider, Triangle collidee);" + "public bool Bitmap.RayCollision(int cell, Point2D pt, Point2D origin, Vector2D heading);", + "public static bool SplashKit.BitmapRayCollision(Bitmap bmp, int cell, Point2D pt, Point2D origin, Vector2D heading);" ], "pascal": [ - "function CalculateCollisionDirection(const collider: Rectangle; const collidee: Triangle): Vector2D" + "function BitmapRayCollision(bmp: Bitmap; cell: Integer; const pt: Point2D; const origin: Point2D; const heading: Vector2D): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const sprite collider,const circle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_sprite_and_circle", - "unique_method_name": null, + "signature": "bool bitmap_ray_collision(bitmap bmp,int cell,double x,double y,const point_2d &origin,const vector_2d &heading);", + "name": "bitmap_ray_collision", + "method_name": "ray_collision", + "unique_global_name": "bitmap_ray_collision_for_cell", + "unique_method_name": "bitmap.ray_collision_for_cell", "suffix_name": null, - "description": "Returns the direction of the collision between a sprite\nand a circle relative to the sprite. If the sprite and\ncircle are not colliding, this function will return a zero vector.", + "description": "Tests if a bitmap cell drawn at `x`, `y` would intersect with a ray.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the sprite,\nexpressed as a unit vector. If the sprite and circle are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with the ray when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "sprite", - "description": "The sprite that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -67916,9 +64547,61 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "circle", - "description": "The circle that is being collided with", + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x": { + "type": "double", + "description": "The x location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "origin": { + "type": "point_2d", + "description": "The origin of the ray", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "heading": { + "type": "vector_2d", + "description": "The heading of the ray", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67931,49 +64614,52 @@ } }, "attributes": { - "class": "sprite", - "suffix": "between_sprite_and_circle", + "class": "bitmap", + "method": "ray_collision", + "suffix": "for_cell", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_sprite_and_circle(collider, collidee):" + "cpp": [ + "bool bitmap_ray_collision(bitmap bmp, int cell, double x, double y, const point_2d &origin, const vector_2d &heading)" ], - "cpp": [ - "vector_2d calculate_collision_direction(const sprite collider, const circle &collidee)" + "python": [ + "def bitmap_ray_collision_for_cell(bmp, cell, x, y, origin, heading):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Sprite collider, Circle collidee);" + "public bool Bitmap.RayCollision(int cell, double x, double y, Point2D origin, Vector2D heading);", + "public static bool SplashKit.BitmapRayCollision(Bitmap bmp, int cell, double x, double y, Point2D origin, Vector2D heading);" ], "pascal": [ - "function CalculateCollisionDirection(collider: Sprite; const collidee: Circle): Vector2D" + "function BitmapRayCollision(bmp: Bitmap; cell: Integer; x: Double; y: Double; const origin: Point2D; const heading: Vector2D): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const sprite collider,const quad &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_sprite_and_quad", - "unique_method_name": null, + "signature": "bool bitmap_rectangle_collision(bitmap bmp,const point_2d &pt,const rectangle &rect);", + "name": "bitmap_rectangle_collision", + "method_name": "rectangle_collision", + "unique_global_name": "bitmap_rectangle_collision_at_point", + "unique_method_name": "bitmap.rectangle_collision_at_point", "suffix_name": null, - "description": "Returns the direction of the collision between a sprite\nand a quad relative to the sprite. If the sprite and\nquad are not colliding, this function will return a zero vector.", + "description": "Tests if a bitmap drawn at `pt` would intersect with a rectangle.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the sprite,\nexpressed as a unit vector. If the sprite and quad are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `rect` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "sprite", - "description": "The sprite that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -67982,9 +64668,22 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "quad", - "description": "The quad that is being collided with", + "pt": { + "type": "point_2d", + "description": "The location where the bitmap is drawn", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect": { + "type": "rectangle", + "description": "The rectangle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -67997,49 +64696,52 @@ } }, "attributes": { - "class": "sprite", - "suffix": "between_sprite_and_quad", + "class": "bitmap", + "method": "rectangle_collision", + "suffix": "at_point", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_sprite_and_quad(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const sprite collider, const quad &collidee)" + "bool bitmap_rectangle_collision(bitmap bmp, const point_2d &pt, const rectangle &rect)" + ], + "python": [ + "def bitmap_rectangle_collision_at_point(bmp, pt, rect):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Sprite collider, Quad collidee);" + "public bool Bitmap.RectangleCollision(Point2D pt, Rectangle rect);", + "public static bool SplashKit.BitmapRectangleCollision(Bitmap bmp, Point2D pt, Rectangle rect);" ], "pascal": [ - "function CalculateCollisionDirection(collider: Sprite; const collidee: Quad): Vector2D" + "function BitmapRectangleCollision(bmp: Bitmap; const pt: Point2D; const rect: Rectangle): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const sprite collider,const rectangle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_sprite_and_rectangle", - "unique_method_name": null, + "signature": "bool bitmap_rectangle_collision(bitmap bmp,double x,double y,const rectangle &rect);", + "name": "bitmap_rectangle_collision", + "method_name": "rectangle_collision", + "unique_global_name": "bitmap_rectangle_collision", + "unique_method_name": "bitmap.rectangle_collision", "suffix_name": null, - "description": "Returns the direction of the collision between a sprite\nand a rectangle relative to the sprite. If the sprite and\nrectangle are not colliding, this function will return a zero vector.", + "description": "Tests if a bitmap drawn at `x`, `y` would intersect with a rectangle.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the sprite,\nexpressed as a unit vector. If the sprite and rectangle are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the bitmap will\nintersect with `rect` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "sprite", - "description": "The sprite that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -68048,9 +64750,35 @@ "is_vector": false, "type_parameter": null }, - "collidee": { + "x": { + "type": "double", + "description": "The x location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect": { "type": "rectangle", - "description": "The rectangle that is being collided with", + "description": "The rectangle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68063,49 +64791,51 @@ } }, "attributes": { - "class": "sprite", - "suffix": "between_sprite_and_rectangle", + "class": "bitmap", + "method": "rectangle_collision", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_sprite_and_rectangle(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const sprite collider, const rectangle &collidee)" + "bool bitmap_rectangle_collision(bitmap bmp, double x, double y, const rectangle &rect)" + ], + "python": [ + "def bitmap_rectangle_collision(bmp, x, y, rect):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Sprite collider, Rectangle collidee);" + "public bool Bitmap.RectangleCollision(double x, double y, Rectangle rect);", + "public static bool SplashKit.BitmapRectangleCollision(Bitmap bmp, double x, double y, Rectangle rect);" ], "pascal": [ - "function CalculateCollisionDirection(collider: Sprite; const collidee: Rectangle): Vector2D" + "function BitmapRectangleCollision(bmp: Bitmap; x: Double; y: Double; const rect: Rectangle): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const sprite collider,const sprite collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_sprites", - "unique_method_name": null, + "signature": "bool bitmap_rectangle_collision(bitmap bmp,int cell,const matrix_2d &translation,const rectangle &rect);", + "name": "bitmap_rectangle_collision", + "method_name": "rectangle_collision", + "unique_global_name": "bitmap_rectangle_collision_for_cell_with_translation", + "unique_method_name": "bitmap.rectangle_collision_for_cell_with_translation", "suffix_name": null, - "description": "Returns the direction of the collision between two sprites\nrelative to the collider sprite. If the sprites are not colliding,\nthis function will return a zero vector.", + "description": "Tests if a bitmap cell drawn using a passed in translation, will\nintersect with a rectangle. You can use this to detect collisions between\nbitmaps and rectangles.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the collider sprite,\nexpressed as a unit vector. If the sprites are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `rect` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "sprite", - "description": "The sprite that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -68114,64 +64844,93 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "sprite", - "description": "The sprite that is being collided with", + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "translation": { + "type": "matrix_2d", + "description": "The matrix used to transfrom the bitmap when drawing", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect": { + "type": "rectangle", + "description": "The rectangle to test", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { - "class": "sprite", - "suffix": "between_sprites", + "class": "bitmap", + "method": "rectangle_collision", + "suffix": "for_cell_with_translation", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_sprites(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const sprite collider, const sprite collidee)" + "bool bitmap_rectangle_collision(bitmap bmp, int cell, const matrix_2d &translation, const rectangle &rect)" + ], + "python": [ + "def bitmap_rectangle_collision_for_cell_with_translation(bmp, cell, translation, rect):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Sprite collider, Sprite collidee);" + "public bool Bitmap.RectangleCollision(int cell, Matrix2D translation, Rectangle rect);", + "public static bool SplashKit.BitmapRectangleCollision(Bitmap bmp, int cell, Matrix2D translation, Rectangle rect);" ], "pascal": [ - "function CalculateCollisionDirection(collider: Sprite; collidee: Sprite): Vector2D" + "function BitmapRectangleCollision(bmp: Bitmap; cell: Integer; const translation: Matrix2D; const rect: Rectangle): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const sprite collider,const triangle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_sprite_and_triangle", - "unique_method_name": null, + "signature": "bool bitmap_rectangle_collision(bitmap bmp,int cell,const point_2d &pt,const rectangle &rect);", + "name": "bitmap_rectangle_collision", + "method_name": "rectangle_collision", + "unique_global_name": "bitmap_rectangle_collision_for_cell_at_point", + "unique_method_name": "bitmap.rectangle_collision_for_cell_at_point", "suffix_name": null, - "description": "Returns the direction of the collision between a sprite\nand a triangle relative to the sprite. If the sprite and\ntriangle are not colliding, this function will return a zero vector.", + "description": "Tests if a bitmap cell drawn at `pt` would intersect with a rectangle.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the sprite,\nexpressed as a unit vector. If the sprite and triangle are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `rect` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "sprite", - "description": "The sprite that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -68180,9 +64939,35 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "triangle", - "description": "The triangle that is being collided with", + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pt": { + "type": "point_2d", + "description": "The location where the bitmap is drawn", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect": { + "type": "rectangle", + "description": "The rectangle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68195,50 +64980,53 @@ } }, "attributes": { - "class": "sprite", - "suffix": "between_sprite_and_triangle", + "class": "bitmap", + "method": "rectangle_collision", + "suffix": "for_cell_at_point", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_sprite_and_triangle(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const sprite collider, const triangle &collidee)" + "bool bitmap_rectangle_collision(bitmap bmp, int cell, const point_2d &pt, const rectangle &rect)" + ], + "python": [ + "def bitmap_rectangle_collision_for_cell_at_point(bmp, cell, pt, rect):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Sprite collider, Triangle collidee);" + "public bool Bitmap.RectangleCollision(int cell, Point2D pt, Rectangle rect);", + "public static bool SplashKit.BitmapRectangleCollision(Bitmap bmp, int cell, Point2D pt, Rectangle rect);" ], "pascal": [ - "function CalculateCollisionDirection(collider: Sprite; const collidee: Triangle): Vector2D" + "function BitmapRectangleCollision(bmp: Bitmap; cell: Integer; const pt: Point2D; const rect: Rectangle): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const triangle &collider,const circle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_triangle_and_circle", - "unique_method_name": null, + "signature": "bool bitmap_rectangle_collision(bitmap bmp,int cell,double x,double y,const rectangle &rect);", + "name": "bitmap_rectangle_collision", + "method_name": "rectangle_collision", + "unique_global_name": "bitmap_rectangle_collision_for_cell", + "unique_method_name": "bitmap.rectangle_collision_for_cell", "suffix_name": null, - "description": "Returns the direction of the collision between a triangle\nand a circle relative to the triangle. If the triangle and\ncircle are not colliding, this function will return a zero vector.", + "description": "Tests if a cell of the bitmap drawn at `x`, `y` would intersect with a rectangle.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the triangle,\nexpressed as a unit vector. If the triangle and circle are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the bitmap will\nintersect with `rect` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "triangle", - "description": "The triangle that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -68246,9 +65034,48 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "circle", - "description": "The circle that is being collided with", + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x": { + "type": "double", + "description": "The x location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect": { + "type": "rectangle", + "description": "The rectangle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68261,47 +65088,63 @@ } }, "attributes": { - "class": "triangle", - "suffix": "between_triangle_and_circle", + "class": "bitmap", + "method": "rectangle_collision", + "suffix": "for_cell", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_triangle_and_circle(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const triangle &collider, const circle &collidee)" + "bool bitmap_rectangle_collision(bitmap bmp, int cell, double x, double y, const rectangle &rect)" + ], + "python": [ + "def bitmap_rectangle_collision_for_cell(bmp, cell, x, y, rect):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Triangle collider, Circle collidee);" + "public bool Bitmap.RectangleCollision(int cell, double x, double y, Rectangle rect);", + "public static bool SplashKit.BitmapRectangleCollision(Bitmap bmp, int cell, double x, double y, Rectangle rect);" ], "pascal": [ - "function CalculateCollisionDirection(const collider: Triangle; const collidee: Circle): Vector2D" + "function BitmapRectangleCollision(bmp: Bitmap; cell: Integer; x: Double; y: Double; const rect: Rectangle): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const triangle &collider,const quad &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_triangle_and_quad", - "unique_method_name": null, + "signature": "bool bitmap_triangle_collision(bitmap bmp,const point_2d &pt,const triangle &tri);", + "name": "bitmap_triangle_collision", + "method_name": "triangle_collision", + "unique_global_name": "bitmap_triangle_collision_at_point", + "unique_method_name": "bitmap.triangle_collision_at_point", "suffix_name": null, - "description": "Returns the direction of the collision between a triangle\nand a quad relative to the triangle. If the triangle and\nquad are not colliding, this function will return a zero vector.", + "description": "Tests if a bitmap drawn at `pt` would intersect with a triangle.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the triangle,\nexpressed as a unit vector. If the triangle and quad are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `tri` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "triangle", - "description": "The triangle that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pt": { + "type": "point_2d", + "description": "The location where the bitmap is drawn", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68312,9 +65155,9 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "quad", - "description": "The quad that is being collided with", + "tri": { + "type": "triangle", + "description": "The triangle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68327,50 +65170,53 @@ } }, "attributes": { - "class": "triangle", - "suffix": "between_triangle_and_quad", + "class": "bitmap", + "method": "triangle_collision", + "suffix": "at_point", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_triangle_and_quad(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const triangle &collider, const quad &collidee)" + "bool bitmap_triangle_collision(bitmap bmp, const point_2d &pt, const triangle &tri)" + ], + "python": [ + "def bitmap_triangle_collision_at_point(bmp, pt, tri):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Triangle collider, Quad collidee);" + "public bool Bitmap.TriangleCollision(Point2D pt, Triangle tri);", + "public static bool SplashKit.BitmapTriangleCollision(Bitmap bmp, Point2D pt, Triangle tri);" ], "pascal": [ - "function CalculateCollisionDirection(const collider: Triangle; const collidee: Quad): Vector2D" + "function BitmapTriangleCollision(bmp: Bitmap; const pt: Point2D; const tri: Triangle): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const triangle &collider,const rectangle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_triangle_and_rectangle", - "unique_method_name": null, + "signature": "bool bitmap_triangle_collision(bitmap bmp,double x,double y,const triangle &tri);", + "name": "bitmap_triangle_collision", + "method_name": "triangle_collision", + "unique_global_name": "bitmap_triangle_collision", + "unique_method_name": "bitmap.triangle_collision", "suffix_name": null, - "description": "Returns the direction of the collision between a triangle\nand a rectangle relative to the triangle. If the triangle and\nrectangle are not colliding, this function will return a zero vector.", + "description": "Tests if a bitmap drawn at `x`, `y` would intersect with a triangle.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the triangle,\nexpressed as a unit vector. If the triangle and rectangle are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the bitmap will\nintersect with `tri` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "triangle", - "description": "The triangle that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -68378,9 +65224,35 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "rectangle", - "description": "The rectangle that is being collided with", + "x": { + "type": "double", + "description": "The x location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "tri": { + "type": "triangle", + "description": "The triangle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68393,50 +65265,52 @@ } }, "attributes": { - "class": "triangle", - "suffix": "between_triangle_and_rectangle", + "class": "bitmap", + "method": "triangle_collision", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_triangle_and_rectangle(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const triangle &collider, const rectangle &collidee)" + "bool bitmap_triangle_collision(bitmap bmp, double x, double y, const triangle &tri)" + ], + "python": [ + "def bitmap_triangle_collision(bmp, x, y, tri):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Triangle collider, Rectangle collidee);" + "public bool Bitmap.TriangleCollision(double x, double y, Triangle tri);", + "public static bool SplashKit.BitmapTriangleCollision(Bitmap bmp, double x, double y, Triangle tri);" ], "pascal": [ - "function CalculateCollisionDirection(const collider: Triangle; const collidee: Rectangle): Vector2D" + "function BitmapTriangleCollision(bmp: Bitmap; x: Double; y: Double; const tri: Triangle): Boolean" ] } }, { - "signature": "vector_2d calculate_collision_direction(const triangle &collider,const sprite collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_triangle_and_sprite", - "unique_method_name": null, + "signature": "bool bitmap_triangle_collision(bitmap bmp,int cell,const matrix_2d &translation,const triangle &tri);", + "name": "bitmap_triangle_collision", + "method_name": "triangle_collision", + "unique_global_name": "bitmap_triangle_collision_for_cell_with_translation", + "unique_method_name": "bitmap.triangle_collision_for_cell_with_translation", "suffix_name": null, - "description": "Returns the direction of the collision between a triangle\nand a sprite relative to the triangle. If the triangle and\nsprite are not colliding, this function will return a zero vector.", + "description": "Tests if a bitmap cell drawn using a passed in translation, will\nintersect with a triangle. You can use this to detect collisions between\nbitmaps and triangles.", "brief": null, "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the triangle,\nexpressed as a unit vector. If the triangle and sprite are not colliding,\nthis function will return a zero vector.", + "type": "bool", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `tri` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "triangle", - "description": "The triangle that is colliding", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -68444,11 +65318,11 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "sprite", - "description": "The sprite that is being collided with", + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -68456,50 +65330,10 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "triangle", - "suffix": "between_triangle_and_sprite", - "group": "physics", - "static": "collisions" - }, - "signatures": { - "python": [ - "def calculate_collision_direction_between_triangle_and_sprite(collider, collidee):" - ], - "cpp": [ - "vector_2d calculate_collision_direction(const triangle &collider, const sprite collidee)" - ], - "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Triangle collider, Sprite collidee);" - ], - "pascal": [ - "function CalculateCollisionDirection(const collider: Triangle; collidee: Sprite): Vector2D" - ] - } - }, - { - "signature": "vector_2d calculate_collision_direction(const triangle &collider,const triangle &collidee);", - "name": "calculate_collision_direction", - "method_name": null, - "unique_global_name": "calculate_collision_direction_between_triangles", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns the direction of the collision between a collider triangle\nand a collidee triangle relative to the collider triangle. If the triangles are not\ncolliding, this function will return a zero vector.", - "brief": null, - "return": { - "type": "vector_2d", - "description": "The direction of the collision relative to the collider triangle,\nexpressed as a unit vector. If the triangles are not colliding, this function\nwill return a zero vector.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "collider": { - "type": "triangle", - "description": "The triangle that is colliding", + }, + "translation": { + "type": "matrix_2d", + "description": "The matrix used to transfrom the bitmap when drawing", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68510,9 +65344,9 @@ "is_vector": false, "type_parameter": null }, - "collidee": { + "tri": { "type": "triangle", - "description": "The triangle that is being collided with", + "description": "The triangle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68525,50 +65359,53 @@ } }, "attributes": { - "class": "triangle", - "suffix": "between_triangles", + "class": "bitmap", + "method": "triangle_collision", + "suffix": "for_cell_with_translation", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def calculate_collision_direction_between_triangles(collider, collidee):" - ], "cpp": [ - "vector_2d calculate_collision_direction(const triangle &collider, const triangle &collidee)" + "bool bitmap_triangle_collision(bitmap bmp, int cell, const matrix_2d &translation, const triangle &tri)" + ], + "python": [ + "def bitmap_triangle_collision_for_cell_with_translation(bmp, cell, translation, tri):" ], "csharp": [ - "public static Vector2D SplashKit.CalculateCollisionDirection(Triangle collider, Triangle collidee);" + "public bool Bitmap.TriangleCollision(int cell, Matrix2D translation, Triangle tri);", + "public static bool SplashKit.BitmapTriangleCollision(Bitmap bmp, int cell, Matrix2D translation, Triangle tri);" ], "pascal": [ - "function CalculateCollisionDirection(const collider: Triangle; const collidee: Triangle): Vector2D" + "function BitmapTriangleCollision(bmp: Bitmap; cell: Integer; const translation: Matrix2D; const tri: Triangle): Boolean" ] } }, { - "signature": "bool resolve_collision(quad &collider,const quad &collidee,const vector_2d &direction);", - "name": "resolve_collision", - "method_name": null, - "unique_global_name": "resolve_collision_between_quads", - "unique_method_name": null, + "signature": "bool bitmap_triangle_collision(bitmap bmp,int cell,const point_2d &pt,const triangle &tri);", + "name": "bitmap_triangle_collision", + "method_name": "triangle_collision", + "unique_global_name": "bitmap_triangle_collision_for_cell_at_point", + "unique_method_name": "bitmap.triangle_collision_for_cell_at_point", "suffix_name": null, - "description": "Resolves the collision between a collider quad and a collidee quad by moving the\ncollider quad to the edge of the collidee quad. The direction of the\nresolution is determined by the `direction` parameter. If the quads are not\ncolliding, this function will return false.", + "description": "Tests if a bitmap cell drawn at `pt` would intersect with a triangle.", "brief": null, "return": { "type": "bool", - "description": "True if the quads are colliding and the collision was resolved,\nfalse if the quads are not colliding", + "description": "True if a drawn pixel in the cell of the bitmap will\nintersect with `tri` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "quad", - "description": "The quad which will be altered if there is a collision", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, "is_const": false, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -68576,9 +65413,22 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "quad", - "description": "The quad which will not be altered", + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pt": { + "type": "point_2d", + "description": "The location where the bitmap is drawn", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68589,9 +65439,9 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the collider quad,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "tri": { + "type": "triangle", + "description": "The triangle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68604,50 +65454,53 @@ } }, "attributes": { - "class": "quad", - "suffix": "between_quads", + "class": "bitmap", + "method": "triangle_collision", + "suffix": "for_cell_at_point", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def resolve_collision_between_quads(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(quad &collider, const quad &collidee, const vector_2d &direction)" + "bool bitmap_triangle_collision(bitmap bmp, int cell, const point_2d &pt, const triangle &tri)" + ], + "python": [ + "def bitmap_triangle_collision_for_cell_at_point(bmp, cell, pt, tri):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Quad collider, Quad collidee, Vector2D direction);" + "public bool Bitmap.TriangleCollision(int cell, Point2D pt, Triangle tri);", + "public static bool SplashKit.BitmapTriangleCollision(Bitmap bmp, int cell, Point2D pt, Triangle tri);" ], "pascal": [ - "function ResolveCollision(var collider: Quad; const collidee: Quad; const direction: Vector2D): Boolean" + "function BitmapTriangleCollision(bmp: Bitmap; cell: Integer; const pt: Point2D; const tri: Triangle): Boolean" ] } }, { - "signature": "bool resolve_collision(circle &collider,const circle &collidee,const vector_2d &direction);", - "name": "resolve_collision", - "method_name": null, - "unique_global_name": "resolve_collision_between_circles", - "unique_method_name": null, + "signature": "bool bitmap_triangle_collision(bitmap bmp,int cell,double x,double y,const triangle &tri);", + "name": "bitmap_triangle_collision", + "method_name": "triangle_collision", + "unique_global_name": "bitmap_triangle_collision_for_cell", + "unique_method_name": "bitmap.triangle_collision_for_cell", "suffix_name": null, - "description": "Resolves the collision between a collider circle and a collidee circle by moving the\ncollider circle to the edge of the collidee circle. The direction of the\nresolution is determined by the `direction` parameter. If the circles are not\ncolliding, this function will return false.", + "description": "Tests if a bitmap cell drawn at `x`, `y` would intersect with a triangle.", "brief": null, "return": { "type": "bool", - "description": "True if the circles are colliding and the collision was resolved,\nfalse if the circles are not colliding", + "description": "True if a drawn pixel in the bitmap will\nintersect with `tri` when drawn.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "collider": { - "type": "circle", - "description": "The circle which will be altered if there is a collision", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, "is_const": false, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -68655,12 +65508,12 @@ "is_vector": false, "type_parameter": null }, - "collidee": { - "type": "circle", - "description": "The circle which will not be altered", + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -68668,9 +65521,35 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the collider circle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "x": { + "type": "double", + "description": "The x location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "tri": { + "type": "triangle", + "description": "The triangle to test", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68683,38 +65562,41 @@ } }, "attributes": { - "class": "circle", - "suffix": "between_circles", + "class": "bitmap", + "method": "triangle_collision", + "suffix": "for_cell", "group": "physics", - "static": "collisions" + "static": "collisions", + "self": "bmp" }, "signatures": { - "python": [ - "def resolve_collision_between_circles(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(circle &collider, const circle &collidee, const vector_2d &direction)" + "bool bitmap_triangle_collision(bitmap bmp, int cell, double x, double y, const triangle &tri)" + ], + "python": [ + "def bitmap_triangle_collision_for_cell(bmp, cell, x, y, tri):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Circle collider, Circle collidee, Vector2D direction);" + "public bool Bitmap.TriangleCollision(int cell, double x, double y, Triangle tri);", + "public static bool SplashKit.BitmapTriangleCollision(Bitmap bmp, int cell, double x, double y, Triangle tri);" ], "pascal": [ - "function ResolveCollision(var collider: Circle; const collidee: Circle; const direction: Vector2D): Boolean" + "function BitmapTriangleCollision(bmp: Bitmap; cell: Integer; x: Double; y: Double; const tri: Triangle): Boolean" ] } }, { - "signature": "bool resolve_collision(circle &collider,const quad &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const quad &collider,const quad &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_circle_and_quad", + "unique_global_name": "calculate_collision_direction_between_quads", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a circle and a quad by moving the\ncircle to the edge of the quad. The direction of the\nresolution is determined by the `direction` parameter. If the circle and\nquad are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a collider quad\nand a collidee quad relative to the collider quad. If the quads are not\ncolliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the circle and quad are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the collider quad,\nexpressed as a unit vector. If the quads are not colliding, this function\nwill return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -68722,21 +65604,8 @@ }, "parameters": { "collider": { - "type": "circle", - "description": "The circle which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { "type": "quad", - "description": "The quad which will not be altered", + "description": "The quad that is colliding", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68747,9 +65616,9 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the circle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "quad", + "description": "The quad that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68762,38 +65631,38 @@ } }, "attributes": { - "class": "circle", - "suffix": "between_circle_and_quad", + "class": "quad", + "suffix": "between_quads", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_circle_and_quad(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(circle &collider, const quad &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const quad &collider, const quad &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_quads(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Circle collider, Quad collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Quad collider, Quad collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Circle; const collidee: Quad; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Quad; const collidee: Quad): Vector2D" ] } }, { - "signature": "bool resolve_collision(circle &collider,const rectangle &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const circle &collider,const circle &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_circle_and_rectangle", + "unique_global_name": "calculate_collision_direction_between_circles", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a circle and a rectangle by moving the\ncircle to the edge of the rectangle. The direction of the\nresolution is determined by the `direction` parameter. If the circle and\nrectangle are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a collider circle\nand a collidee circle relative to the collider circle. If the circles are not\ncolliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the circle and rectangle are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the collider circle,\nexpressed as a unit vector. If the circles are not colliding, this function\nwill return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -68802,20 +65671,7 @@ "parameters": { "collider": { "type": "circle", - "description": "The circle which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { - "type": "rectangle", - "description": "The rectangle which will not be altered", + "description": "The circle that is colliding", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68826,9 +65682,9 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the circle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "circle", + "description": "The circle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68842,37 +65698,37 @@ }, "attributes": { "class": "circle", - "suffix": "between_circle_and_rectangle", + "suffix": "between_circles", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_circle_and_rectangle(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(circle &collider, const rectangle &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const circle &collider, const circle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_circles(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Circle collider, Rectangle collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Circle collider, Circle collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Circle; const collidee: Rectangle; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Circle; const collidee: Circle): Vector2D" ] } }, { - "signature": "bool resolve_collision(circle &collider,const sprite collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const circle &collider,const quad &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_circle_and_sprite", + "unique_global_name": "calculate_collision_direction_between_circle_and_quad", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a circle and a sprite by moving the\ncircle to the edge of the sprite. The direction of the\nresolution is determined by the `direction` parameter. If the circle and\nsprite are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a circle\nand a quad relative to the circle. If the circle and\nquad are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the circle and sprite are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the circle,\nexpressed as a unit vector. If the circle and quad are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -68881,9 +65737,9 @@ "parameters": { "collider": { "type": "circle", - "description": "The circle which will be altered if there is a collision", + "description": "The circle that is colliding", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -68893,21 +65749,8 @@ "type_parameter": null }, "collidee": { - "type": "sprite", - "description": "The sprite which will not be altered", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the circle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "type": "quad", + "description": "The quad that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68921,37 +65764,37 @@ }, "attributes": { "class": "circle", - "suffix": "between_circle_and_sprite", + "suffix": "between_circle_and_quad", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_circle_and_sprite(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(circle &collider, const sprite collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const circle &collider, const quad &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_circle_and_quad(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Circle collider, Sprite collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Circle collider, Quad collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Circle; collidee: Sprite; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Circle; const collidee: Quad): Vector2D" ] } }, { - "signature": "bool resolve_collision(circle &collider,const triangle &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const circle &collider,const rectangle &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_circle_and_triangle", + "unique_global_name": "calculate_collision_direction_between_circle_and_rectangle", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a circle and a triangle by moving the\ncircle to the edge of the triangle. The direction of the\nresolution is determined by the `direction` parameter. If the circle and\ntriangle are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a circle\nand a rectangle relative to the circle. If the circle and\nrectangle are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the circle and triangle are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the circle,\nexpressed as a unit vector. If the circle and rectangle are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -68960,20 +65803,7 @@ "parameters": { "collider": { "type": "circle", - "description": "The circle which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { - "type": "triangle", - "description": "The triangle which will not be altered", + "description": "The circle that is colliding", "is_pointer": false, "is_const": true, "is_reference": true, @@ -68984,9 +65814,9 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the circle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "rectangle", + "description": "The rectangle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69000,37 +65830,37 @@ }, "attributes": { "class": "circle", - "suffix": "between_circle_and_triangle", + "suffix": "between_circle_and_rectangle", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_circle_and_triangle(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(circle &collider, const triangle &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const circle &collider, const rectangle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_circle_and_rectangle(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Circle collider, Triangle collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Circle collider, Rectangle collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Circle; const collidee: Triangle; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Circle; const collidee: Rectangle): Vector2D" ] } }, { - "signature": "bool resolve_collision(quad &collider,const circle &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const circle &collider,const sprite collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_quad_and_circle", + "unique_global_name": "calculate_collision_direction_between_circle_and_sprite", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a quad and a circle by moving the\nquad to the edge of the circle. The direction of the\nresolution is determined by the `direction` parameter. If the quad and\ncircle are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a circle\nand a sprite relative to the circle. If the circle and\nsprite are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the quad and circle are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the circle,\nexpressed as a unit vector. If the circle and sprite are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -69038,21 +65868,8 @@ }, "parameters": { "collider": { - "type": "quad", - "description": "The quad which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { "type": "circle", - "description": "The circle which will not be altered", + "description": "The circle that is colliding", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69063,12 +65880,12 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the quad,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "sprite", + "description": "The sprite that is being collided with", "is_pointer": false, "is_const": true, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -69078,38 +65895,38 @@ } }, "attributes": { - "class": "quad", - "suffix": "between_quad_and_circle", + "class": "circle", + "suffix": "between_circle_and_sprite", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_quad_and_circle(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(quad &collider, const circle &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const circle &collider, const sprite collidee)" + ], + "python": [ + "def calculate_collision_direction_between_circle_and_sprite(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Quad collider, Circle collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Circle collider, Sprite collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Quad; const collidee: Circle; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Circle; collidee: Sprite): Vector2D" ] } }, { - "signature": "bool resolve_collision(quad &collider,const rectangle &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const circle &collider,const triangle &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_quad_and_rectangle", + "unique_global_name": "calculate_collision_direction_between_circle_and_triangle", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a quad and a rectangle by moving the\nquad to the edge of the rectangle. The direction of the\nresolution is determined by the `direction` parameter. If the quad and\nrectangle are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a circle\nand a triangle relative to the circle. If the circle and\ntriangle are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the quad and rectangle are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the circle,\nexpressed as a unit vector. If the circle and triangle are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -69117,21 +65934,8 @@ }, "parameters": { "collider": { - "type": "quad", - "description": "The quad which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { - "type": "rectangle", - "description": "The rectangle which will not be altered", + "type": "circle", + "description": "The circle that is colliding", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69142,9 +65946,9 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the quad,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "triangle", + "description": "The triangle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69157,38 +65961,38 @@ } }, "attributes": { - "class": "quad", - "suffix": "between_quad_and_rectangle", + "class": "circle", + "suffix": "between_circle_and_triangle", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_quad_and_rectangle(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(quad &collider, const rectangle &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const circle &collider, const triangle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_circle_and_triangle(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Quad collider, Rectangle collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Circle collider, Triangle collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Quad; const collidee: Rectangle; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Circle; const collidee: Triangle): Vector2D" ] } }, { - "signature": "bool resolve_collision(quad &collider,const sprite collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const quad &collider,const circle &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_quad_and_sprite", + "unique_global_name": "calculate_collision_direction_between_quad_and_circle", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a quad and a sprite by moving the\nquad to the edge of the sprite. The direction of the\nresolution is determined by the `direction` parameter. If the quad and\nsprite are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a quad\nand a circle relative to the quad. If the quad and\ncircle are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the quad and sprite are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the quad,\nexpressed as a unit vector. If the quad and circle are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -69197,9 +66001,9 @@ "parameters": { "collider": { "type": "quad", - "description": "The quad which will be altered if there is a collision", + "description": "The quad that is colliding", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -69209,21 +66013,8 @@ "type_parameter": null }, "collidee": { - "type": "sprite", - "description": "The sprite which will not be altered", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the quad,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "type": "circle", + "description": "The circle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69237,37 +66028,37 @@ }, "attributes": { "class": "quad", - "suffix": "between_quad_and_sprite", + "suffix": "between_quad_and_circle", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_quad_and_sprite(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(quad &collider, const sprite collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const quad &collider, const circle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_quad_and_circle(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Quad collider, Sprite collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Quad collider, Circle collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Quad; collidee: Sprite; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Quad; const collidee: Circle): Vector2D" ] } }, { - "signature": "bool resolve_collision(quad &collider,const triangle &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const quad &collider,const rectangle &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_quad_and_triangle", + "unique_global_name": "calculate_collision_direction_between_quad_and_rectangle", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a quad and a triangle by moving the\nquad to the edge of the triangle. The direction of the\nresolution is determined by the `direction` parameter. If the quad and\ntriangle are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a quad\nand a rectangle relative to the quad. If the quad and\nrectangle are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the quad and triangle are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the quad,\nexpressed as a unit vector. If the quad and rectangle are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -69276,20 +66067,7 @@ "parameters": { "collider": { "type": "quad", - "description": "The quad which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { - "type": "triangle", - "description": "The triangle which will not be altered", + "description": "The quad that is colliding", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69300,9 +66078,9 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the quad,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "rectangle", + "description": "The rectangle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69316,37 +66094,37 @@ }, "attributes": { "class": "quad", - "suffix": "between_quad_and_triangle", + "suffix": "between_quad_and_rectangle", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_quad_and_triangle(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(quad &collider, const triangle &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const quad &collider, const rectangle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_quad_and_rectangle(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Quad collider, Triangle collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Quad collider, Rectangle collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Quad; const collidee: Triangle; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Quad; const collidee: Rectangle): Vector2D" ] } }, { - "signature": "bool resolve_collision(rectangle &collider,const circle &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const quad &collider,const sprite collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_rectangle_and_circle", + "unique_global_name": "calculate_collision_direction_between_quad_and_sprite", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a rectangle and a circle by moving the\nrectangle to the edge of the circle. The direction of the\nresolution is determined by the `direction` parameter. If the rectangle and\ncircle are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a quad\nand a sprite relative to the quad. If the quad and\nsprite are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the rectangle and circle are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the quad,\nexpressed as a unit vector. If the quad and sprite are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -69354,21 +66132,8 @@ }, "parameters": { "collider": { - "type": "rectangle", - "description": "The rectangle which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { - "type": "circle", - "description": "The circle which will not be altered", + "type": "quad", + "description": "The quad that is colliding", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69379,12 +66144,12 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the rectangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "sprite", + "description": "The sprite that is being collided with", "is_pointer": false, "is_const": true, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -69394,38 +66159,38 @@ } }, "attributes": { - "class": "rectangle", - "suffix": "between_rectangle_and_circle", + "class": "quad", + "suffix": "between_quad_and_sprite", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_rectangle_and_circle(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(rectangle &collider, const circle &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const quad &collider, const sprite collidee)" + ], + "python": [ + "def calculate_collision_direction_between_quad_and_sprite(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Rectangle collider, Circle collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Quad collider, Sprite collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Rectangle; const collidee: Circle; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Quad; collidee: Sprite): Vector2D" ] } }, { - "signature": "bool resolve_collision(rectangle &collider,const quad &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const quad &collider,const triangle &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_rectangle_and_quad", + "unique_global_name": "calculate_collision_direction_between_quad_and_triangle", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a rectangle and a quad by moving the\nrectangle to the edge of the quad. The direction of the\nresolution is determined by the `direction` parameter. If the rectangle and\nquad are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a quad\nand a triangle relative to the quad. If the quad and\ntriangle are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the rectangle and quad are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the quad,\nexpressed as a unit vector. If the quad and triangle are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -69433,21 +66198,8 @@ }, "parameters": { "collider": { - "type": "rectangle", - "description": "The rectangle which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { "type": "quad", - "description": "The quad which will not be altered", + "description": "The quad that is colliding", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69458,9 +66210,9 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the rectangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "triangle", + "description": "The triangle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69473,38 +66225,38 @@ } }, "attributes": { - "class": "rectangle", - "suffix": "between_rectangle_and_quad", + "class": "quad", + "suffix": "between_quad_and_triangle", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_rectangle_and_quad(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(rectangle &collider, const quad &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const quad &collider, const triangle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_quad_and_triangle(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Rectangle collider, Quad collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Quad collider, Triangle collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Rectangle; const collidee: Quad; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Quad; const collidee: Triangle): Vector2D" ] } }, { - "signature": "bool resolve_collision(rectangle &collider,const rectangle &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const rectangle &collider,const circle &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_rectangles", + "unique_global_name": "calculate_collision_direction_between_rectangle_and_circle", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between two rectangles by moving the\ncollider rectangle to the edge of the collidee rectangle. The direction of the\nresolution is determined by the `direction` parameter. If the rectangles are not\ncolliding, this function will return false.", + "description": "Returns the direction of the collision between a rectangle\nand a circle relative to the rectangle. If the rectangle and\nsprite are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the rectangles are colliding and the collision was resolved,\nfalse if the rectangles are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the rectangle,\nexpressed as a unit vector. If the rectangle and circle are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -69513,20 +66265,7 @@ "parameters": { "collider": { "type": "rectangle", - "description": "The rectangle which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { - "type": "rectangle", - "description": "The rectangle which will not be altered", + "description": "The rectangle that is colliding", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69537,9 +66276,9 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the collider rectangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "circle", + "description": "The circle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69553,37 +66292,37 @@ }, "attributes": { "class": "rectangle", - "suffix": "between_rectangles", + "suffix": "between_rectangle_and_circle", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_rectangles(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(rectangle &collider, const rectangle &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const rectangle &collider, const circle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_rectangle_and_circle(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Rectangle collider, Rectangle collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Rectangle collider, Circle collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Rectangle; const collidee: Rectangle; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Rectangle; const collidee: Circle): Vector2D" ] } }, { - "signature": "bool resolve_collision(rectangle &collider,const sprite collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const rectangle &collider,const quad &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_rectangle_and_sprite", + "unique_global_name": "calculate_collision_direction_between_rectangle_and_quad", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a rectangle and a sprite by moving the\nrectangle to the edge of the sprite. The direction of the\nresolution is determined by the `direction` parameter. If the rectangle and\nsprite are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a rectangle\nand a quad relative to the rectangle. If the rectangle and\nsprite are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the rectangle and sprite are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the rectangle,\nexpressed as a unit vector. If the rectangle and quad are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -69592,9 +66331,9 @@ "parameters": { "collider": { "type": "rectangle", - "description": "The rectangle which will be altered if there is a collision", + "description": "The rectangle that is colliding", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -69604,21 +66343,8 @@ "type_parameter": null }, "collidee": { - "type": "sprite", - "description": "The sprite which will not be altered", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the rectangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "type": "quad", + "description": "The quad that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69632,37 +66358,37 @@ }, "attributes": { "class": "rectangle", - "suffix": "between_rectangle_and_sprite", + "suffix": "between_rectangle_and_quad", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_rectangle_and_sprite(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(rectangle &collider, const sprite collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const rectangle &collider, const quad &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_rectangle_and_quad(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Rectangle collider, Sprite collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Rectangle collider, Quad collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Rectangle; collidee: Sprite; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Rectangle; const collidee: Quad): Vector2D" ] } }, { - "signature": "bool resolve_collision(rectangle &collider,const triangle &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const rectangle &collider,const rectangle &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_rectangle_and_triangle", + "unique_global_name": "calculate_collision_direction_between_rectangles", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a rectangle and a triangle by moving the\nrectangle to the edge of the triangle. The direction of the\nresolution is determined by the `direction` parameter. If the rectangle and\ntriangle are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a collider rectangle\nand a collidee rectangle relative to the collider rectangle. If the rectangles are not\ncolliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the rectangle and triangle are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the collider rectangle,\nexpressed as a unit vector. If the rectangles are not colliding, this function\nwill return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -69671,20 +66397,7 @@ "parameters": { "collider": { "type": "rectangle", - "description": "The rectangle which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { - "type": "triangle", - "description": "The triangle which will not be altered", + "description": "The rectangle that is colliding", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69695,9 +66408,9 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the rectangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "rectangle", + "description": "The rectangle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69711,37 +66424,37 @@ }, "attributes": { "class": "rectangle", - "suffix": "between_rectangle_and_triangle", + "suffix": "between_rectangles", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_rectangle_and_triangle(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(rectangle &collider, const triangle &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const rectangle &collider, const rectangle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_rectangles(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Rectangle collider, Triangle collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Rectangle collider, Rectangle collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Rectangle; const collidee: Triangle; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Rectangle; const collidee: Rectangle): Vector2D" ] } }, { - "signature": "bool resolve_collision(sprite collider,const circle &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const rectangle &collider,const sprite collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_sprite_and_circle", + "unique_global_name": "calculate_collision_direction_between_rectangle_and_sprite", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a sprite and a circle by moving the\nsprite to the edge of the circle. The direction of the\nresolution is determined by the `direction` parameter. If the sprite and\ncircle are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a rectangle\nand a sprite relative to the rectangle. If the rectangle and\nsprite are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the sprite and circle are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the rectangle,\nexpressed as a unit vector. If the rectangle and sprite are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -69749,21 +66462,8 @@ }, "parameters": { "collider": { - "type": "sprite", - "description": "The sprite which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { - "type": "circle", - "description": "The circle which will not be altered", + "type": "rectangle", + "description": "The rectangle that is colliding", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69774,12 +66474,12 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the sprite,\nexpressed as a vector. If a zero vector is passed,\nthe function will not resolve the collision.", + "collidee": { + "type": "sprite", + "description": "The sprite that is being collided with", "is_pointer": false, "is_const": true, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -69789,38 +66489,38 @@ } }, "attributes": { - "class": "sprite", - "suffix": "between_sprite_and_circle", + "class": "rectangle", + "suffix": "between_rectangle_and_sprite", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_sprite_and_circle(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(sprite collider, const circle &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const rectangle &collider, const sprite collidee)" + ], + "python": [ + "def calculate_collision_direction_between_rectangle_and_sprite(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(Sprite collider, Circle collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Rectangle collider, Sprite collidee);" ], "pascal": [ - "function ResolveCollision(collider: Sprite; const collidee: Circle; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Rectangle; collidee: Sprite): Vector2D" ] } }, { - "signature": "bool resolve_collision(sprite collider,const quad &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const rectangle &collider,const triangle &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_sprite_and_quad", + "unique_global_name": "calculate_collision_direction_between_rectangle_and_triangle", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a sprite and a quad by moving the\nsprite to the edge of the quad. The direction of the\nresolution is determined by the `direction` parameter. If the sprite and\nquad are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a rectangle\nand a triangle relative to the rectangle. If the rectangle and\nsprite are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the sprite and quad are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the rectangle,\nexpressed as a unit vector. If the rectangle and triangle are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -69828,21 +66528,8 @@ }, "parameters": { "collider": { - "type": "sprite", - "description": "The sprite which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { - "type": "quad", - "description": "The quad which will not be altered", + "type": "rectangle", + "description": "The rectangle that is colliding", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69853,9 +66540,9 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the sprite,\nexpressed as a vector. If a zero vector is passed,\nthe function will not resolve the collision.", + "collidee": { + "type": "triangle", + "description": "The triangle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69868,38 +66555,38 @@ } }, "attributes": { - "class": "sprite", - "suffix": "between_sprite_and_quad", + "class": "rectangle", + "suffix": "between_rectangle_and_triangle", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_sprite_and_quad(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(sprite collider, const quad &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const rectangle &collider, const triangle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_rectangle_and_triangle(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(Sprite collider, Quad collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Rectangle collider, Triangle collidee);" ], "pascal": [ - "function ResolveCollision(collider: Sprite; const collidee: Quad; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Rectangle; const collidee: Triangle): Vector2D" ] } }, { - "signature": "bool resolve_collision(sprite collider,const rectangle &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const sprite collider,const circle &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_sprite_and_rectangle", + "unique_global_name": "calculate_collision_direction_between_sprite_and_circle", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a sprite and a rectangle by moving the\nsprite to the edge of the rectangle. The direction of the\nresolution is determined by the `direction` parameter. If the sprite and\nrectangle are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a sprite\nand a circle relative to the sprite. If the sprite and\ncircle are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the sprite and rectangle are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the sprite,\nexpressed as a unit vector. If the sprite and circle are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -69908,9 +66595,9 @@ "parameters": { "collider": { "type": "sprite", - "description": "The sprite which will be altered if there is a collision", + "description": "The sprite that is colliding", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -69920,21 +66607,8 @@ "type_parameter": null }, "collidee": { - "type": "rectangle", - "description": "The rectangle which will not be altered", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the sprite,\nexpressed as a vector. If a zero vector is passed,\nthe function will not resolve the collision.", + "type": "circle", + "description": "The circle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -69948,37 +66622,37 @@ }, "attributes": { "class": "sprite", - "suffix": "between_sprite_and_rectangle", + "suffix": "between_sprite_and_circle", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_sprite_and_rectangle(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(sprite collider, const rectangle &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const sprite collider, const circle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_sprite_and_circle(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(Sprite collider, Rectangle collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Sprite collider, Circle collidee);" ], "pascal": [ - "function ResolveCollision(collider: Sprite; const collidee: Rectangle; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(collider: Sprite; const collidee: Circle): Vector2D" ] } }, { - "signature": "bool resolve_collision(sprite collider,const sprite collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const sprite collider,const quad &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_sprites", + "unique_global_name": "calculate_collision_direction_between_sprite_and_quad", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between two sprites by moving the\ncollider sprite to the edge of the collidee sprite. The direction of the\nresolution is determined by the `direction` parameter. If the sprites are not\ncolliding, this function will return false.", + "description": "Returns the direction of the collision between a sprite\nand a quad relative to the sprite. If the sprite and\nquad are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the sprites are colliding and the collision was resolved,\nfalse if the sprites are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the sprite,\nexpressed as a unit vector. If the sprite and quad are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -69987,20 +66661,7 @@ "parameters": { "collider": { "type": "sprite", - "description": "The sprite which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { - "type": "sprite", - "description": "The sprite which will not be altered", + "description": "The sprite that is colliding", "is_pointer": false, "is_const": true, "is_reference": false, @@ -70011,9 +66672,9 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the collider sprite,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "quad", + "description": "The quad that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -70027,37 +66688,37 @@ }, "attributes": { "class": "sprite", - "suffix": "between_sprites", + "suffix": "between_sprite_and_quad", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_sprites(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(sprite collider, const sprite collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const sprite collider, const quad &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_sprite_and_quad(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(Sprite collider, Sprite collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Sprite collider, Quad collidee);" ], "pascal": [ - "function ResolveCollision(collider: Sprite; collidee: Sprite; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(collider: Sprite; const collidee: Quad): Vector2D" ] } }, { - "signature": "bool resolve_collision(sprite collider,const triangle &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const sprite collider,const rectangle &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_sprite_and_triangle", + "unique_global_name": "calculate_collision_direction_between_sprite_and_rectangle", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a sprite and a triangle by moving the\nsprite to the edge of the triangle. The direction of the\nresolution is determined by the `direction` parameter. If the sprite and\ntriangle are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a sprite\nand a rectangle relative to the sprite. If the sprite and\nrectangle are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the sprite and triangle are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the sprite,\nexpressed as a unit vector. If the sprite and rectangle are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -70066,9 +66727,9 @@ "parameters": { "collider": { "type": "sprite", - "description": "The sprite which will be altered if there is a collision", + "description": "The sprite that is colliding", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -70078,21 +66739,8 @@ "type_parameter": null }, "collidee": { - "type": "triangle", - "description": "The triangle which will not be altered", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the sprite,\nexpressed as a vector. If a zero vector is passed,\nthe function will not resolve the collision.", + "type": "rectangle", + "description": "The rectangle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -70106,37 +66754,37 @@ }, "attributes": { "class": "sprite", - "suffix": "between_sprite_and_triangle", + "suffix": "between_sprite_and_rectangle", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_sprite_and_triangle(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(sprite collider, const triangle &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const sprite collider, const rectangle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_sprite_and_rectangle(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(Sprite collider, Triangle collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Sprite collider, Rectangle collidee);" ], "pascal": [ - "function ResolveCollision(collider: Sprite; const collidee: Triangle; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(collider: Sprite; const collidee: Rectangle): Vector2D" ] } }, { - "signature": "bool resolve_collision(triangle &collider,const circle &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const sprite collider,const sprite collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_triangle_and_circle", + "unique_global_name": "calculate_collision_direction_between_sprites", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a triangle and a circle by moving the\ntriangle to the edge of the circle. The direction of the\nresolution is determined by the `direction` parameter. If the triangle and\ncircle are not colliding, this function will return false.", + "description": "Returns the direction of the collision between two sprites\nrelative to the collider sprite. If the sprites are not colliding,\nthis function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the triangle and circle are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the collider sprite,\nexpressed as a unit vector. If the sprites are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -70144,24 +66792,11 @@ }, "parameters": { "collider": { - "type": "triangle", - "description": "The triangle which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { - "type": "circle", - "description": "The circle which will not be altered", + "type": "sprite", + "description": "The sprite that is colliding", "is_pointer": false, "is_const": true, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -70169,12 +66804,12 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the triangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "sprite", + "description": "The sprite that is being collided with", "is_pointer": false, "is_const": true, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -70184,38 +66819,38 @@ } }, "attributes": { - "class": "triangle", - "suffix": "between_triangle_and_circle", + "class": "sprite", + "suffix": "between_sprites", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_triangle_and_circle(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(triangle &collider, const circle &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const sprite collider, const sprite collidee)" + ], + "python": [ + "def calculate_collision_direction_between_sprites(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Triangle collider, Circle collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Sprite collider, Sprite collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Triangle; const collidee: Circle; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(collider: Sprite; collidee: Sprite): Vector2D" ] } }, { - "signature": "bool resolve_collision(triangle &collider,const quad &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const sprite collider,const triangle &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_triangle_and_quad", + "unique_global_name": "calculate_collision_direction_between_sprite_and_triangle", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a triangle and a quad by moving the\ntriangle to the edge of the quad. The direction of the\nresolution is determined by the `direction` parameter. If the triangle and\nquad are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a sprite\nand a triangle relative to the sprite. If the sprite and\ntriangle are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the triangle and quad are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the sprite,\nexpressed as a unit vector. If the sprite and triangle are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -70223,24 +66858,11 @@ }, "parameters": { "collider": { - "type": "triangle", - "description": "The triangle which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { - "type": "quad", - "description": "The quad which will not be altered", + "type": "sprite", + "description": "The sprite that is colliding", "is_pointer": false, "is_const": true, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -70248,9 +66870,9 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the triangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "triangle", + "description": "The triangle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -70263,38 +66885,38 @@ } }, "attributes": { - "class": "triangle", - "suffix": "between_triangle_and_quad", + "class": "sprite", + "suffix": "between_sprite_and_triangle", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_triangle_and_quad(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(triangle &collider, const quad &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const sprite collider, const triangle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_sprite_and_triangle(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Triangle collider, Quad collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Sprite collider, Triangle collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Triangle; const collidee: Quad; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(collider: Sprite; const collidee: Triangle): Vector2D" ] } }, { - "signature": "bool resolve_collision(triangle &collider,const rectangle &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const triangle &collider,const circle &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_triangle_and_rectangle", + "unique_global_name": "calculate_collision_direction_between_triangle_and_circle", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a triangle and a rectangle by moving the\ntriangle to the edge of the rectangle. The direction of the\nresolution is determined by the `direction` parameter. If the triangle and\nrectangle are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a triangle\nand a circle relative to the triangle. If the triangle and\ncircle are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the triangle and rectangle are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the triangle,\nexpressed as a unit vector. If the triangle and circle are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -70303,20 +66925,7 @@ "parameters": { "collider": { "type": "triangle", - "description": "The triangle which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { - "type": "rectangle", - "description": "The rectangle which will not be altered", + "description": "The triangle that is colliding", "is_pointer": false, "is_const": true, "is_reference": true, @@ -70327,9 +66936,9 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the triangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "circle", + "description": "The circle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -70343,37 +66952,37 @@ }, "attributes": { "class": "triangle", - "suffix": "between_triangle_and_rectangle", + "suffix": "between_triangle_and_circle", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_triangle_and_rectangle(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(triangle &collider, const rectangle &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const triangle &collider, const circle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_triangle_and_circle(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Triangle collider, Rectangle collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Triangle collider, Circle collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Triangle; const collidee: Rectangle; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Triangle; const collidee: Circle): Vector2D" ] } }, { - "signature": "bool resolve_collision(triangle &collider,const sprite collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const triangle &collider,const quad &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_triangle_and_sprite", + "unique_global_name": "calculate_collision_direction_between_triangle_and_quad", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a triangle and a sprite by moving the\ntriangle to the edge of the sprite. The direction of the\nresolution is determined by the `direction` parameter. If the triangle and\nsprite are not colliding, this function will return false.", + "description": "Returns the direction of the collision between a triangle\nand a quad relative to the triangle. If the triangle and\nquad are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the triangle and sprite are colliding and the collision\nwas resolved, false if they are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the triangle,\nexpressed as a unit vector. If the triangle and quad are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -70382,9 +66991,9 @@ "parameters": { "collider": { "type": "triangle", - "description": "The triangle which will be altered if there is a collision", + "description": "The triangle that is colliding", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -70394,21 +67003,8 @@ "type_parameter": null }, "collidee": { - "type": "sprite", - "description": "The sprite which will not be altered", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the triangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "type": "quad", + "description": "The quad that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -70422,37 +67018,37 @@ }, "attributes": { "class": "triangle", - "suffix": "between_triangle_and_sprite", + "suffix": "between_triangle_and_quad", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_triangle_and_sprite(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(triangle &collider, const sprite collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const triangle &collider, const quad &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_triangle_and_quad(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Triangle collider, Sprite collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Triangle collider, Quad collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Triangle; collidee: Sprite; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Triangle; const collidee: Quad): Vector2D" ] } }, { - "signature": "bool resolve_collision(triangle &collider,const triangle &collidee,const vector_2d &direction);", - "name": "resolve_collision", + "signature": "vector_2d calculate_collision_direction(const triangle &collider,const rectangle &collidee);", + "name": "calculate_collision_direction", "method_name": null, - "unique_global_name": "resolve_collision_between_triangles", + "unique_global_name": "calculate_collision_direction_between_triangle_and_rectangle", "unique_method_name": null, "suffix_name": null, - "description": "Resolves the collision between a collider triangle and a collidee triangle by moving the\ncollider triangle to the edge of the collidee triangle. The direction of the\nresolution is determined by the `direction` parameter. If the triangles are not\ncolliding, this function will return false.", + "description": "Returns the direction of the collision between a triangle\nand a rectangle relative to the triangle. If the triangle and\nrectangle are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the triangles are colliding and the collision was resolved,\nfalse if the triangles are not colliding", + "type": "vector_2d", + "description": "The direction of the collision relative to the triangle,\nexpressed as a unit vector. If the triangle and rectangle are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -70461,20 +67057,7 @@ "parameters": { "collider": { "type": "triangle", - "description": "The triangle which will be altered if there is a collision", - "is_pointer": false, - "is_const": false, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "collidee": { - "type": "triangle", - "description": "The triangle which will not be altered", + "description": "The triangle that is colliding", "is_pointer": false, "is_const": true, "is_reference": true, @@ -70485,9 +67068,9 @@ "is_vector": false, "type_parameter": null }, - "direction": { - "type": "vector_2d", - "description": "The direction of the collision relative to the collider triangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "collidee": { + "type": "rectangle", + "description": "The rectangle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -70501,75 +67084,49 @@ }, "attributes": { "class": "triangle", - "suffix": "between_triangles", + "suffix": "between_triangle_and_rectangle", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def resolve_collision_between_triangles(collider, collidee, direction):" - ], "cpp": [ - "bool resolve_collision(triangle &collider, const triangle &collidee, const vector_2d &direction)" + "vector_2d calculate_collision_direction(const triangle &collider, const rectangle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_triangle_and_rectangle(collider, collidee):" ], "csharp": [ - "public static bool SplashKit.ResolveCollision(ref Triangle collider, Triangle collidee, Vector2D direction);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Triangle collider, Rectangle collidee);" ], "pascal": [ - "function ResolveCollision(var collider: Triangle; const collidee: Triangle; const direction: Vector2D): Boolean" + "function CalculateCollisionDirection(const collider: Triangle; const collidee: Rectangle): Vector2D" ] } }, { - "signature": "bool sprite_bitmap_collision(sprite s,bitmap bmp,double x,double y);", - "name": "sprite_bitmap_collision", - "method_name": "bitmap_collision", - "unique_global_name": "sprite_bitmap_collision", - "unique_method_name": "sprite.bitmap_collision", + "signature": "vector_2d calculate_collision_direction(const triangle &collider,const sprite collidee);", + "name": "calculate_collision_direction", + "method_name": null, + "unique_global_name": "calculate_collision_direction_between_triangle_and_sprite", + "unique_method_name": null, "suffix_name": null, - "description": "Tests if a sprite will collide with a bitmap drawn at the indicated\nlocation.", + "description": "Returns the direction of the collision between a triangle\nand a sprite relative to the triangle. If the triangle and\nsprite are not colliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the sprite collides with the bitmap when drawn\nat the indicated location.", + "type": "vector_2d", + "description": "The direction of the collision relative to the triangle,\nexpressed as a unit vector. If the triangle and sprite are not colliding,\nthis function will return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "s": { - "type": "sprite", - "description": "The sprite to test", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "bmp": { - "type": "bitmap", - "description": "The bitmap to test", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "x": { - "type": "double", - "description": "The x location where the bitmap is drawn", + "collider": { + "type": "triangle", + "description": "The triangle that is colliding", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -70577,11 +67134,11 @@ "is_vector": false, "type_parameter": null }, - "y": { - "type": "double", - "description": "The y location where the bitmap is drawn", + "collidee": { + "type": "sprite", + "description": "The sprite that is being collided with", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -70592,78 +67149,50 @@ } }, "attributes": { - "class": "sprite", - "method": "bitmap_collision", + "class": "triangle", + "suffix": "between_triangle_and_sprite", "group": "physics", - "static": "collisions", - "self": "s" + "static": "collisions" }, "signatures": { - "python": [ - "def sprite_bitmap_collision(s, bmp, x, y):" - ], "cpp": [ - "bool sprite_bitmap_collision(sprite s, bitmap bmp, double x, double y)" + "vector_2d calculate_collision_direction(const triangle &collider, const sprite collidee)" + ], + "python": [ + "def calculate_collision_direction_between_triangle_and_sprite(collider, collidee):" ], "csharp": [ - "public bool Sprite.BitmapCollision(Bitmap bmp, double x, double y);", - "public static bool SplashKit.SpriteBitmapCollision(Sprite s, Bitmap bmp, double x, double y);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Triangle collider, Sprite collidee);" ], "pascal": [ - "function SpriteBitmapCollision(s: Sprite; bmp: Bitmap; x: Double; y: Double): Boolean" + "function CalculateCollisionDirection(const collider: Triangle; collidee: Sprite): Vector2D" ] } }, { - "signature": "bool sprite_bitmap_collision(sprite s,bitmap bmp,int cell,const point_2d &pt);", - "name": "sprite_bitmap_collision", - "method_name": "bitmap_collision", - "unique_global_name": "sprite_bitmap_collision_with_cell_at_point", - "unique_method_name": "sprite.bitmap_collision_with_cell_at_point", + "signature": "vector_2d calculate_collision_direction(const triangle &collider,const triangle &collidee);", + "name": "calculate_collision_direction", + "method_name": null, + "unique_global_name": "calculate_collision_direction_between_triangles", + "unique_method_name": null, "suffix_name": null, - "description": "Tests if a sprite will collide with a bitmap drawn at the indicated\nlocation.", + "description": "Returns the direction of the collision between a collider triangle\nand a collidee triangle relative to the collider triangle. If the triangles are not\ncolliding, this function will return a zero vector.", "brief": null, "return": { - "type": "bool", - "description": "True if the sprite collides with the bitmap cell when drawn\nat the indicated location.", + "type": "vector_2d", + "description": "The direction of the collision relative to the collider triangle,\nexpressed as a unit vector. If the triangles are not colliding, this function\nwill return a zero vector.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "s": { - "type": "sprite", - "description": "The sprite to test", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "bmp": { - "type": "bitmap", - "description": "The bitmap to test", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "cell": { - "type": "int", - "description": "The cell of the bitmap to check", + "collider": { + "type": "triangle", + "description": "The triangle that is colliding", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -70671,9 +67200,9 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The point where the bitmap is drawn", + "collidee": { + "type": "triangle", + "description": "The triangle that is being collided with", "is_pointer": false, "is_const": true, "is_reference": true, @@ -70686,79 +67215,50 @@ } }, "attributes": { - "class": "sprite", - "method": "bitmap_collision", - "suffix": "with_cell_at_point", + "class": "triangle", + "suffix": "between_triangles", "group": "physics", - "static": "collisions", - "self": "s" + "static": "collisions" }, "signatures": { - "python": [ - "def sprite_bitmap_collision_with_cell_at_point(s, bmp, cell, pt):" - ], "cpp": [ - "bool sprite_bitmap_collision(sprite s, bitmap bmp, int cell, const point_2d &pt)" + "vector_2d calculate_collision_direction(const triangle &collider, const triangle &collidee)" + ], + "python": [ + "def calculate_collision_direction_between_triangles(collider, collidee):" ], "csharp": [ - "public bool Sprite.BitmapCollision(Bitmap bmp, int cell, Point2D pt);", - "public static bool SplashKit.SpriteBitmapCollision(Sprite s, Bitmap bmp, int cell, Point2D pt);" + "public static Vector2D SplashKit.CalculateCollisionDirection(Triangle collider, Triangle collidee);" ], "pascal": [ - "function SpriteBitmapCollision(s: Sprite; bmp: Bitmap; cell: Integer; const pt: Point2D): Boolean" + "function CalculateCollisionDirection(const collider: Triangle; const collidee: Triangle): Vector2D" ] } }, { - "signature": "bool sprite_bitmap_collision(sprite s,bitmap bmp,int cell,double x,double y);", - "name": "sprite_bitmap_collision", - "method_name": "bitmap_collision", - "unique_global_name": "sprite_bitmap_collision_with_cell", - "unique_method_name": "sprite.bitmap_collision_with_cell", + "signature": "bool resolve_collision(quad &collider,const quad &collidee,const vector_2d &direction);", + "name": "resolve_collision", + "method_name": null, + "unique_global_name": "resolve_collision_between_quads", + "unique_method_name": null, "suffix_name": null, - "description": "Tests if a sprite will collide with a bitmap drawn at the indicated\nlocation.", + "description": "Resolves the collision between a collider quad and a collidee quad by moving the\ncollider quad to the edge of the collidee quad. The direction of the\nresolution is determined by the `direction` parameter. If the quads are not\ncolliding, this function will return false.", "brief": null, "return": { "type": "bool", - "description": "True if the sprite collides with the bitmap cell when drawn\nat the indicated location.", + "description": "True if the quads are colliding and the collision was resolved,\nfalse if the quads are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "s": { - "type": "sprite", - "description": "The sprite to test", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "bmp": { - "type": "bitmap", - "description": "The bitmap to test", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "cell": { - "type": "int", - "description": "The cell of the bitmap to check", + "collider": { + "type": "quad", + "description": "The quad which will be altered if there is a collision", "is_pointer": false, "is_const": false, - "is_reference": false, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -70766,12 +67266,12 @@ "is_vector": false, "type_parameter": null }, - "x": { - "type": "double", - "description": "The x location where the bitmap is drawn", + "collidee": { + "type": "quad", + "description": "The quad which will not be altered", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -70779,12 +67279,12 @@ "is_vector": false, "type_parameter": null }, - "y": { - "type": "double", - "description": "The y location where the bitmap is drawn", + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the collider quad,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -70794,53 +67294,50 @@ } }, "attributes": { - "class": "sprite", - "method": "bitmap_collision", - "suffix": "with_cell", + "class": "quad", + "suffix": "between_quads", "group": "physics", - "static": "collisions", - "self": "s" + "static": "collisions" }, "signatures": { - "python": [ - "def sprite_bitmap_collision_with_cell(s, bmp, cell, x, y):" - ], "cpp": [ - "bool sprite_bitmap_collision(sprite s, bitmap bmp, int cell, double x, double y)" + "bool resolve_collision(quad &collider, const quad &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_quads(collider, collidee, direction):" ], "csharp": [ - "public bool Sprite.BitmapCollision(Bitmap bmp, int cell, double x, double y);", - "public static bool SplashKit.SpriteBitmapCollision(Sprite s, Bitmap bmp, int cell, double x, double y);" + "public static bool SplashKit.ResolveCollision(ref Quad collider, Quad collidee, Vector2D direction);" ], "pascal": [ - "function SpriteBitmapCollision(s: Sprite; bmp: Bitmap; cell: Integer; x: Double; y: Double): Boolean" + "function ResolveCollision(var collider: Quad; const collidee: Quad; const direction: Vector2D): Boolean" ] } }, { - "signature": "bool sprite_circle_collision(sprite s,const circle &c);", - "name": "sprite_circle_collision", - "method_name": "circle_collision", - "unique_global_name": "sprite_circle_collision", - "unique_method_name": "sprite.circle_collision", + "signature": "bool resolve_collision(circle &collider,const circle &collidee,const vector_2d &direction);", + "name": "resolve_collision", + "method_name": null, + "unique_global_name": "resolve_collision_between_circles", + "unique_method_name": null, "suffix_name": null, - "description": "Tests if a sprite is drawn within an given area (circle).", + "description": "Resolves the collision between a collider circle and a collidee circle by moving the\ncollider circle to the edge of the collidee circle. The direction of the\nresolution is determined by the `direction` parameter. If the circles are not\ncolliding, this function will return false.", "brief": null, "return": { "type": "bool", - "description": "True if the sprite it drawn in the circle area", + "description": "True if the circles are colliding and the collision was resolved,\nfalse if the circles are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "s": { - "type": "sprite", - "description": "The sprite to test", + "collider": { + "type": "circle", + "description": "The circle which will be altered if there is a collision", "is_pointer": false, "is_const": false, - "is_reference": false, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -70848,9 +67345,22 @@ "is_vector": false, "type_parameter": null }, - "c": { + "collidee": { "type": "circle", - "description": "The circle to check", + "description": "The circle which will not be altered", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the collider circle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -70863,52 +67373,50 @@ } }, "attributes": { - "class": "sprite", - "method": "circle_collision", + "class": "circle", + "suffix": "between_circles", "group": "physics", - "static": "collisions", - "self": "s" + "static": "collisions" }, "signatures": { - "python": [ - "def sprite_circle_collision(s, c):" - ], "cpp": [ - "bool sprite_circle_collision(sprite s, const circle &c)" + "bool resolve_collision(circle &collider, const circle &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_circles(collider, collidee, direction):" ], "csharp": [ - "public bool Sprite.CircleCollision(Circle c);", - "public static bool SplashKit.SpriteCircleCollision(Sprite s, Circle c);" + "public static bool SplashKit.ResolveCollision(ref Circle collider, Circle collidee, Vector2D direction);" ], "pascal": [ - "function SpriteCircleCollision(s: Sprite; const c: Circle): Boolean" + "function ResolveCollision(var collider: Circle; const collidee: Circle; const direction: Vector2D): Boolean" ] } }, { - "signature": "bool sprite_collision(sprite s1,sprite s2);", - "name": "sprite_collision", - "method_name": "sprite_collision", - "unique_global_name": "sprite_collision", - "unique_method_name": "sprite.sprite_collision", + "signature": "bool resolve_collision(circle &collider,const quad &collidee,const vector_2d &direction);", + "name": "resolve_collision", + "method_name": null, + "unique_global_name": "resolve_collision_between_circle_and_quad", + "unique_method_name": null, "suffix_name": null, - "description": "Tests if two given sprites `s1` and `s2` are collided", + "description": "Resolves the collision between a circle and a quad by moving the\ncircle to the edge of the quad. The direction of the\nresolution is determined by the `direction` parameter. If the circle and\nquad are not colliding, this function will return false.", "brief": null, "return": { "type": "bool", - "description": "return `true` if both `s1` and `s2` are colliding, false otherwise.", + "description": "True if the circle and quad are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "s1": { - "type": "sprite", - "description": "the first `sprite` to test", + "collider": { + "type": "circle", + "description": "The circle which will be altered if there is a collision", "is_pointer": false, "is_const": false, - "is_reference": false, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -70916,12 +67424,25 @@ "is_vector": false, "type_parameter": null }, - "s2": { - "type": "sprite", - "description": "the second `sprite` to test", + "collidee": { + "type": "quad", + "description": "The quad which will not be altered", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the circle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -70931,52 +67452,50 @@ } }, "attributes": { - "class": "sprite", - "method": "sprite_collision", - "self": "s1", + "class": "circle", + "suffix": "between_circle_and_quad", "group": "physics", "static": "collisions" }, "signatures": { - "python": [ - "def sprite_collision(s1, s2):" - ], "cpp": [ - "bool sprite_collision(sprite s1, sprite s2)" + "bool resolve_collision(circle &collider, const quad &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_circle_and_quad(collider, collidee, direction):" ], "csharp": [ - "public bool Sprite.SpriteCollision(Sprite s2);", - "public static bool SplashKit.SpriteCollision(Sprite s1, Sprite s2);" + "public static bool SplashKit.ResolveCollision(ref Circle collider, Quad collidee, Vector2D direction);" ], "pascal": [ - "function SpriteCollision(s1: Sprite; s2: Sprite): Boolean" + "function ResolveCollision(var collider: Circle; const collidee: Quad; const direction: Vector2D): Boolean" ] } }, { - "signature": "bool sprite_point_collision(sprite s,const point_2d &pt);", - "name": "sprite_point_collision", - "method_name": "point_collision", - "unique_global_name": "sprite_point_collision", - "unique_method_name": "sprite.point_collision", + "signature": "bool resolve_collision(circle &collider,const rectangle &collidee,const vector_2d &direction);", + "name": "resolve_collision", + "method_name": null, + "unique_global_name": "resolve_collision_between_circle_and_rectangle", + "unique_method_name": null, "suffix_name": null, - "description": "Tests if a sprite is drawn at a given point.", + "description": "Resolves the collision between a circle and a rectangle by moving the\ncircle to the edge of the rectangle. The direction of the\nresolution is determined by the `direction` parameter. If the circle and\nrectangle are not colliding, this function will return false.", "brief": null, "return": { "type": "bool", - "description": "True if the sprite it drawn at the indicated point", + "description": "True if the circle and rectangle are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "s": { - "type": "sprite", - "description": "The sprite to test", + "collider": { + "type": "circle", + "description": "The circle which will be altered if there is a collision", "is_pointer": false, "is_const": false, - "is_reference": false, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -70984,9 +67503,22 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The point to check", + "collidee": { + "type": "rectangle", + "description": "The rectangle which will not be altered", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the circle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -70999,51 +67531,62 @@ } }, "attributes": { - "class": "sprite", - "method": "point_collision", + "class": "circle", + "suffix": "between_circle_and_rectangle", "group": "physics", - "static": "collisions", - "self": "s" + "static": "collisions" }, "signatures": { - "python": [ - "def sprite_point_collision(s, pt):" - ], "cpp": [ - "bool sprite_point_collision(sprite s, const point_2d &pt)" + "bool resolve_collision(circle &collider, const rectangle &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_circle_and_rectangle(collider, collidee, direction):" ], "csharp": [ - "public bool Sprite.PointCollision(Point2D pt);", - "public static bool SplashKit.SpritePointCollision(Sprite s, Point2D pt);" + "public static bool SplashKit.ResolveCollision(ref Circle collider, Rectangle collidee, Vector2D direction);" ], "pascal": [ - "function SpritePointCollision(s: Sprite; const pt: Point2D): Boolean" + "function ResolveCollision(var collider: Circle; const collidee: Rectangle; const direction: Vector2D): Boolean" ] } }, { - "signature": "bool sprite_quad_collision(sprite s,const quad &q);", - "name": "sprite_quad_collision", - "method_name": "quad_collision", - "unique_global_name": "sprite_quad_collision", - "unique_method_name": "sprite.quad_collision", + "signature": "bool resolve_collision(circle &collider,const sprite collidee,const vector_2d &direction);", + "name": "resolve_collision", + "method_name": null, + "unique_global_name": "resolve_collision_between_circle_and_sprite", + "unique_method_name": null, "suffix_name": null, - "description": "Tests if a sprite is drawn within an given area (quad).", + "description": "Resolves the collision between a circle and a sprite by moving the\ncircle to the edge of the sprite. The direction of the\nresolution is determined by the `direction` parameter. If the circle and\nsprite are not colliding, this function will return false.", "brief": null, "return": { "type": "bool", - "description": "True if the sprite it drawn in the quad area", + "description": "True if the circle and sprite are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "s": { - "type": "sprite", - "description": "The sprite to test", + "collider": { + "type": "circle", + "description": "The circle which will be altered if there is a collision", "is_pointer": false, "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "collidee": { + "type": "sprite", + "description": "The sprite which will not be altered", + "is_pointer": false, + "is_const": true, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -71052,9 +67595,9 @@ "is_vector": false, "type_parameter": null }, - "q": { - "type": "quad", - "description": "The quad to check", + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the circle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -71067,52 +67610,50 @@ } }, "attributes": { - "class": "sprite", - "method": "quad_collision", + "class": "circle", + "suffix": "between_circle_and_sprite", "group": "physics", - "static": "collisions", - "self": "s" + "static": "collisions" }, "signatures": { - "python": [ - "def sprite_quad_collision(s, q):" - ], "cpp": [ - "bool sprite_quad_collision(sprite s, const quad &q)" + "bool resolve_collision(circle &collider, const sprite collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_circle_and_sprite(collider, collidee, direction):" ], "csharp": [ - "public bool Sprite.QuadCollision(Quad q);", - "public static bool SplashKit.SpriteQuadCollision(Sprite s, Quad q);" + "public static bool SplashKit.ResolveCollision(ref Circle collider, Sprite collidee, Vector2D direction);" ], "pascal": [ - "function SpriteQuadCollision(s: Sprite; const q: Quad): Boolean" + "function ResolveCollision(var collider: Circle; collidee: Sprite; const direction: Vector2D): Boolean" ] } }, { - "signature": "bool sprite_ray_collision(sprite s,const point_2d &origin,const vector_2d &heading);", - "name": "sprite_ray_collision", - "method_name": "ray_collision", - "unique_global_name": "sprite_ray_collision", - "unique_method_name": "sprite.ray_collision", + "signature": "bool resolve_collision(circle &collider,const triangle &collidee,const vector_2d &direction);", + "name": "resolve_collision", + "method_name": null, + "unique_global_name": "resolve_collision_between_circle_and_triangle", + "unique_method_name": null, "suffix_name": null, - "description": "Tests if a sprite is drawn along a given ray.", + "description": "Resolves the collision between a circle and a triangle by moving the\ncircle to the edge of the triangle. The direction of the\nresolution is determined by the `direction` parameter. If the circle and\ntriangle are not colliding, this function will return false.", "brief": null, "return": { "type": "bool", - "description": "True if the sprite is drawn along the ray", + "description": "True if the circle and triangle are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "s": { - "type": "sprite", - "description": "The sprite to test", + "collider": { + "type": "circle", + "description": "The circle which will be altered if there is a collision", "is_pointer": false, "is_const": false, - "is_reference": false, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -71120,9 +67661,9 @@ "is_vector": false, "type_parameter": null }, - "origin": { - "type": "point_2d", - "description": "The origin of the ray", + "collidee": { + "type": "triangle", + "description": "The triangle which will not be altered", "is_pointer": false, "is_const": true, "is_reference": true, @@ -71133,9 +67674,9 @@ "is_vector": false, "type_parameter": null }, - "heading": { + "direction": { "type": "vector_2d", - "description": "The heading of the ray", + "description": "The direction of the collision relative to the circle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -71148,52 +67689,50 @@ } }, "attributes": { - "class": "sprite", - "method": "ray_collision", + "class": "circle", + "suffix": "between_circle_and_triangle", "group": "physics", - "static": "collisions", - "self": "s" + "static": "collisions" }, "signatures": { - "python": [ - "def sprite_ray_collision(s, origin, heading):" - ], "cpp": [ - "bool sprite_ray_collision(sprite s, const point_2d &origin, const vector_2d &heading)" + "bool resolve_collision(circle &collider, const triangle &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_circle_and_triangle(collider, collidee, direction):" ], "csharp": [ - "public bool Sprite.RayCollision(Point2D origin, Vector2D heading);", - "public static bool SplashKit.SpriteRayCollision(Sprite s, Point2D origin, Vector2D heading);" + "public static bool SplashKit.ResolveCollision(ref Circle collider, Triangle collidee, Vector2D direction);" ], "pascal": [ - "function SpriteRayCollision(s: Sprite; const origin: Point2D; const heading: Vector2D): Boolean" + "function ResolveCollision(var collider: Circle; const collidee: Triangle; const direction: Vector2D): Boolean" ] } }, { - "signature": "bool sprite_rectangle_collision(sprite s,const rectangle &rect);", - "name": "sprite_rectangle_collision", - "method_name": "rectangle_collision", - "unique_global_name": "sprite_rectangle_collision", - "unique_method_name": "sprite.rectangle_collision", + "signature": "bool resolve_collision(quad &collider,const circle &collidee,const vector_2d &direction);", + "name": "resolve_collision", + "method_name": null, + "unique_global_name": "resolve_collision_between_quad_and_circle", + "unique_method_name": null, "suffix_name": null, - "description": "Tests if a sprite is drawn within an given area (rectangle).", + "description": "Resolves the collision between a quad and a circle by moving the\nquad to the edge of the circle. The direction of the\nresolution is determined by the `direction` parameter. If the quad and\ncircle are not colliding, this function will return false.", "brief": null, "return": { "type": "bool", - "description": "True if the sprite it drawn in the rectangle area", + "description": "True if the quad and circle are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "s": { - "type": "sprite", - "description": "The sprite to test", + "collider": { + "type": "quad", + "description": "The quad which will be altered if there is a collision", "is_pointer": false, "is_const": false, - "is_reference": false, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -71201,9 +67740,22 @@ "is_vector": false, "type_parameter": null }, - "rect": { - "type": "rectangle", - "description": "The rectangle to check", + "collidee": { + "type": "circle", + "description": "The circle which will not be altered", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the quad,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -71216,52 +67768,50 @@ } }, "attributes": { - "class": "sprite", - "method": "rectangle_collision", + "class": "quad", + "suffix": "between_quad_and_circle", "group": "physics", - "static": "collisions", - "self": "s" + "static": "collisions" }, "signatures": { - "python": [ - "def sprite_rectangle_collision(s, rect):" - ], "cpp": [ - "bool sprite_rectangle_collision(sprite s, const rectangle &rect)" + "bool resolve_collision(quad &collider, const circle &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_quad_and_circle(collider, collidee, direction):" ], "csharp": [ - "public bool Sprite.RectangleCollision(Rectangle rect);", - "public static bool SplashKit.SpriteRectangleCollision(Sprite s, Rectangle rect);" + "public static bool SplashKit.ResolveCollision(ref Quad collider, Circle collidee, Vector2D direction);" ], "pascal": [ - "function SpriteRectangleCollision(s: Sprite; const rect: Rectangle): Boolean" + "function ResolveCollision(var collider: Quad; const collidee: Circle; const direction: Vector2D): Boolean" ] } }, { - "signature": "bool sprite_triangle_collision(sprite s,const triangle &t);", - "name": "sprite_triangle_collision", - "method_name": "triangle_collision", - "unique_global_name": "sprite_triangle_collision", - "unique_method_name": "sprite.triangle_collision", + "signature": "bool resolve_collision(quad &collider,const rectangle &collidee,const vector_2d &direction);", + "name": "resolve_collision", + "method_name": null, + "unique_global_name": "resolve_collision_between_quad_and_rectangle", + "unique_method_name": null, "suffix_name": null, - "description": "Tests if a sprite is drawn within an given area (triangle).", + "description": "Resolves the collision between a quad and a rectangle by moving the\nquad to the edge of the rectangle. The direction of the\nresolution is determined by the `direction` parameter. If the quad and\nrectangle are not colliding, this function will return false.", "brief": null, "return": { "type": "bool", - "description": "True if the sprite it drawn in the triangle area", + "description": "True if the quad and rectangle are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "s": { - "type": "sprite", - "description": "The sprite to test", + "collider": { + "type": "quad", + "description": "The quad which will be altered if there is a collision", "is_pointer": false, "is_const": false, - "is_reference": false, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -71269,9 +67819,22 @@ "is_vector": false, "type_parameter": null }, - "t": { - "type": "triangle", - "description": "The triangle to check", + "collidee": { + "type": "rectangle", + "description": "The rectangle which will not be altered", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the quad,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -71284,51 +67847,49 @@ } }, "attributes": { - "class": "sprite", - "method": "triangle_collision", + "class": "quad", + "suffix": "between_quad_and_rectangle", "group": "physics", - "static": "collisions", - "self": "s" + "static": "collisions" }, "signatures": { - "python": [ - "def sprite_triangle_collision(s, t):" - ], "cpp": [ - "bool sprite_triangle_collision(sprite s, const triangle &t)" + "bool resolve_collision(quad &collider, const rectangle &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_quad_and_rectangle(collider, collidee, direction):" ], "csharp": [ - "public bool Sprite.TriangleCollision(Triangle t);", - "public static bool SplashKit.SpriteTriangleCollision(Sprite s, Triangle t);" + "public static bool SplashKit.ResolveCollision(ref Quad collider, Rectangle collidee, Vector2D direction);" ], "pascal": [ - "function SpriteTriangleCollision(s: Sprite; const t: Triangle): Boolean" + "function ResolveCollision(var collider: Quad; const collidee: Rectangle; const direction: Vector2D): Boolean" ] } }, { - "signature": "void apply_matrix(const matrix_2d &matrix,quad &q);", - "name": "apply_matrix", + "signature": "bool resolve_collision(quad &collider,const sprite collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "apply_matrix_to_quad", + "unique_global_name": "resolve_collision_between_quad_and_sprite", "unique_method_name": null, "suffix_name": null, - "description": "Use a matrix to transform all of the points in a quad.", + "description": "Resolves the collision between a quad and a sprite by moving the\nquad to the edge of the sprite. The direction of the\nresolution is determined by the `direction` parameter. If the quad and\nsprite are not colliding, this function will return false.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "True if the quad and sprite are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "matrix": { - "type": "matrix_2d", - "description": "The matrix with the transformations needed.", + "collider": { + "type": "quad", + "description": "The quad which will be altered if there is a collision", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -71337,11 +67898,24 @@ "is_vector": false, "type_parameter": null }, - "q": { - "type": "quad", - "description": "The quad to transform.", + "collidee": { + "type": "sprite", + "description": "The sprite which will not be altered", "is_pointer": false, - "is_const": false, + "is_const": true, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the quad,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "is_pointer": false, + "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -71352,48 +67926,49 @@ } }, "attributes": { - "suffix": "to_quad", + "class": "quad", + "suffix": "between_quad_and_sprite", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def apply_matrix_to_quad(matrix, q):" - ], "cpp": [ - "void apply_matrix(const matrix_2d &matrix, quad &q)" + "bool resolve_collision(quad &collider, const sprite collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_quad_and_sprite(collider, collidee, direction):" ], "csharp": [ - "public static void SplashKit.ApplyMatrix(Matrix2D matrix, ref Quad q);" + "public static bool SplashKit.ResolveCollision(ref Quad collider, Sprite collidee, Vector2D direction);" ], "pascal": [ - "procedure ApplyMatrix(const matrix: Matrix2D; var q: Quad)" + "function ResolveCollision(var collider: Quad; collidee: Sprite; const direction: Vector2D): Boolean" ] } }, { - "signature": "void apply_matrix(const matrix_2d &m,triangle &tri);", - "name": "apply_matrix", + "signature": "bool resolve_collision(quad &collider,const triangle &collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "apply_matrix_to_triangle", + "unique_global_name": "resolve_collision_between_quad_and_triangle", "unique_method_name": null, "suffix_name": null, - "description": "Use a matrix to transform all of the points in a triangle.", + "description": "Resolves the collision between a quad and a triangle by moving the\nquad to the edge of the triangle. The direction of the\nresolution is determined by the `direction` parameter. If the quad and\ntriangle are not colliding, this function will return false.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "True if the quad and triangle are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "m": { - "type": "matrix_2d", - "description": "The matrix to be applied to the triangle.", + "collider": { + "type": "quad", + "description": "The quad which will be altered if there is a collision", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -71402,11 +67977,24 @@ "is_vector": false, "type_parameter": null }, - "tri": { + "collidee": { "type": "triangle", - "description": "The triangle to tranform.", + "description": "The triangle which will not be altered", "is_pointer": false, - "is_const": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the quad,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "is_pointer": false, + "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -71417,84 +68005,73 @@ } }, "attributes": { - "suffix": "to_triangle", + "class": "quad", + "suffix": "between_quad_and_triangle", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def apply_matrix_to_triangle(m, tri):" - ], "cpp": [ - "void apply_matrix(const matrix_2d &m, triangle &tri)" - ], - "csharp": [ - "public static void SplashKit.ApplyMatrix(Matrix2D m, ref Triangle tri);" + "bool resolve_collision(quad &collider, const triangle &collidee, const vector_2d &direction)" ], - "pascal": [ - "procedure ApplyMatrix(const m: Matrix2D; var tri: Triangle)" - ] - } - }, - { - "signature": "matrix_2d identity_matrix();", - "name": "identity_matrix", - "method_name": null, - "unique_global_name": "identity_matrix", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns the identity matrix. When a matrix_2d or Vector is multiplied by\nthe identity matrix the result is the original matrix or vector.", - "brief": null, - "return": { - "type": "matrix_2d", - "description": "An identify matrix.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - }, - "attributes": { - "group": "physics", - "static": "matrix_2d" - }, - "signatures": { "python": [ - "def identity_matrix():" - ], - "cpp": [ - "matrix_2d identity_matrix()" + "def resolve_collision_between_quad_and_triangle(collider, collidee, direction):" ], "csharp": [ - "public static Matrix2D SplashKit.IdentityMatrix();" + "public static bool SplashKit.ResolveCollision(ref Quad collider, Triangle collidee, Vector2D direction);" ], "pascal": [ - "function IdentityMatrix(): Matrix2D" + "function ResolveCollision(var collider: Quad; const collidee: Triangle; const direction: Vector2D): Boolean" ] } }, { - "signature": "matrix_2d matrix_inverse(const matrix_2d &m);", - "name": "matrix_inverse", + "signature": "bool resolve_collision(rectangle &collider,const circle &collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "matrix_inverse", + "unique_global_name": "resolve_collision_between_rectangle_and_circle", "unique_method_name": null, "suffix_name": null, - "description": "Calculate the inverse of a matrix.", + "description": "Resolves the collision between a rectangle and a circle by moving the\nrectangle to the edge of the circle. The direction of the\nresolution is determined by the `direction` parameter. If the rectangle and\ncircle are not colliding, this function will return false.", "brief": null, "return": { - "type": "matrix_2d", - "description": "A matrix that is the inverse of m", + "type": "bool", + "description": "True if the rectangle and circle are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "m": { - "type": "matrix_2d", - "description": "The matrix to invert.", + "collider": { + "type": "rectangle", + "description": "The rectangle which will be altered if there is a collision", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "collidee": { + "type": "circle", + "description": "The circle which will not be altered", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the rectangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -71507,45 +68084,60 @@ } }, "attributes": { + "class": "rectangle", + "suffix": "between_rectangle_and_circle", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def matrix_inverse(m):" - ], "cpp": [ - "matrix_2d matrix_inverse(const matrix_2d &m)" + "bool resolve_collision(rectangle &collider, const circle &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_rectangle_and_circle(collider, collidee, direction):" ], "csharp": [ - "public static Matrix2D SplashKit.MatrixInverse(Matrix2D m);" + "public static bool SplashKit.ResolveCollision(ref Rectangle collider, Circle collidee, Vector2D direction);" ], "pascal": [ - "function MatrixInverse(const m: Matrix2D): Matrix2D" + "function ResolveCollision(var collider: Rectangle; const collidee: Circle; const direction: Vector2D): Boolean" ] } }, { - "signature": "point_2d matrix_multiply(const matrix_2d &m,const point_2d &pt);", - "name": "matrix_multiply", + "signature": "bool resolve_collision(rectangle &collider,const quad &collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "matrix_multiply_point", + "unique_global_name": "resolve_collision_between_rectangle_and_quad", "unique_method_name": null, "suffix_name": null, - "description": "Multiplies the `point_2d` parameter `v with the `matrix_2d` `m and\nreturns the result as a `point_2d`. Use this to transform the vector with\nthe matrix (to apply scaling, rotation or translation effects).", + "description": "Resolves the collision between a rectangle and a quad by moving the\nrectangle to the edge of the quad. The direction of the\nresolution is determined by the `direction` parameter. If the rectangle and\nquad are not colliding, this function will return false.", "brief": null, "return": { - "type": "point_2d", - "description": "A new point, the result of applying the transformation to pt.", + "type": "bool", + "description": "True if the rectangle and quad are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "m": { - "type": "matrix_2d", - "description": "The matrix with the transformation to apply.", + "collider": { + "type": "rectangle", + "description": "The rectangle which will be altered if there is a collision", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "collidee": { + "type": "quad", + "description": "The quad which will not be altered", "is_pointer": false, "is_const": true, "is_reference": true, @@ -71556,9 +68148,9 @@ "is_vector": false, "type_parameter": null }, - "pt": { - "type": "point_2d", - "description": "The point to be transformed.", + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the rectangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -71571,46 +68163,60 @@ } }, "attributes": { - "suffix": "point", + "class": "rectangle", + "suffix": "between_rectangle_and_quad", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def matrix_multiply_point(m, pt):" - ], "cpp": [ - "point_2d matrix_multiply(const matrix_2d &m, const point_2d &pt)" + "bool resolve_collision(rectangle &collider, const quad &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_rectangle_and_quad(collider, collidee, direction):" ], "csharp": [ - "public static Point2D SplashKit.MatrixMultiply(Matrix2D m, Point2D pt);" + "public static bool SplashKit.ResolveCollision(ref Rectangle collider, Quad collidee, Vector2D direction);" ], "pascal": [ - "function MatrixMultiply(const m: Matrix2D; const pt: Point2D): Point2D" + "function ResolveCollision(var collider: Rectangle; const collidee: Quad; const direction: Vector2D): Boolean" ] } }, { - "signature": "matrix_2d matrix_multiply(const matrix_2d &m1,const matrix_2d &m2);", - "name": "matrix_multiply", + "signature": "bool resolve_collision(rectangle &collider,const rectangle &collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "matrix_multiply_matrix", + "unique_global_name": "resolve_collision_between_rectangles", "unique_method_name": null, "suffix_name": null, - "description": "Multiplies the two `matrix_2d` parameters, `m1` by `m2`, and returns\nthe result as a new `matrix_2d`. Use this to combine the effects to two\nmatrix transformations.", + "description": "Resolves the collision between two rectangles by moving the\ncollider rectangle to the edge of the collidee rectangle. The direction of the\nresolution is determined by the `direction` parameter. If the rectangles are not\ncolliding, this function will return false.", "brief": null, "return": { - "type": "matrix_2d", - "description": "The result of multiplying m1 by m2", + "type": "bool", + "description": "True if the rectangles are colliding and the collision was resolved,\nfalse if the rectangles are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "m1": { - "type": "matrix_2d", - "description": "The first matrix", + "collider": { + "type": "rectangle", + "description": "The rectangle which will be altered if there is a collision", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "collidee": { + "type": "rectangle", + "description": "The rectangle which will not be altered", "is_pointer": false, "is_const": true, "is_reference": true, @@ -71621,9 +68227,9 @@ "is_vector": false, "type_parameter": null }, - "m2": { - "type": "matrix_2d", - "description": "The second matrix", + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the collider rectangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -71636,48 +68242,49 @@ } }, "attributes": { - "suffix": "matrix", + "class": "rectangle", + "suffix": "between_rectangles", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def matrix_multiply_matrix(m1, m2):" - ], "cpp": [ - "matrix_2d matrix_multiply(const matrix_2d &m1, const matrix_2d &m2)" + "bool resolve_collision(rectangle &collider, const rectangle &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_rectangles(collider, collidee, direction):" ], "csharp": [ - "public static Matrix2D SplashKit.MatrixMultiply(Matrix2D m1, Matrix2D m2);" + "public static bool SplashKit.ResolveCollision(ref Rectangle collider, Rectangle collidee, Vector2D direction);" ], "pascal": [ - "function MatrixMultiply(const m1: Matrix2D; const m2: Matrix2D): Matrix2D" + "function ResolveCollision(var collider: Rectangle; const collidee: Rectangle; const direction: Vector2D): Boolean" ] } }, { - "signature": "vector_2d matrix_multiply(const matrix_2d &m,const vector_2d &v);", - "name": "matrix_multiply", + "signature": "bool resolve_collision(rectangle &collider,const sprite collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "matrix_multiply_vector", + "unique_global_name": "resolve_collision_between_rectangle_and_sprite", "unique_method_name": null, "suffix_name": null, - "description": "Multiplies the `Vector` parameter `v` with the `matrix_2d` `m` and\nreturns the result as a `Vector`. Use this to transform the vector with\nthe matrix (to apply scaling, rotation or translation effects).", + "description": "Resolves the collision between a rectangle and a sprite by moving the\nrectangle to the edge of the sprite. The direction of the\nresolution is determined by the `direction` parameter. If the rectangle and\nsprite are not colliding, this function will return false.", "brief": null, "return": { - "type": "vector_2d", - "description": "A new vector, the result of applying the transformation to v.", + "type": "bool", + "description": "True if the rectangle and sprite are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "m": { - "type": "matrix_2d", - "description": "The matrix with the transformation to apply.", + "collider": { + "type": "rectangle", + "description": "The rectangle which will be altered if there is a collision", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -71686,9 +68293,22 @@ "is_vector": false, "type_parameter": null }, - "v": { + "collidee": { + "type": "sprite", + "description": "The sprite which will not be altered", + "is_pointer": false, + "is_const": true, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { "type": "vector_2d", - "description": "The vector to be transformed.", + "description": "The direction of the collision relative to the rectangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -71701,46 +68321,73 @@ } }, "attributes": { - "suffix": "vector", + "class": "rectangle", + "suffix": "between_rectangle_and_sprite", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def matrix_multiply_vector(m, v):" - ], "cpp": [ - "vector_2d matrix_multiply(const matrix_2d &m, const vector_2d &v)" + "bool resolve_collision(rectangle &collider, const sprite collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_rectangle_and_sprite(collider, collidee, direction):" ], "csharp": [ - "public static Vector2D SplashKit.MatrixMultiply(Matrix2D m, Vector2D v);" + "public static bool SplashKit.ResolveCollision(ref Rectangle collider, Sprite collidee, Vector2D direction);" ], "pascal": [ - "function MatrixMultiply(const m: Matrix2D; const v: Vector2D): Vector2D" + "function ResolveCollision(var collider: Rectangle; collidee: Sprite; const direction: Vector2D): Boolean" ] } }, { - "signature": "string matrix_to_string(const matrix_2d &matrix);", - "name": "matrix_to_string", + "signature": "bool resolve_collision(rectangle &collider,const triangle &collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "matrix_to_string", + "unique_global_name": "resolve_collision_between_rectangle_and_triangle", "unique_method_name": null, "suffix_name": null, - "description": "This function returns a string representation of a Matrix.", + "description": "Resolves the collision between a rectangle and a triangle by moving the\nrectangle to the edge of the triangle. The direction of the\nresolution is determined by the `direction` parameter. If the rectangle and\ntriangle are not colliding, this function will return false.", "brief": null, "return": { - "type": "string", - "description": "A string representation of the matrix.", + "type": "bool", + "description": "True if the rectangle and triangle are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "matrix": { - "type": "matrix_2d", - "description": "The matrix to convert to a string.", + "collider": { + "type": "rectangle", + "description": "The rectangle which will be altered if there is a collision", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "collidee": { + "type": "triangle", + "description": "The triangle which will not be altered", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the rectangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -71753,96 +68400,152 @@ } }, "attributes": { + "class": "rectangle", + "suffix": "between_rectangle_and_triangle", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def matrix_to_string(matrix):" - ], "cpp": [ - "string matrix_to_string(const matrix_2d &matrix)" + "bool resolve_collision(rectangle &collider, const triangle &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_rectangle_and_triangle(collider, collidee, direction):" ], "csharp": [ - "public static string SplashKit.MatrixToString(Matrix2D matrix);" + "public static bool SplashKit.ResolveCollision(ref Rectangle collider, Triangle collidee, Vector2D direction);" ], "pascal": [ - "function MatrixToString(const matrix: Matrix2D): String" + "function ResolveCollision(var collider: Rectangle; const collidee: Triangle; const direction: Vector2D): Boolean" ] } }, { - "signature": "matrix_2d rotation_matrix(double deg);", - "name": "rotation_matrix", + "signature": "bool resolve_collision(sprite collider,const circle &collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "rotation_matrix", + "unique_global_name": "resolve_collision_between_sprite_and_circle", "unique_method_name": null, "suffix_name": null, - "description": "Returns a rotation matrix that rotates 2d points by the angle.", + "description": "Resolves the collision between a sprite and a circle by moving the\nsprite to the edge of the circle. The direction of the\nresolution is determined by the `direction` parameter. If the sprite and\ncircle are not colliding, this function will return false.", "brief": null, "return": { - "type": "matrix_2d", - "description": "A matrix that encodes the rotation by a number of degrees.", + "type": "bool", + "description": "True if the sprite and circle are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "deg": { - "type": "double", - "description": "The amount to rotate points", + "collider": { + "type": "sprite", + "description": "The sprite which will be altered if there is a collision", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "collidee": { + "type": "circle", + "description": "The circle which will not be altered", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the sprite,\nexpressed as a vector. If a zero vector is passed,\nthe function will not resolve the collision.", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { + "class": "sprite", + "suffix": "between_sprite_and_circle", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def rotation_matrix(deg):" - ], "cpp": [ - "matrix_2d rotation_matrix(double deg)" + "bool resolve_collision(sprite collider, const circle &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_sprite_and_circle(collider, collidee, direction):" ], "csharp": [ - "public static Matrix2D SplashKit.RotationMatrix(double deg);" + "public static bool SplashKit.ResolveCollision(Sprite collider, Circle collidee, Vector2D direction);" ], "pascal": [ - "function RotationMatrix(deg: Double): Matrix2D" + "function ResolveCollision(collider: Sprite; const collidee: Circle; const direction: Vector2D): Boolean" ] } }, { - "signature": "matrix_2d scale_matrix(const point_2d &scale);", - "name": "scale_matrix", + "signature": "bool resolve_collision(sprite collider,const quad &collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "scale_matrix_from_point", + "unique_global_name": "resolve_collision_between_sprite_and_quad", "unique_method_name": null, "suffix_name": null, - "description": "Create a scale matrix that scales x and y to\ndifferent degrees.", + "description": "Resolves the collision between a sprite and a quad by moving the\nsprite to the edge of the quad. The direction of the\nresolution is determined by the `direction` parameter. If the sprite and\nquad are not colliding, this function will return false.", "brief": null, "return": { - "type": "matrix_2d", - "description": "A matrix that will scale points based on scale parameter.", + "type": "bool", + "description": "True if the sprite and quad are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "scale": { - "type": "point_2d", - "description": "The amount to scale, with separate x and y components.", + "collider": { + "type": "sprite", + "description": "The sprite which will be altered if there is a collision", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "collidee": { + "type": "quad", + "description": "The quad which will not be altered", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the sprite,\nexpressed as a vector. If a zero vector is passed,\nthe function will not resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -71855,46 +68558,73 @@ } }, "attributes": { - "suffix": "from_point", + "class": "sprite", + "suffix": "between_sprite_and_quad", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def scale_matrix_from_point(scale):" - ], "cpp": [ - "matrix_2d scale_matrix(const point_2d &scale)" + "bool resolve_collision(sprite collider, const quad &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_sprite_and_quad(collider, collidee, direction):" ], "csharp": [ - "public static Matrix2D SplashKit.ScaleMatrix(Point2D scale);" + "public static bool SplashKit.ResolveCollision(Sprite collider, Quad collidee, Vector2D direction);" ], "pascal": [ - "function ScaleMatrix(const scale: Point2D): Matrix2D" + "function ResolveCollision(collider: Sprite; const collidee: Quad; const direction: Vector2D): Boolean" ] } }, { - "signature": "matrix_2d scale_matrix(const vector_2d &scale);", - "name": "scale_matrix", + "signature": "bool resolve_collision(sprite collider,const rectangle &collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "scale_matrix_from_vector", + "unique_global_name": "resolve_collision_between_sprite_and_rectangle", "unique_method_name": null, "suffix_name": null, - "description": "Create a scale matrix that scales x and y to\ndifferent degrees.", + "description": "Resolves the collision between a sprite and a rectangle by moving the\nsprite to the edge of the rectangle. The direction of the\nresolution is determined by the `direction` parameter. If the sprite and\nrectangle are not colliding, this function will return false.", "brief": null, "return": { - "type": "matrix_2d", - "description": "A matrix that will scale points based on scale parameter.", + "type": "bool", + "description": "True if the sprite and rectangle are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "scale": { + "collider": { + "type": "sprite", + "description": "The sprite which will be altered if there is a collision", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "collidee": { + "type": "rectangle", + "description": "The rectangle which will not be altered", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { "type": "vector_2d", - "description": "The amount to scale, with separate x and y components.", + "description": "The direction of the collision relative to the sprite,\nexpressed as a vector. If a zero vector is passed,\nthe function will not resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -71907,100 +68637,129 @@ } }, "attributes": { - "suffix": "from_vector", + "class": "sprite", + "suffix": "between_sprite_and_rectangle", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def scale_matrix_from_vector(scale):" - ], "cpp": [ - "matrix_2d scale_matrix(const vector_2d &scale)" + "bool resolve_collision(sprite collider, const rectangle &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_sprite_and_rectangle(collider, collidee, direction):" ], "csharp": [ - "public static Matrix2D SplashKit.ScaleMatrix(Vector2D scale);" + "public static bool SplashKit.ResolveCollision(Sprite collider, Rectangle collidee, Vector2D direction);" ], "pascal": [ - "function ScaleMatrix(const scale: Vector2D): Matrix2D" + "function ResolveCollision(collider: Sprite; const collidee: Rectangle; const direction: Vector2D): Boolean" ] } }, { - "signature": "matrix_2d scale_matrix(double scale);", - "name": "scale_matrix", + "signature": "bool resolve_collision(sprite collider,const sprite collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "scale_matrix", + "unique_global_name": "resolve_collision_between_sprites", "unique_method_name": null, "suffix_name": null, - "description": "Returns a matrix that can be used to scale 2d points (both x and y).", + "description": "Resolves the collision between two sprites by moving the\ncollider sprite to the edge of the collidee sprite. The direction of the\nresolution is determined by the `direction` parameter. If the sprites are not\ncolliding, this function will return false.", "brief": null, "return": { - "type": "matrix_2d", - "description": "A matrix to scale points by.", + "type": "bool", + "description": "True if the sprites are colliding and the collision was resolved,\nfalse if the sprites are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "scale": { - "type": "double", - "description": "The amount to scale points by.", + "collider": { + "type": "sprite", + "description": "The sprite which will be altered if there is a collision", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "collidee": { + "type": "sprite", + "description": "The sprite which will not be altered", + "is_pointer": false, + "is_const": true, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the collider sprite,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null } }, "attributes": { + "class": "sprite", + "suffix": "between_sprites", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def scale_matrix(scale):" - ], "cpp": [ - "matrix_2d scale_matrix(double scale)" + "bool resolve_collision(sprite collider, const sprite collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_sprites(collider, collidee, direction):" ], "csharp": [ - "public static Matrix2D SplashKit.ScaleMatrix(double scale);" + "public static bool SplashKit.ResolveCollision(Sprite collider, Sprite collidee, Vector2D direction);" ], "pascal": [ - "function ScaleMatrix(scale: Double): Matrix2D" + "function ResolveCollision(collider: Sprite; collidee: Sprite; const direction: Vector2D): Boolean" ] } }, { - "signature": "matrix_2d scale_rotate_translate_matrix(const point_2d &scale,double deg,const point_2d &translate);", - "name": "scale_rotate_translate_matrix", + "signature": "bool resolve_collision(sprite collider,const triangle &collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "scale_rotate_translate_matrix", + "unique_global_name": "resolve_collision_between_sprite_and_triangle", "unique_method_name": null, "suffix_name": null, - "description": "Create a matrix that can scale, rotate then translate geometry points.", + "description": "Resolves the collision between a sprite and a triangle by moving the\nsprite to the edge of the triangle. The direction of the\nresolution is determined by the `direction` parameter. If the sprite and\ntriangle are not colliding, this function will return false.", "brief": null, "return": { - "type": "matrix_2d", - "description": "A matrix that will scale, rotate, and translate.", + "type": "bool", + "description": "True if the sprite and triangle are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "scale": { - "type": "point_2d", - "description": "The amount to scale", + "collider": { + "type": "sprite", + "description": "The sprite which will be altered if there is a collision", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -72008,12 +68767,12 @@ "is_vector": false, "type_parameter": null }, - "deg": { - "type": "double", - "description": "The amount to rotate", + "collidee": { + "type": "triangle", + "description": "The triangle which will not be altered", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -72021,9 +68780,9 @@ "is_vector": false, "type_parameter": null }, - "translate": { - "type": "point_2d", - "description": "The amount to move", + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the sprite,\nexpressed as a vector. If a zero vector is passed,\nthe function will not resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -72036,45 +68795,73 @@ } }, "attributes": { + "class": "sprite", + "suffix": "between_sprite_and_triangle", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def scale_rotate_translate_matrix(scale, deg, translate):" - ], "cpp": [ - "matrix_2d scale_rotate_translate_matrix(const point_2d &scale, double deg, const point_2d &translate)" + "bool resolve_collision(sprite collider, const triangle &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_sprite_and_triangle(collider, collidee, direction):" ], "csharp": [ - "public static Matrix2D SplashKit.ScaleRotateTranslateMatrix(Point2D scale, double deg, Point2D translate);" + "public static bool SplashKit.ResolveCollision(Sprite collider, Triangle collidee, Vector2D direction);" ], "pascal": [ - "function ScaleRotateTranslateMatrix(const scale: Point2D; deg: Double; const translate: Point2D): Matrix2D" + "function ResolveCollision(collider: Sprite; const collidee: Triangle; const direction: Vector2D): Boolean" ] } }, { - "signature": "matrix_2d translation_matrix(const point_2d &pt);", - "name": "translation_matrix", + "signature": "bool resolve_collision(triangle &collider,const circle &collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "translation_matrix_to_point", + "unique_global_name": "resolve_collision_between_triangle_and_circle", "unique_method_name": null, "suffix_name": null, - "description": "Returns a translation matric used to translate 2d points by the\ndistance in the point_2d.", + "description": "Resolves the collision between a triangle and a circle by moving the\ntriangle to the edge of the circle. The direction of the\nresolution is determined by the `direction` parameter. If the triangle and\ncircle are not colliding, this function will return false.", "brief": null, "return": { - "type": "matrix_2d", - "description": "A matrix that will move points by amount in pt", + "type": "bool", + "description": "True if the triangle and circle are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { - "type": "point_2d", - "description": "The point to translate to.", + "collider": { + "type": "triangle", + "description": "The triangle which will be altered if there is a collision", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "collidee": { + "type": "circle", + "description": "The circle which will not be altered", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the triangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -72087,46 +68874,73 @@ } }, "attributes": { - "suffix": "to_point", + "class": "triangle", + "suffix": "between_triangle_and_circle", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def translation_matrix_to_point(pt):" - ], "cpp": [ - "matrix_2d translation_matrix(const point_2d &pt)" + "bool resolve_collision(triangle &collider, const circle &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_triangle_and_circle(collider, collidee, direction):" ], "csharp": [ - "public static Matrix2D SplashKit.TranslationMatrix(Point2D pt);" + "public static bool SplashKit.ResolveCollision(ref Triangle collider, Circle collidee, Vector2D direction);" ], "pascal": [ - "function TranslationMatrix(const pt: Point2D): Matrix2D" + "function ResolveCollision(var collider: Triangle; const collidee: Circle; const direction: Vector2D): Boolean" ] } }, { - "signature": "matrix_2d translation_matrix(const vector_2d &pt);", - "name": "translation_matrix", + "signature": "bool resolve_collision(triangle &collider,const quad &collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "translation_matrix_from_vector", + "unique_global_name": "resolve_collision_between_triangle_and_quad", "unique_method_name": null, "suffix_name": null, - "description": "Returns a translation matric used to translate 2d points by the\ndistance in the vector_2d.", + "description": "Resolves the collision between a triangle and a quad by moving the\ntriangle to the edge of the quad. The direction of the\nresolution is determined by the `direction` parameter. If the triangle and\nquad are not colliding, this function will return false.", "brief": null, "return": { - "type": "matrix_2d", - "description": "A matrix that will move points by amount in pt", + "type": "bool", + "description": "True if the triangle and quad are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { + "collider": { + "type": "triangle", + "description": "The triangle which will be altered if there is a collision", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "collidee": { + "type": "quad", + "description": "The quad which will not be altered", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { "type": "vector_2d", - "description": "The point to translate to.", + "description": "The direction of the collision relative to the triangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -72139,49 +68953,50 @@ } }, "attributes": { - "suffix": "from_vector", + "class": "triangle", + "suffix": "between_triangle_and_quad", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def translation_matrix_from_vector(pt):" - ], "cpp": [ - "matrix_2d translation_matrix(const vector_2d &pt)" + "bool resolve_collision(triangle &collider, const quad &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_triangle_and_quad(collider, collidee, direction):" ], "csharp": [ - "public static Matrix2D SplashKit.TranslationMatrix(Vector2D pt);" + "public static bool SplashKit.ResolveCollision(ref Triangle collider, Quad collidee, Vector2D direction);" ], "pascal": [ - "function TranslationMatrix(const pt: Vector2D): Matrix2D" + "function ResolveCollision(var collider: Triangle; const collidee: Quad; const direction: Vector2D): Boolean" ] } }, { - "signature": "matrix_2d translation_matrix(double dx,double dy);", - "name": "translation_matrix", + "signature": "bool resolve_collision(triangle &collider,const rectangle &collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "translation_matrix", + "unique_global_name": "resolve_collision_between_triangle_and_rectangle", "unique_method_name": null, "suffix_name": null, - "description": "Returns a matrix that can be used to translate 2d points. Moving them\nby dx and dy.", + "description": "Resolves the collision between a triangle and a rectangle by moving the\ntriangle to the edge of the rectangle. The direction of the\nresolution is determined by the `direction` parameter. If the triangle and\nrectangle are not colliding, this function will return false.", "brief": null, "return": { - "type": "matrix_2d", - "description": "A matrix that will move points by dx, dy", + "type": "bool", + "description": "True if the triangle and rectangle are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "dx": { - "type": "double", - "description": "The amount to move points along the x axis.", + "collider": { + "type": "triangle", + "description": "The triangle which will be altered if there is a collision", "is_pointer": false, "is_const": false, - "is_reference": false, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -72189,12 +69004,25 @@ "is_vector": false, "type_parameter": null }, - "dy": { - "type": "double", - "description": "The amount to move points along the y axis.", + "collidee": { + "type": "rectangle", + "description": "The rectangle which will not be altered", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { + "type": "vector_2d", + "description": "The direction of the collision relative to the triangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -72204,47 +69032,49 @@ } }, "attributes": { + "class": "triangle", + "suffix": "between_triangle_and_rectangle", "group": "physics", - "static": "matrix_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def translation_matrix(dx, dy):" - ], "cpp": [ - "matrix_2d translation_matrix(double dx, double dy)" + "bool resolve_collision(triangle &collider, const rectangle &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_triangle_and_rectangle(collider, collidee, direction):" ], "csharp": [ - "public static Matrix2D SplashKit.TranslationMatrix(double dx, double dy);" + "public static bool SplashKit.ResolveCollision(ref Triangle collider, Rectangle collidee, Vector2D direction);" ], "pascal": [ - "function TranslationMatrix(dx: Double; dy: Double): Matrix2D" + "function ResolveCollision(var collider: Triangle; const collidee: Rectangle; const direction: Vector2D): Boolean" ] } }, { - "signature": "double angle_between(const vector_2d &v1,const vector_2d &v2);", - "name": "angle_between", + "signature": "bool resolve_collision(triangle &collider,const sprite collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "angle_between", + "unique_global_name": "resolve_collision_between_triangle_and_sprite", "unique_method_name": null, "suffix_name": null, - "description": "Calculates the angle from one vector to another.", + "description": "Resolves the collision between a triangle and a sprite by moving the\ntriangle to the edge of the sprite. The direction of the\nresolution is determined by the `direction` parameter. If the triangle and\nsprite are not colliding, this function will return false.", "brief": null, "return": { - "type": "double", - "description": "The angle of the line from the end of `v1` to the end of `v2`", + "type": "bool", + "description": "True if the triangle and sprite are colliding and the collision\nwas resolved, false if they are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v1": { - "type": "vector_2d", - "description": "The first vector", + "collider": { + "type": "triangle", + "description": "The triangle which will be altered if there is a collision", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -72253,9 +69083,22 @@ "is_vector": false, "type_parameter": null }, - "v2": { + "collidee": { + "type": "sprite", + "description": "The sprite which will not be altered", + "is_pointer": false, + "is_const": true, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "direction": { "type": "vector_2d", - "description": "The second vector", + "description": "The direction of the collision relative to the triangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -72268,45 +69111,60 @@ } }, "attributes": { + "class": "triangle", + "suffix": "between_triangle_and_sprite", "group": "physics", - "static": "vector_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def angle_between(v1, v2):" - ], "cpp": [ - "double angle_between(const vector_2d &v1, const vector_2d &v2)" + "bool resolve_collision(triangle &collider, const sprite collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_triangle_and_sprite(collider, collidee, direction):" ], "csharp": [ - "public static double SplashKit.AngleBetween(Vector2D v1, Vector2D v2);" + "public static bool SplashKit.ResolveCollision(ref Triangle collider, Sprite collidee, Vector2D direction);" ], "pascal": [ - "function AngleBetween(const v1: Vector2D; const v2: Vector2D): Double" + "function ResolveCollision(var collider: Triangle; collidee: Sprite; const direction: Vector2D): Boolean" ] } }, { - "signature": "double dot_product(const vector_2d &v1,const vector_2d &v2);", - "name": "dot_product", + "signature": "bool resolve_collision(triangle &collider,const triangle &collidee,const vector_2d &direction);", + "name": "resolve_collision", "method_name": null, - "unique_global_name": "dot_product", + "unique_global_name": "resolve_collision_between_triangles", "unique_method_name": null, "suffix_name": null, - "description": "Calculates the dot product (scalar product) between the two vector\nparameters provided (`v1` and `v2`). It returns the result as a\nscalar value.\n\nIf the result is 0.0 it means that the vectors are orthogonal (at right\nangles to each other). If `v1` and `v2` are unit vectors (length of\n1.0) and the dot product is 1.0, it means that `v1` and `v2` vectors\nare parallel.", + "description": "Resolves the collision between a collider triangle and a collidee triangle by moving the\ncollider triangle to the edge of the collidee triangle. The direction of the\nresolution is determined by the `direction` parameter. If the triangles are not\ncolliding, this function will return false.", "brief": null, "return": { - "type": "double", - "description": "The dot product of `v1` . `v2`", + "type": "bool", + "description": "True if the triangles are colliding and the collision was resolved,\nfalse if the triangles are not colliding", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v1": { - "type": "vector_2d", - "description": "The first vector", + "collider": { + "type": "triangle", + "description": "The triangle which will be altered if there is a collision", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "collidee": { + "type": "triangle", + "description": "The triangle which will not be altered", "is_pointer": false, "is_const": true, "is_reference": true, @@ -72317,9 +69175,9 @@ "is_vector": false, "type_parameter": null }, - "v2": { + "direction": { "type": "vector_2d", - "description": "The other vector", + "description": "The direction of the collision relative to the collider triangle,\nexpressed as a vector. If a zero vector is passed, the function will\nnot resolve the collision.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -72332,48 +69190,89 @@ } }, "attributes": { + "class": "triangle", + "suffix": "between_triangles", "group": "physics", - "static": "vector_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def dot_product(v1, v2):" - ], "cpp": [ - "double dot_product(const vector_2d &v1, const vector_2d &v2)" + "bool resolve_collision(triangle &collider, const triangle &collidee, const vector_2d &direction)" + ], + "python": [ + "def resolve_collision_between_triangles(collider, collidee, direction):" ], "csharp": [ - "public static double SplashKit.DotProduct(Vector2D v1, Vector2D v2);" + "public static bool SplashKit.ResolveCollision(ref Triangle collider, Triangle collidee, Vector2D direction);" ], "pascal": [ - "function DotProduct(const v1: Vector2D; const v2: Vector2D): Double" + "function ResolveCollision(var collider: Triangle; const collidee: Triangle; const direction: Vector2D): Boolean" ] } }, { - "signature": "bool is_zero_vector(const vector_2d &v);", - "name": "is_zero_vector", - "method_name": null, - "unique_global_name": "is_zero_vector", - "unique_method_name": null, + "signature": "bool sprite_bitmap_collision(sprite s,bitmap bmp,double x,double y);", + "name": "sprite_bitmap_collision", + "method_name": "bitmap_collision", + "unique_global_name": "sprite_bitmap_collision", + "unique_method_name": "sprite.bitmap_collision", "suffix_name": null, - "description": "Returns if the vector is a null/zero vector -- having no size or direction.", + "description": "Tests if a sprite will collide with a bitmap drawn at the indicated\nlocation.", "brief": null, "return": { "type": "bool", - "description": "True if `v` has no magnitude.", + "description": "True if the sprite collides with the bitmap when drawn\nat the indicated location.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v": { - "type": "vector_2d", - "description": "The vector", + "s": { + "type": "sprite", + "description": "The sprite to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x": { + "type": "double", + "description": "The x location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -72383,48 +69282,52 @@ } }, "attributes": { + "class": "sprite", + "method": "bitmap_collision", "group": "physics", - "static": "vector_2d" + "static": "collisions", + "self": "s" }, "signatures": { - "python": [ - "def is_zero_vector(v):" - ], "cpp": [ - "bool is_zero_vector(const vector_2d &v)" + "bool sprite_bitmap_collision(sprite s, bitmap bmp, double x, double y)" + ], + "python": [ + "def sprite_bitmap_collision(s, bmp, x, y):" ], "csharp": [ - "public static bool SplashKit.IsZeroVector(Vector2D v);" + "public bool Sprite.BitmapCollision(Bitmap bmp, double x, double y);", + "public static bool SplashKit.SpriteBitmapCollision(Sprite s, Bitmap bmp, double x, double y);" ], "pascal": [ - "function IsZeroVector(const v: Vector2D): Boolean" + "function SpriteBitmapCollision(s: Sprite; bmp: Bitmap; x: Double; y: Double): Boolean" ] } }, { - "signature": "bool ray_intersection_point(const point_2d &from_pt,const vector_2d &heading,const line &l,point_2d &pt);", - "name": "ray_intersection_point", - "method_name": null, - "unique_global_name": "ray_intersection_point", - "unique_method_name": null, + "signature": "bool sprite_bitmap_collision(sprite s,bitmap bmp,int cell,const point_2d &pt);", + "name": "sprite_bitmap_collision", + "method_name": "bitmap_collision", + "unique_global_name": "sprite_bitmap_collision_with_cell_at_point", + "unique_method_name": "sprite.bitmap_collision_with_cell_at_point", "suffix_name": null, - "description": "Casts a ray in a heading and returns true is it intersects with a line", + "description": "Tests if a sprite will collide with a bitmap drawn at the indicated\nlocation.", "brief": null, "return": { "type": "bool", - "description": "True if the line and ray will intersect, in which case\nthe value of `pt` will be changed to be the point where\nthe intersection occurs.", + "description": "True if the sprite collides with the bitmap cell when drawn\nat the indicated location.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "from_pt": { - "type": "point_2d", - "description": "The origin of the ray", + "s": { + "type": "sprite", + "description": "The sprite to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -72432,12 +69335,12 @@ "is_vector": false, "type_parameter": null }, - "heading": { - "type": "vector_2d", - "description": "The direction the ray is heading (as a `vector_2d`)", + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -72445,12 +69348,12 @@ "is_vector": false, "type_parameter": null }, - "l": { - "type": "line", - "description": "The line to be checked", + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -72460,9 +69363,9 @@ }, "pt": { "type": "point_2d", - "description": "Outputs the point where the line and ray intersect", + "description": "The point where the bitmap is drawn", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -72473,48 +69376,105 @@ } }, "attributes": { + "class": "sprite", + "method": "bitmap_collision", + "suffix": "with_cell_at_point", "group": "physics", - "static": "vector_2d" + "static": "collisions", + "self": "s" }, "signatures": { - "python": [ - "def ray_intersection_point(from_pt, heading, l, pt):" - ], "cpp": [ - "bool ray_intersection_point(const point_2d &from_pt, const vector_2d &heading, const line &l, point_2d &pt)" + "bool sprite_bitmap_collision(sprite s, bitmap bmp, int cell, const point_2d &pt)" + ], + "python": [ + "def sprite_bitmap_collision_with_cell_at_point(s, bmp, cell, pt):" ], "csharp": [ - "public static bool SplashKit.RayIntersectionPoint(Point2D fromPt, Vector2D heading, Line l, ref Point2D pt);" + "public bool Sprite.BitmapCollision(Bitmap bmp, int cell, Point2D pt);", + "public static bool SplashKit.SpriteBitmapCollision(Sprite s, Bitmap bmp, int cell, Point2D pt);" ], "pascal": [ - "function RayIntersectionPoint(const fromPt: Point2D; const heading: Vector2D; const l: Line; var pt: Point2D): Boolean" + "function SpriteBitmapCollision(s: Sprite; bmp: Bitmap; cell: Integer; const pt: Point2D): Boolean" ] } }, { - "signature": "vector_2d unit_vector(const vector_2d &v);", - "name": "unit_vector", - "method_name": null, - "unique_global_name": "unit_vector", - "unique_method_name": null, + "signature": "bool sprite_bitmap_collision(sprite s,bitmap bmp,int cell,double x,double y);", + "name": "sprite_bitmap_collision", + "method_name": "bitmap_collision", + "unique_global_name": "sprite_bitmap_collision_with_cell", + "unique_method_name": "sprite.bitmap_collision_with_cell", "suffix_name": null, - "description": "Returns the unit vector of the parameter vector (v). The unit vector has a\nmagnitude of 1, resulting in a vector that indicates the direction of\nthe original vector.", + "description": "Tests if a sprite will collide with a bitmap drawn at the indicated\nlocation.", "brief": null, "return": { - "type": "vector_2d", - "description": "The unit vector of `v`", + "type": "bool", + "description": "True if the sprite collides with the bitmap cell when drawn\nat the indicated location.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v": { - "type": "vector_2d", - "description": "The vector", + "s": { + "type": "sprite", + "description": "The sprite to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "bmp": { + "type": "bitmap", + "description": "The bitmap to test", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "cell": { + "type": "int", + "description": "The cell of the bitmap to check", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "x": { + "type": "double", + "description": "The x location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "y": { + "type": "double", + "description": "The y location where the bitmap is drawn", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -72524,48 +69484,53 @@ } }, "attributes": { + "class": "sprite", + "method": "bitmap_collision", + "suffix": "with_cell", "group": "physics", - "static": "vector_2d" + "static": "collisions", + "self": "s" }, "signatures": { - "python": [ - "def unit_vector(v):" - ], "cpp": [ - "vector_2d unit_vector(const vector_2d &v)" + "bool sprite_bitmap_collision(sprite s, bitmap bmp, int cell, double x, double y)" + ], + "python": [ + "def sprite_bitmap_collision_with_cell(s, bmp, cell, x, y):" ], "csharp": [ - "public static Vector2D SplashKit.UnitVector(Vector2D v);" + "public bool Sprite.BitmapCollision(Bitmap bmp, int cell, double x, double y);", + "public static bool SplashKit.SpriteBitmapCollision(Sprite s, Bitmap bmp, int cell, double x, double y);" ], "pascal": [ - "function UnitVector(const v: Vector2D): Vector2D" + "function SpriteBitmapCollision(s: Sprite; bmp: Bitmap; cell: Integer; x: Double; y: Double): Boolean" ] } }, { - "signature": "vector_2d vector_add(const vector_2d &v1,const vector_2d &v2);", - "name": "vector_add", - "method_name": null, - "unique_global_name": "vector_add", - "unique_method_name": null, + "signature": "bool sprite_circle_collision(sprite s,const circle &c);", + "name": "sprite_circle_collision", + "method_name": "circle_collision", + "unique_global_name": "sprite_circle_collision", + "unique_method_name": "sprite.circle_collision", "suffix_name": null, - "description": "Adds the two passed in vectors returns the result as new `vector_2d`.", + "description": "Tests if a sprite is drawn within an given area (circle).", "brief": null, "return": { - "type": "vector_2d", - "description": "The result of adding the movements of the two vectors\ntogether.", + "type": "bool", + "description": "True if the sprite it drawn in the circle area", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v1": { - "type": "vector_2d", - "description": "The first vector.", + "s": { + "type": "sprite", + "description": "The sprite to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -72573,9 +69538,9 @@ "is_vector": false, "type_parameter": null }, - "v2": { - "type": "vector_2d", - "description": "The other vector.", + "c": { + "type": "circle", + "description": "The circle to check", "is_pointer": false, "is_const": true, "is_reference": true, @@ -72588,47 +69553,64 @@ } }, "attributes": { + "class": "sprite", + "method": "circle_collision", "group": "physics", - "static": "vector_2d" + "static": "collisions", + "self": "s" }, "signatures": { - "python": [ - "def vector_add(v1, v2):" - ], "cpp": [ - "vector_2d vector_add(const vector_2d &v1, const vector_2d &v2)" + "bool sprite_circle_collision(sprite s, const circle &c)" + ], + "python": [ + "def sprite_circle_collision(s, c):" ], "csharp": [ - "public static Vector2D SplashKit.VectorAdd(Vector2D v1, Vector2D v2);" + "public bool Sprite.CircleCollision(Circle c);", + "public static bool SplashKit.SpriteCircleCollision(Sprite s, Circle c);" ], "pascal": [ - "function VectorAdd(const v1: Vector2D; const v2: Vector2D): Vector2D" + "function SpriteCircleCollision(s: Sprite; const c: Circle): Boolean" ] } }, { - "signature": "double vector_angle(const vector_2d v);", - "name": "vector_angle", - "method_name": null, - "unique_global_name": "vector_angle", - "unique_method_name": null, + "signature": "bool sprite_collision(sprite s1,sprite s2);", + "name": "sprite_collision", + "method_name": "sprite_collision", + "unique_global_name": "sprite_collision", + "unique_method_name": "sprite.sprite_collision", "suffix_name": null, - "description": "Calculates the angle of a vector", + "description": "Tests if two given sprites `s1` and `s2` are collided", "brief": null, "return": { - "type": "double", - "description": "The angle of the vector in degrees", + "type": "bool", + "description": "return `true` if both `s1` and `s2` are colliding, false otherwise.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v": { - "type": "vector_2d", - "description": "The vector", + "s1": { + "type": "sprite", + "description": "the first `sprite` to test", "is_pointer": false, - "is_const": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "s2": { + "type": "sprite", + "description": "the second `sprite` to test", + "is_pointer": false, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -72639,45 +69621,49 @@ } }, "attributes": { + "class": "sprite", + "method": "sprite_collision", + "self": "s1", "group": "physics", - "static": "vector_2d" + "static": "collisions" }, "signatures": { - "python": [ - "def vector_angle(v):" - ], "cpp": [ - "double vector_angle(const vector_2d v)" + "bool sprite_collision(sprite s1, sprite s2)" + ], + "python": [ + "def sprite_collision(s1, s2):" ], "csharp": [ - "public static double SplashKit.VectorAngle(Vector2D v);" + "public bool Sprite.SpriteCollision(Sprite s2);", + "public static bool SplashKit.SpriteCollision(Sprite s1, Sprite s2);" ], "pascal": [ - "function VectorAngle(v: Vector2D): Double" + "function SpriteCollision(s1: Sprite; s2: Sprite): Boolean" ] } }, { - "signature": "vector_2d vector_from_angle(double angle,double magnitude);", - "name": "vector_from_angle", - "method_name": null, - "unique_global_name": "vector_from_angle", - "unique_method_name": null, + "signature": "bool sprite_point_collision(sprite s,const point_2d &pt);", + "name": "sprite_point_collision", + "method_name": "point_collision", + "unique_global_name": "sprite_point_collision", + "unique_method_name": "sprite.point_collision", "suffix_name": null, - "description": "Returns a `vector_2d` from the supplied angle and distance.", + "description": "Tests if a sprite is drawn at a given point.", "brief": null, "return": { - "type": "vector_2d", - "description": "A vector that will move things at that angle and\nmagnitude", + "type": "bool", + "description": "True if the sprite it drawn at the indicated point", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "angle": { - "type": "double", - "description": "The angle in degrees", + "s": { + "type": "sprite", + "description": "The sprite to test", "is_pointer": false, "is_const": false, "is_reference": false, @@ -72688,12 +69674,12 @@ "is_vector": false, "type_parameter": null }, - "magnitude": { - "type": "double", - "description": "The length of the vector", + "pt": { + "type": "point_2d", + "description": "The point to check", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -72703,45 +69689,62 @@ } }, "attributes": { + "class": "sprite", + "method": "point_collision", "group": "physics", - "static": "vector_2d" + "static": "collisions", + "self": "s" }, "signatures": { - "python": [ - "def vector_from_angle(angle, magnitude):" - ], "cpp": [ - "vector_2d vector_from_angle(double angle, double magnitude)" + "bool sprite_point_collision(sprite s, const point_2d &pt)" + ], + "python": [ + "def sprite_point_collision(s, pt):" ], "csharp": [ - "public static Vector2D SplashKit.VectorFromAngle(double angle, double magnitude);" + "public bool Sprite.PointCollision(Point2D pt);", + "public static bool SplashKit.SpritePointCollision(Sprite s, Point2D pt);" ], "pascal": [ - "function VectorFromAngle(angle: Double; magnitude: Double): Vector2D" + "function SpritePointCollision(s: Sprite; const pt: Point2D): Boolean" ] } }, { - "signature": "vector_2d vector_from_line(const line &l);", - "name": "vector_from_line", - "method_name": null, - "unique_global_name": "vector_from_line", - "unique_method_name": null, + "signature": "bool sprite_quad_collision(sprite s,const quad &q);", + "name": "sprite_quad_collision", + "method_name": "quad_collision", + "unique_global_name": "sprite_quad_collision", + "unique_method_name": "sprite.quad_collision", "suffix_name": null, - "description": "Returns a vector that points from the start to the end of a line.", + "description": "Tests if a sprite is drawn within an given area (quad).", "brief": null, "return": { - "type": "vector_2d", - "description": "A vector that will move things from the start to the end of the\nline", + "type": "bool", + "description": "True if the sprite it drawn in the quad area", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "l": { - "type": "line", - "description": "The line", + "s": { + "type": "sprite", + "description": "The sprite to test", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "q": { + "type": "quad", + "description": "The quad to check", "is_pointer": false, "is_const": true, "is_reference": true, @@ -72754,45 +69757,62 @@ } }, "attributes": { + "class": "sprite", + "method": "quad_collision", "group": "physics", - "static": "vector_2d" + "static": "collisions", + "self": "s" }, "signatures": { - "python": [ - "def vector_from_line(l):" - ], "cpp": [ - "vector_2d vector_from_line(const line &l)" + "bool sprite_quad_collision(sprite s, const quad &q)" + ], + "python": [ + "def sprite_quad_collision(s, q):" ], "csharp": [ - "public static Vector2D SplashKit.VectorFromLine(Line l);" + "public bool Sprite.QuadCollision(Quad q);", + "public static bool SplashKit.SpriteQuadCollision(Sprite s, Quad q);" ], "pascal": [ - "function VectorFromLine(const l: Line): Vector2D" + "function SpriteQuadCollision(s: Sprite; const q: Quad): Boolean" ] } }, { - "signature": "vector_2d vector_from_point_to_rect(const point_2d &pt,const rectangle &rect);", - "name": "vector_from_point_to_rect", - "method_name": null, - "unique_global_name": "vector_from_point_to_rect", - "unique_method_name": null, + "signature": "bool sprite_ray_collision(sprite s,const point_2d &origin,const vector_2d &heading);", + "name": "sprite_ray_collision", + "method_name": "ray_collision", + "unique_global_name": "sprite_ray_collision", + "unique_method_name": "sprite.ray_collision", "suffix_name": null, - "description": "Returns a vector from a point to a rectangle.", + "description": "Tests if a sprite is drawn along a given ray.", "brief": null, "return": { - "type": "vector_2d", - "description": "A vector representing the distance and direction from `pt`\nto `rect`", + "type": "bool", + "description": "True if the sprite is drawn along the ray", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { + "s": { + "type": "sprite", + "description": "The sprite to test", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "origin": { "type": "point_2d", - "description": "The point", + "description": "The origin of the ray", "is_pointer": false, "is_const": true, "is_reference": true, @@ -72803,9 +69823,9 @@ "is_vector": false, "type_parameter": null }, - "rect": { - "type": "rectangle", - "description": "The rectangle", + "heading": { + "type": "vector_2d", + "description": "The heading of the ray", "is_pointer": false, "is_const": true, "is_reference": true, @@ -72818,48 +69838,52 @@ } }, "attributes": { + "class": "sprite", + "method": "ray_collision", "group": "physics", - "static": "vector_2d" + "static": "collisions", + "self": "s" }, "signatures": { - "python": [ - "def vector_from_point_to_rect(pt, rect):" - ], "cpp": [ - "vector_2d vector_from_point_to_rect(const point_2d &pt, const rectangle &rect)" + "bool sprite_ray_collision(sprite s, const point_2d &origin, const vector_2d &heading)" + ], + "python": [ + "def sprite_ray_collision(s, origin, heading):" ], "csharp": [ - "public static Vector2D SplashKit.VectorFromPointToRect(Point2D pt, Rectangle rect);" + "public bool Sprite.RayCollision(Point2D origin, Vector2D heading);", + "public static bool SplashKit.SpriteRayCollision(Sprite s, Point2D origin, Vector2D heading);" ], "pascal": [ - "function VectorFromPointToRect(const pt: Point2D; const rect: Rectangle): Vector2D" + "function SpriteRayCollision(s: Sprite; const origin: Point2D; const heading: Vector2D): Boolean" ] } }, { - "signature": "bool vector_in_rect(const vector_2d &v,const rectangle &rect);", - "name": "vector_in_rect", - "method_name": null, - "unique_global_name": "vector_in_rect", - "unique_method_name": null, + "signature": "bool sprite_rectangle_collision(sprite s,const rectangle &rect);", + "name": "sprite_rectangle_collision", + "method_name": "rectangle_collision", + "unique_global_name": "sprite_rectangle_collision", + "unique_method_name": "sprite.rectangle_collision", "suffix_name": null, - "description": "Returns true if the resulting vector would end in the rectangle if\nplaced at the origin.", + "description": "Tests if a sprite is drawn within an given area (rectangle).", "brief": null, "return": { "type": "bool", - "description": "True if the vector would end in the rectangle", + "description": "True if the sprite it drawn in the rectangle area", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v": { - "type": "vector_2d", - "description": "The vector", + "s": { + "type": "sprite", + "description": "The sprite to test", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -72869,7 +69893,7 @@ }, "rect": { "type": "rectangle", - "description": "The rectangle", + "description": "The rectangle to check", "is_pointer": false, "is_const": true, "is_reference": true, @@ -72882,45 +69906,62 @@ } }, "attributes": { + "class": "sprite", + "method": "rectangle_collision", "group": "physics", - "static": "vector_2d" + "static": "collisions", + "self": "s" }, "signatures": { - "python": [ - "def vector_in_rect(v, rect):" - ], "cpp": [ - "bool vector_in_rect(const vector_2d &v, const rectangle &rect)" + "bool sprite_rectangle_collision(sprite s, const rectangle &rect)" + ], + "python": [ + "def sprite_rectangle_collision(s, rect):" ], "csharp": [ - "public static bool SplashKit.VectorInRect(Vector2D v, Rectangle rect);" + "public bool Sprite.RectangleCollision(Rectangle rect);", + "public static bool SplashKit.SpriteRectangleCollision(Sprite s, Rectangle rect);" ], "pascal": [ - "function VectorInRect(const v: Vector2D; const rect: Rectangle): Boolean" + "function SpriteRectangleCollision(s: Sprite; const rect: Rectangle): Boolean" ] } }, { - "signature": "vector_2d vector_invert(const vector_2d &v);", - "name": "vector_invert", - "method_name": null, - "unique_global_name": "vector_invert", - "unique_method_name": null, + "signature": "bool sprite_triangle_collision(sprite s,const triangle &t);", + "name": "sprite_triangle_collision", + "method_name": "triangle_collision", + "unique_global_name": "sprite_triangle_collision", + "unique_method_name": "sprite.triangle_collision", "suffix_name": null, - "description": "Returns a new Vector that is an inverted version of the parameter\nvector (v). In other words, the -/+ sign of the x and y values are changed.", + "description": "Tests if a sprite is drawn within an given area (triangle).", "brief": null, "return": { - "type": "vector_2d", - "description": "The inverse (reverse) of `v`", + "type": "bool", + "description": "True if the sprite it drawn in the triangle area", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v": { - "type": "vector_2d", - "description": "The vector", + "s": { + "type": "sprite", + "description": "The sprite to test", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "t": { + "type": "triangle", + "description": "The triangle to check", "is_pointer": false, "is_const": true, "is_reference": true, @@ -72933,45 +69974,49 @@ } }, "attributes": { + "class": "sprite", + "method": "triangle_collision", "group": "physics", - "static": "vector_2d" + "static": "collisions", + "self": "s" }, "signatures": { - "python": [ - "def vector_invert(v):" - ], "cpp": [ - "vector_2d vector_invert(const vector_2d &v)" + "bool sprite_triangle_collision(sprite s, const triangle &t)" + ], + "python": [ + "def sprite_triangle_collision(s, t):" ], "csharp": [ - "public static Vector2D SplashKit.VectorInvert(Vector2D v);" + "public bool Sprite.TriangleCollision(Triangle t);", + "public static bool SplashKit.SpriteTriangleCollision(Sprite s, Triangle t);" ], "pascal": [ - "function VectorInvert(const v: Vector2D): Vector2D" + "function SpriteTriangleCollision(s: Sprite; const t: Triangle): Boolean" ] } }, { - "signature": "vector_2d vector_limit(const vector_2d &v,double limit);", - "name": "vector_limit", + "signature": "void apply_matrix(const matrix_2d &matrix,quad &q);", + "name": "apply_matrix", "method_name": null, - "unique_global_name": "vector_limit", + "unique_global_name": "apply_matrix_to_quad", "unique_method_name": null, "suffix_name": null, - "description": "Returns a scaled vector that ensures the new vector points\nin the same direction as v, but has a magnitude that is\nlimited to the length specified in the limit prameter.", + "description": "Use a matrix to transform all of the points in a quad.", "brief": null, "return": { - "type": "vector_2d", - "description": "A new vector in the same direction as v, but with a\nmagnitude that is less than or equal to the limit.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v": { - "type": "vector_2d", - "description": "The vector", + "matrix": { + "type": "matrix_2d", + "description": "The matrix with the transformations needed.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -72982,12 +70027,12 @@ "is_vector": false, "type_parameter": null }, - "limit": { - "type": "double", - "description": "Its maximum magnitude", + "q": { + "type": "quad", + "description": "The quad to transform.", "is_pointer": false, "is_const": false, - "is_reference": false, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -72997,45 +70042,46 @@ } }, "attributes": { + "suffix": "to_quad", "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vector_limit(v, limit):" - ], "cpp": [ - "vector_2d vector_limit(const vector_2d &v, double limit)" + "void apply_matrix(const matrix_2d &matrix, quad &q)" + ], + "python": [ + "def apply_matrix_to_quad(matrix, q):" ], "csharp": [ - "public static Vector2D SplashKit.VectorLimit(Vector2D v, double limit);" + "public static void SplashKit.ApplyMatrix(Matrix2D matrix, ref Quad q);" ], "pascal": [ - "function VectorLimit(const v: Vector2D; limit: Double): Vector2D" + "procedure ApplyMatrix(const matrix: Matrix2D; var q: Quad)" ] } }, { - "signature": "double vector_magnitude(const vector_2d &v);", - "name": "vector_magnitude", + "signature": "void apply_matrix(const matrix_2d &m,triangle &tri);", + "name": "apply_matrix", "method_name": null, - "unique_global_name": "vector_magnitude", + "unique_global_name": "apply_matrix_to_triangle", "unique_method_name": null, "suffix_name": null, - "description": "Returns the magnitude (or \"length\") of the vector.", + "description": "Use a matrix to transform all of the points in a triangle.", "brief": null, "return": { - "type": "double", - "description": "Its magnitude", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v": { - "type": "vector_2d", - "description": "The vector", + "m": { + "type": "matrix_2d", + "description": "The matrix to be applied to the triangle.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -73045,50 +70091,12 @@ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "group": "physics", - "static": "vector_2d" - }, - "signatures": { - "python": [ - "def vector_magnitude(v):" - ], - "cpp": [ - "double vector_magnitude(const vector_2d &v)" - ], - "csharp": [ - "public static double SplashKit.VectorMagnitude(Vector2D v);" - ], - "pascal": [ - "function VectorMagnitude(const v: Vector2D): Double" - ] - } - }, - { - "signature": "double vector_magnitude_squared(const vector_2d &v);", - "name": "vector_magnitude_squared", - "method_name": null, - "unique_global_name": "vector_magnitude_squared", - "unique_method_name": null, - "suffix_name": null, - "description": "Returns the squared magnitude (or \"length\") of the vector.", - "brief": null, - "return": { - "type": "double", - "description": "Its squared magnitude", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "v": { - "type": "vector_2d", - "description": "The vector", + }, + "tri": { + "type": "triangle", + "description": "The triangle to tranform.", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -73099,109 +70107,84 @@ } }, "attributes": { + "suffix": "to_triangle", "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vector_magnitude_squared(v):" - ], "cpp": [ - "double vector_magnitude_squared(const vector_2d &v)" + "void apply_matrix(const matrix_2d &m, triangle &tri)" + ], + "python": [ + "def apply_matrix_to_triangle(m, tri):" ], "csharp": [ - "public static double SplashKit.VectorMagnitudeSquared(Vector2D v);" + "public static void SplashKit.ApplyMatrix(Matrix2D m, ref Triangle tri);" ], "pascal": [ - "function VectorMagnitudeSquared(const v: Vector2D): Double" + "procedure ApplyMatrix(const m: Matrix2D; var tri: Triangle)" ] } }, { - "signature": "vector_2d vector_multiply(const vector_2d &v1,double s);", - "name": "vector_multiply", + "signature": "matrix_2d identity_matrix();", + "name": "identity_matrix", "method_name": null, - "unique_global_name": "vector_multiply", + "unique_global_name": "identity_matrix", "unique_method_name": null, "suffix_name": null, - "description": "Multiplies the vector by the passed in value.", + "description": "Returns the identity matrix. When a matrix_2d or Vector is multiplied by\nthe identity matrix the result is the original matrix or vector.", "brief": null, "return": { - "type": "vector_2d", - "description": "A new vector", + "type": "matrix_2d", + "description": "An identify matrix.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v1": { - "type": "vector_2d", - "description": "The original vector", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "s": { - "type": "double", - "description": "The amount to multiply by", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vector_multiply(v1, s):" - ], "cpp": [ - "vector_2d vector_multiply(const vector_2d &v1, double s)" + "matrix_2d identity_matrix()" + ], + "python": [ + "def identity_matrix():" ], "csharp": [ - "public static Vector2D SplashKit.VectorMultiply(Vector2D v1, double s);" + "public static Matrix2D SplashKit.IdentityMatrix();" ], "pascal": [ - "function VectorMultiply(const v1: Vector2D; s: Double): Vector2D" + "function IdentityMatrix(): Matrix2D" ] } }, { - "signature": "vector_2d vector_normal(const vector_2d &v);", - "name": "vector_normal", + "signature": "matrix_2d matrix_inverse(const matrix_2d &m);", + "name": "matrix_inverse", "method_name": null, - "unique_global_name": "vector_normal", + "unique_global_name": "matrix_inverse", "unique_method_name": null, "suffix_name": null, - "description": "Returns a new `vector_2d` that is perpendicular (\"normal\") to the parameter\nvector `v` provided. The concept of a \"normal\" vector is usually\nextracted from (or associated with) a line.\n\nNote: when passed a zero or null vector (a vector with no\nmagnitude or direction) then this function returns a zero/null vector.", + "description": "Calculate the inverse of a matrix.", "brief": null, "return": { - "type": "vector_2d", - "description": "The normal of `v`", + "type": "matrix_2d", + "description": "A matrix that is the inverse of m", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v": { - "type": "vector_2d", - "description": "The vector", + "m": { + "type": "matrix_2d", + "description": "The matrix to invert.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -73215,57 +70198,44 @@ }, "attributes": { "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vector_normal(v):" - ], "cpp": [ - "vector_2d vector_normal(const vector_2d &v)" + "matrix_2d matrix_inverse(const matrix_2d &m)" + ], + "python": [ + "def matrix_inverse(m):" ], "csharp": [ - "public static Vector2D SplashKit.VectorNormal(Vector2D v);" + "public static Matrix2D SplashKit.MatrixInverse(Matrix2D m);" ], "pascal": [ - "function VectorNormal(const v: Vector2D): Vector2D" + "function MatrixInverse(const m: Matrix2D): Matrix2D" ] } }, { - "signature": "vector_2d vector_out_of_circle_from_circle(const circle &src,const circle &bounds,const vector_2d &velocity);", - "name": "vector_out_of_circle_from_circle", + "signature": "point_2d matrix_multiply(const matrix_2d &m,const point_2d &pt);", + "name": "matrix_multiply", "method_name": null, - "unique_global_name": "vector_out_of_circle_from_circle", + "unique_global_name": "matrix_multiply_point", "unique_method_name": null, "suffix_name": null, - "description": "Returns a vector to back one circle out of another, assuming the first circle was\nmoving at a specified velocity.", + "description": "Multiplies the `point_2d` parameter `v with the `matrix_2d` `m and\nreturns the result as a `point_2d`. Use this to transform the vector with\nthe matrix (to apply scaling, rotation or translation effects).", "brief": null, "return": { - "type": "vector_2d", - "description": "A vector that can move the circle out of the bounds", + "type": "point_2d", + "description": "A new point, the result of applying the transformation to pt.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "src": { - "type": "circle", - "description": "The circle that is moving", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "bounds": { - "type": "circle", - "description": "The area you want to move the circle out of", + "m": { + "type": "matrix_2d", + "description": "The matrix with the transformation to apply.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -73276,9 +70246,9 @@ "is_vector": false, "type_parameter": null }, - "velocity": { - "type": "vector_2d", - "description": "The circle's velocity", + "pt": { + "type": "point_2d", + "description": "The point to be transformed.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -73291,58 +70261,46 @@ } }, "attributes": { + "suffix": "point", "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vector_out_of_circle_from_circle(src, bounds, velocity):" - ], "cpp": [ - "vector_2d vector_out_of_circle_from_circle(const circle &src, const circle &bounds, const vector_2d &velocity)" + "point_2d matrix_multiply(const matrix_2d &m, const point_2d &pt)" + ], + "python": [ + "def matrix_multiply_point(m, pt):" ], "csharp": [ - "public static Vector2D SplashKit.VectorOutOfCircleFromCircle(Circle src, Circle bounds, Vector2D velocity);" + "public static Point2D SplashKit.MatrixMultiply(Matrix2D m, Point2D pt);" ], "pascal": [ - "function VectorOutOfCircleFromCircle(const src: Circle; const bounds: Circle; const velocity: Vector2D): Vector2D" + "function MatrixMultiply(const m: Matrix2D; const pt: Point2D): Point2D" ] } }, { - "signature": "vector_2d vector_out_of_circle_from_point(const point_2d &pt,const circle &c,const vector_2d &velocity);", - "name": "vector_out_of_circle_from_point", + "signature": "matrix_2d matrix_multiply(const matrix_2d &m1,const matrix_2d &m2);", + "name": "matrix_multiply", "method_name": null, - "unique_global_name": "vector_out_of_circle_from_point", + "unique_global_name": "matrix_multiply_matrix", "unique_method_name": null, "suffix_name": null, - "description": "Returns the vector out to move a point back out of a circle,\ngiven the point was moving at the specified velocity.", + "description": "Multiplies the two `matrix_2d` parameters, `m1` by `m2`, and returns\nthe result as a new `matrix_2d`. Use this to combine the effects to two\nmatrix transformations.", "brief": null, "return": { - "type": "vector_2d", - "description": "A vector that can move the point out of the circle", + "type": "matrix_2d", + "description": "The result of multiplying m1 by m2", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { - "type": "point_2d", - "description": "The point that is moving", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "c": { - "type": "circle", - "description": "The circle you want to move the point out of", + "m1": { + "type": "matrix_2d", + "description": "The first matrix", "is_pointer": false, "is_const": true, "is_reference": true, @@ -73353,9 +70311,9 @@ "is_vector": false, "type_parameter": null }, - "velocity": { - "type": "vector_2d", - "description": "The point's velocity", + "m2": { + "type": "matrix_2d", + "description": "The second matrix", "is_pointer": false, "is_const": true, "is_reference": true, @@ -73368,58 +70326,46 @@ } }, "attributes": { + "suffix": "matrix", "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vector_out_of_circle_from_point(pt, c, velocity):" - ], "cpp": [ - "vector_2d vector_out_of_circle_from_point(const point_2d &pt, const circle &c, const vector_2d &velocity)" + "matrix_2d matrix_multiply(const matrix_2d &m1, const matrix_2d &m2)" + ], + "python": [ + "def matrix_multiply_matrix(m1, m2):" ], "csharp": [ - "public static Vector2D SplashKit.VectorOutOfCircleFromPoint(Point2D pt, Circle c, Vector2D velocity);" + "public static Matrix2D SplashKit.MatrixMultiply(Matrix2D m1, Matrix2D m2);" ], "pascal": [ - "function VectorOutOfCircleFromPoint(const pt: Point2D; const c: Circle; const velocity: Vector2D): Vector2D" + "function MatrixMultiply(const m1: Matrix2D; const m2: Matrix2D): Matrix2D" ] } }, { - "signature": "vector_2d vector_out_of_rect_from_circle(const circle &c,const rectangle &rect,const vector_2d &velocity);", - "name": "vector_out_of_rect_from_circle", + "signature": "vector_2d matrix_multiply(const matrix_2d &m,const vector_2d &v);", + "name": "matrix_multiply", "method_name": null, - "unique_global_name": "vector_out_of_rect_from_circle", + "unique_global_name": "matrix_multiply_vector", "unique_method_name": null, "suffix_name": null, - "description": "Returns a vector that can be used to move a circle back out of a rectangle,\ngiven that the circle is moving at the specified velocity.", + "description": "Multiplies the `Vector` parameter `v` with the `matrix_2d` `m` and\nreturns the result as a `Vector`. Use this to transform the vector with\nthe matrix (to apply scaling, rotation or translation effects).", "brief": null, "return": { "type": "vector_2d", - "description": "A vector that will move the circle out of the rectangle", + "description": "A new vector, the result of applying the transformation to v.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "c": { - "type": "circle", - "description": "The circle that is moving", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "The area you wan to move the circle out of", + "m": { + "type": "matrix_2d", + "description": "The matrix with the transformation to apply.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -73430,9 +70376,9 @@ "is_vector": false, "type_parameter": null }, - "velocity": { + "v": { "type": "vector_2d", - "description": "The circle's velocity", + "description": "The vector to be transformed.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -73445,71 +70391,46 @@ } }, "attributes": { + "suffix": "vector", "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vector_out_of_rect_from_circle(c, rect, velocity):" - ], "cpp": [ - "vector_2d vector_out_of_rect_from_circle(const circle &c, const rectangle &rect, const vector_2d &velocity)" + "vector_2d matrix_multiply(const matrix_2d &m, const vector_2d &v)" + ], + "python": [ + "def matrix_multiply_vector(m, v):" ], "csharp": [ - "public static Vector2D SplashKit.VectorOutOfRectFromCircle(Circle c, Rectangle rect, Vector2D velocity);" + "public static Vector2D SplashKit.MatrixMultiply(Matrix2D m, Vector2D v);" ], "pascal": [ - "function VectorOutOfRectFromCircle(const c: Circle; const rect: Rectangle; const velocity: Vector2D): Vector2D" + "function MatrixMultiply(const m: Matrix2D; const v: Vector2D): Vector2D" ] } }, { - "signature": "vector_2d vector_out_of_rect_from_point(const point_2d &pt,const rectangle &rect,const vector_2d &velocity);", - "name": "vector_out_of_rect_from_point", + "signature": "string matrix_to_string(const matrix_2d &matrix);", + "name": "matrix_to_string", "method_name": null, - "unique_global_name": "vector_out_of_rect_from_point", + "unique_global_name": "matrix_to_string", "unique_method_name": null, "suffix_name": null, - "description": "Determines the vector needed to move back from point `pt` out of rectangle `rect` given\nthe point was moving at the velocity specified.", + "description": "This function returns a string representation of a Matrix.", "brief": null, "return": { - "type": "vector_2d", - "description": "A vector that can move the point outside of the\nrectangle.", + "type": "string", + "description": "A string representation of the matrix.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pt": { - "type": "point_2d", - "description": "The point you want to move out of a rectangle", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "rect": { - "type": "rectangle", - "description": "The rectangle to move out of", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "velocity": { - "type": "vector_2d", - "description": "The velocity of the point. This is used to determine\nwhere the point should return to.", + "matrix": { + "type": "matrix_2d", + "description": "The matrix to convert to a string.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -73523,73 +70444,47 @@ }, "attributes": { "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vector_out_of_rect_from_point(pt, rect, velocity):" - ], "cpp": [ - "vector_2d vector_out_of_rect_from_point(const point_2d &pt, const rectangle &rect, const vector_2d &velocity)" + "string matrix_to_string(const matrix_2d &matrix)" + ], + "python": [ + "def matrix_to_string(matrix):" ], "csharp": [ - "public static Vector2D SplashKit.VectorOutOfRectFromPoint(Point2D pt, Rectangle rect, Vector2D velocity);" + "public static string SplashKit.MatrixToString(Matrix2D matrix);" ], "pascal": [ - "function VectorOutOfRectFromPoint(const pt: Point2D; const rect: Rectangle; const velocity: Vector2D): Vector2D" + "function MatrixToString(const matrix: Matrix2D): String" ] } }, { - "signature": "vector_2d vector_out_of_rect_from_rect(const rectangle &src,const rectangle &bounds,const vector_2d &velocity);", - "name": "vector_out_of_rect_from_rect", + "signature": "matrix_2d rotation_matrix(double deg);", + "name": "rotation_matrix", "method_name": null, - "unique_global_name": "vector_out_of_rect_from_rect", + "unique_global_name": "rotation_matrix", "unique_method_name": null, "suffix_name": null, - "description": "Returns the vector needed to move rectangle `src` back out of rectangle `bounds`\nassuming the rectangle was moving at the velocity specified.", + "description": "Returns a rotation matrix that rotates 2d points by the angle.", "brief": null, "return": { - "type": "vector_2d", - "description": "A vector that can move the rectangle out of the bounds", + "type": "matrix_2d", + "description": "A matrix that encodes the rotation by a number of degrees.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "src": { - "type": "rectangle", - "description": "The rectangle you want to move.", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "bounds": { - "type": "rectangle", - "description": "The area you want to move the rectangle out of", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "velocity": { - "type": "vector_2d", - "description": "The velocity of the `src` rectangle", + "deg": { + "type": "double", + "description": "The amount to rotate points", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -73600,57 +70495,44 @@ }, "attributes": { "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vector_out_of_rect_from_rect(src, bounds, velocity):" - ], "cpp": [ - "vector_2d vector_out_of_rect_from_rect(const rectangle &src, const rectangle &bounds, const vector_2d &velocity)" + "matrix_2d rotation_matrix(double deg)" + ], + "python": [ + "def rotation_matrix(deg):" ], "csharp": [ - "public static Vector2D SplashKit.VectorOutOfRectFromRect(Rectangle src, Rectangle bounds, Vector2D velocity);" + "public static Matrix2D SplashKit.RotationMatrix(double deg);" ], "pascal": [ - "function VectorOutOfRectFromRect(const src: Rectangle; const bounds: Rectangle; const velocity: Vector2D): Vector2D" + "function RotationMatrix(deg: Double): Matrix2D" ] } }, { - "signature": "vector_2d vector_point_to_point(const point_2d &start,const point_2d &end_pt);", - "name": "vector_point_to_point", + "signature": "matrix_2d scale_matrix(const point_2d &scale);", + "name": "scale_matrix", "method_name": null, - "unique_global_name": "vector_point_to_point", + "unique_global_name": "scale_matrix_from_point", "unique_method_name": null, "suffix_name": null, - "description": "Returns a `vector_2d` created from the difference from the `p1` to\nthe second `p2` points (`Point2D`).", + "description": "Create a scale matrix that scales x and y to\ndifferent degrees.", "brief": null, "return": { - "type": "vector_2d", - "description": "A vector that will move things from the starting point to\nthe ending point", + "type": "matrix_2d", + "description": "A matrix that will scale points based on scale parameter.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "start": { - "type": "point_2d", - "description": "The starting point", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "end_pt": { + "scale": { "type": "point_2d", - "description": "The ending point", + "description": "The amount to scale, with separate x and y components.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -73663,58 +70545,46 @@ } }, "attributes": { + "suffix": "from_point", "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vector_point_to_point(start, end_pt):" - ], "cpp": [ - "vector_2d vector_point_to_point(const point_2d &start, const point_2d &end_pt)" + "matrix_2d scale_matrix(const point_2d &scale)" + ], + "python": [ + "def scale_matrix_from_point(scale):" ], "csharp": [ - "public static Vector2D SplashKit.VectorPointToPoint(Point2D start, Point2D endPt);" + "public static Matrix2D SplashKit.ScaleMatrix(Point2D scale);" ], "pascal": [ - "function VectorPointToPoint(const start: Point2D; const endPt: Point2D): Vector2D" + "function ScaleMatrix(const scale: Point2D): Matrix2D" ] } }, { - "signature": "vector_2d vector_subtract(const vector_2d &v1,const vector_2d &v2);", - "name": "vector_subtract", + "signature": "matrix_2d scale_matrix(const vector_2d &scale);", + "name": "scale_matrix", "method_name": null, - "unique_global_name": "vector_subtract", + "unique_global_name": "scale_matrix_from_vector", "unique_method_name": null, "suffix_name": null, - "description": "Subtracts the second vector parameter (`v2`) from the first vector\n(`v1`) and returns the result as new `vector_2d`.", + "description": "Create a scale matrix that scales x and y to\ndifferent degrees.", "brief": null, "return": { - "type": "vector_2d", - "description": "The result of subtracting the movements of `v2` from `v1`.", + "type": "matrix_2d", + "description": "A matrix that will scale points based on scale parameter.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v1": { - "type": "vector_2d", - "description": "The first vector.", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "v2": { + "scale": { "type": "vector_2d", - "description": "The other vector.", + "description": "The amount to scale, with separate x and y components.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -73727,48 +70597,49 @@ } }, "attributes": { + "suffix": "from_vector", "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vector_subtract(v1, v2):" - ], "cpp": [ - "vector_2d vector_subtract(const vector_2d &v1, const vector_2d &v2)" + "matrix_2d scale_matrix(const vector_2d &scale)" + ], + "python": [ + "def scale_matrix_from_vector(scale):" ], "csharp": [ - "public static Vector2D SplashKit.VectorSubtract(Vector2D v1, Vector2D v2);" + "public static Matrix2D SplashKit.ScaleMatrix(Vector2D scale);" ], "pascal": [ - "function VectorSubtract(const v1: Vector2D; const v2: Vector2D): Vector2D" + "function ScaleMatrix(const scale: Vector2D): Matrix2D" ] } }, { - "signature": "vector_2d vector_to(const point_2d &p1);", - "name": "vector_to", + "signature": "matrix_2d scale_matrix(double scale);", + "name": "scale_matrix", "method_name": null, - "unique_global_name": "vector_to_point", + "unique_global_name": "scale_matrix", "unique_method_name": null, "suffix_name": null, - "description": "Returns a new `vector_2d` using the x and y value of a `point_2d` parameter.\nThis is a vector from the origin to that point.", + "description": "Returns a matrix that can be used to scale 2d points (both x and y).", "brief": null, "return": { - "type": "vector_2d", - "description": "A vector from the origin to `p1`", + "type": "matrix_2d", + "description": "A matrix to scale points by.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "p1": { - "type": "point_2d", - "description": "The point", + "scale": { + "type": "double", + "description": "The amount to scale points by.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -73778,49 +70649,48 @@ } }, "attributes": { - "suffix": "point", "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vector_to_point(p1):" - ], "cpp": [ - "vector_2d vector_to(const point_2d &p1)" + "matrix_2d scale_matrix(double scale)" + ], + "python": [ + "def scale_matrix(scale):" ], "csharp": [ - "public static Vector2D SplashKit.VectorTo(Point2D p1);" + "public static Matrix2D SplashKit.ScaleMatrix(double scale);" ], "pascal": [ - "function VectorTo(const p1: Point2D): Vector2D" + "function ScaleMatrix(scale: Double): Matrix2D" ] } }, { - "signature": "vector_2d vector_to(double x,double y);", - "name": "vector_to", + "signature": "matrix_2d scale_rotate_translate_matrix(const point_2d &scale,double deg,const point_2d &translate);", + "name": "scale_rotate_translate_matrix", "method_name": null, - "unique_global_name": "vector_to", + "unique_global_name": "scale_rotate_translate_matrix", "unique_method_name": null, "suffix_name": null, - "description": "Returns a vector to the indicated point.", + "description": "Create a matrix that can scale, rotate then translate geometry points.", "brief": null, "return": { - "type": "vector_2d", - "description": "A vector that will move things the indicated amount", + "type": "matrix_2d", + "description": "A matrix that will scale, rotate, and translate.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "x": { - "type": "double", - "description": "The amount to move horizontally", + "scale": { + "type": "point_2d", + "description": "The amount to scale", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -73828,15 +70698,28 @@ "is_vector": false, "type_parameter": null }, - "y": { + "deg": { "type": "double", - "description": "The amount to move vertically", + "description": "The amount to rotate", "is_pointer": false, "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ + ], + "is_vector": false, + "type_parameter": null + }, + "translate": { + "type": "point_2d", + "description": "The amount to move", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + ], "is_vector": false, "type_parameter": null @@ -73844,44 +70727,44 @@ }, "attributes": { "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vector_to(x, y):" - ], "cpp": [ - "vector_2d vector_to(double x, double y)" + "matrix_2d scale_rotate_translate_matrix(const point_2d &scale, double deg, const point_2d &translate)" + ], + "python": [ + "def scale_rotate_translate_matrix(scale, deg, translate):" ], "csharp": [ - "public static Vector2D SplashKit.VectorTo(double x, double y);" + "public static Matrix2D SplashKit.ScaleRotateTranslateMatrix(Point2D scale, double deg, Point2D translate);" ], "pascal": [ - "function VectorTo(x: Double; y: Double): Vector2D" + "function ScaleRotateTranslateMatrix(const scale: Point2D; deg: Double; const translate: Point2D): Matrix2D" ] } }, { - "signature": "string vector_to_string(const vector_2d &v);", - "name": "vector_to_string", + "signature": "matrix_2d translation_matrix(const point_2d &pt);", + "name": "translation_matrix", "method_name": null, - "unique_global_name": "vector_to_string", + "unique_global_name": "translation_matrix_to_point", "unique_method_name": null, "suffix_name": null, - "description": "Get a text description of the `vector_2d`.", + "description": "Returns a translation matric used to translate 2d points by the\ndistance in the point_2d.", "brief": null, "return": { - "type": "string", - "description": "A string representation of the vector", + "type": "matrix_2d", + "description": "A matrix that will move points by amount in pt", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v": { - "type": "vector_2d", - "description": "The vector", + "pt": { + "type": "point_2d", + "description": "The point to translate to.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -73894,112 +70777,101 @@ } }, "attributes": { + "suffix": "to_point", "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vector_to_string(v):" - ], "cpp": [ - "string vector_to_string(const vector_2d &v)" + "matrix_2d translation_matrix(const point_2d &pt)" + ], + "python": [ + "def translation_matrix_to_point(pt):" ], "csharp": [ - "public static string SplashKit.VectorToString(Vector2D v);" + "public static Matrix2D SplashKit.TranslationMatrix(Point2D pt);" ], "pascal": [ - "function VectorToString(const v: Vector2D): String" + "function TranslationMatrix(const pt: Point2D): Matrix2D" ] } }, { - "signature": "bool vectors_equal(const vector_2d &v1,const vector_2d v2);", - "name": "vectors_equal", + "signature": "matrix_2d translation_matrix(const vector_2d &pt);", + "name": "translation_matrix", "method_name": null, - "unique_global_name": "vectors_equal", + "unique_global_name": "translation_matrix_from_vector", "unique_method_name": null, "suffix_name": null, - "description": "Determines if two vectors are the same.", + "description": "Returns a translation matric used to translate 2d points by the\ndistance in the vector_2d.", "brief": null, "return": { - "type": "bool", - "description": "True if the two vectors are equal.", + "type": "matrix_2d", + "description": "A matrix that will move points by amount in pt", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v1": { + "pt": { "type": "vector_2d", - "description": "The first vector", + "description": "The point to translate to.", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "v2": { - "type": "vector_2d", - "description": "The other vector", - "is_pointer": false, - "is_const": true, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { + "suffix": "from_vector", "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vectors_equal(v1, v2):" - ], "cpp": [ - "bool vectors_equal(const vector_2d &v1, const vector_2d v2)" + "matrix_2d translation_matrix(const vector_2d &pt)" + ], + "python": [ + "def translation_matrix_from_vector(pt):" ], "csharp": [ - "public static bool SplashKit.VectorsEqual(Vector2D v1, Vector2D v2);" + "public static Matrix2D SplashKit.TranslationMatrix(Vector2D pt);" ], "pascal": [ - "function VectorsEqual(const v1: Vector2D; v2: Vector2D): Boolean" + "function TranslationMatrix(const pt: Vector2D): Matrix2D" ] } }, { - "signature": "bool vectors_not_equal(const vector_2d &v1,const vector_2d v2);", - "name": "vectors_not_equal", + "signature": "matrix_2d translation_matrix(double dx,double dy);", + "name": "translation_matrix", "method_name": null, - "unique_global_name": "vectors_not_equal", + "unique_global_name": "translation_matrix", "unique_method_name": null, "suffix_name": null, - "description": "Determines if two vectors are not the same.", + "description": "Returns a matrix that can be used to translate 2d points. Moving them\nby dx and dy.", "brief": null, "return": { - "type": "bool", - "description": "True if the two vectors are different.", + "type": "matrix_2d", + "description": "A matrix that will move points by dx, dy", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "v1": { - "type": "vector_2d", - "description": "The first vector", + "dx": { + "type": "double", + "description": "The amount to move points along the x axis.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -74007,11 +70879,11 @@ "is_vector": false, "type_parameter": null }, - "v2": { - "type": "vector_2d", - "description": "The other vector", + "dy": { + "type": "double", + "description": "The amount to move points along the y axis.", "is_pointer": false, - "is_const": true, + "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -74023,97 +70895,57 @@ }, "attributes": { "group": "physics", - "static": "vector_2d" + "static": "matrix_2d" }, "signatures": { - "python": [ - "def vectors_not_equal(v1, v2):" - ], "cpp": [ - "bool vectors_not_equal(const vector_2d &v1, const vector_2d v2)" + "matrix_2d translation_matrix(double dx, double dy)" + ], + "python": [ + "def translation_matrix(dx, dy):" ], "csharp": [ - "public static bool SplashKit.VectorsNotEqual(Vector2D v1, Vector2D v2);" + "public static Matrix2D SplashKit.TranslationMatrix(double dx, double dy);" ], "pascal": [ - "function VectorsNotEqual(const v1: Vector2D; v2: Vector2D): Boolean" + "function TranslationMatrix(dx: Double; dy: Double): Matrix2D" ] } - } - ], - "typedefs": [ - - ], - "structs": [ - { - "signature": "struct matrix_2d {double elements[3][3];};", - "name": "matrix_2d", - "description": "In SplashKit, matrices can be used to combine together a number of\noperations that need to be performed on `vector_2d` values. You can\ntranslate, rotate and scale, and combine these together into a\nsingle matrix that can then be applied to vectors and points.", - "brief": null, - "fields": { - "elements": { - "type": "double", - "description": "The elements of the matrix", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": true, - "array_dimension_sizes": [ - 3, - 3 - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "physics", - "static": "matrix_2d" - }, - "properties": { - }, - "constructors": [ - - ], - "methods": [ - - ], - "is_alias": false, - "is_struct": true - } - ], - "enums": [ - - ], - "defines": [ - - ] - }, - "raspberry": { - "brief": "Provides support for using an ADC device with the GPIO pins on the Raspberry Pi.Splashkit allows you to read and write to the GPIO pins on the Raspberry Pi.Provides support for using a motor driver with the GPIO pins on the Raspberry Pi.Provides support for using servo motors with the GPIO pins on the Raspberry Pi.", - "description": "", - "functions": [ + }, { - "signature": "adc_device adc_device_named(const string &name);", - "name": "adc_device_named", + "signature": "double angle_between(const vector_2d &v1,const vector_2d &v2);", + "name": "angle_between", "method_name": null, - "unique_global_name": "adc_device_named", + "unique_global_name": "angle_between", "unique_method_name": null, "suffix_name": null, - "description": "Retrieve an ADC device that has been loaded.", + "description": "Calculates the angle from one vector to another.", "brief": null, "return": { - "type": "adc_device", - "description": "The adc_device pointer if found; otherwise, nullptr.", + "type": "double", + "description": "The angle of the line from the end of `v1` to the end of `v2`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name of the ADC device.", + "v1": { + "type": "vector_2d", + "description": "The first vector", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "v2": { + "type": "vector_2d", + "description": "The second vector", "is_pointer": false, "is_const": true, "is_reference": true, @@ -74126,101 +70958,109 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def adc_device_named(name):" - ], "cpp": [ - "adc_device adc_device_named(const string &name)" + "double angle_between(const vector_2d &v1, const vector_2d &v2)" + ], + "python": [ + "def angle_between(v1, v2):" ], "csharp": [ - "public static AdcDevice SplashKit.AdcDeviceNamed(string name);" + "public static double SplashKit.AngleBetween(Vector2D v1, Vector2D v2);" ], "pascal": [ - "function AdcDeviceNamed(const name: String): AdcDevice" + "function AngleBetween(const v1: Vector2D; const v2: Vector2D): Double" ] } }, { - "signature": "void close_adc(adc_device adc);", - "name": "close_adc", - "method_name": "close", - "unique_global_name": "close_adc", - "unique_method_name": "adc_device.close", + "signature": "double dot_product(const vector_2d &v1,const vector_2d &v2);", + "name": "dot_product", + "method_name": null, + "unique_global_name": "dot_product", + "unique_method_name": null, "suffix_name": null, - "description": "Closes an ADC device given its pointer.", + "description": "Calculates the dot product (scalar product) between the two vector\nparameters provided (`v1` and `v2`). It returns the result as a\nscalar value.\n\nIf the result is 0.0 it means that the vectors are orthogonal (at right\nangles to each other). If `v1` and `v2` are unit vectors (length of\n1.0) and the dot product is 1.0, it means that `v1` and `v2` vectors\nare parallel.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "double", + "description": "The dot product of `v1` . `v2`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "adc": { - "type": "adc_device", - "description": "The ADC device to close.", + "v1": { + "type": "vector_2d", + "description": "The first vector", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - } - }, - "attributes": { - "class": "adc_device", - "destructor": true, - "method": "close", - "self": "adc", - "group": "raspberry", - "static": "raspberry" + }, + "v2": { + "type": "vector_2d", + "description": "The other vector", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } + }, + "attributes": { + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def close_adc(adc):" - ], "cpp": [ - "void close_adc(adc_device adc)" + "double dot_product(const vector_2d &v1, const vector_2d &v2)" + ], + "python": [ + "def dot_product(v1, v2):" ], "csharp": [ - "public void AdcDevice.Close();", - "public static void SplashKit.CloseAdc(AdcDevice adc);" + "public static double SplashKit.DotProduct(Vector2D v1, Vector2D v2);" ], "pascal": [ - "procedure CloseAdc(adc: AdcDevice)" + "function DotProduct(const v1: Vector2D; const v2: Vector2D): Double" ] } }, { - "signature": "void close_adc(const string &name);", - "name": "close_adc", + "signature": "bool is_zero_vector(const vector_2d &v);", + "name": "is_zero_vector", "method_name": null, - "unique_global_name": "close_adc_named", + "unique_global_name": "is_zero_vector", "unique_method_name": null, "suffix_name": null, - "description": "Closes an ADC device given its name.", + "description": "Returns if the vector is a null/zero vector -- having no size or direction.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "True if `v` has no magnitude.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name of the ADC device to close.", + "v": { + "type": "vector_2d", + "description": "The vector", "is_pointer": false, "is_const": true, "is_reference": true, @@ -74233,84 +71073,135 @@ } }, "attributes": { - "suffix": "named", - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def close_adc_named(name):" - ], "cpp": [ - "void close_adc(const string &name)" + "bool is_zero_vector(const vector_2d &v)" + ], + "python": [ + "def is_zero_vector(v):" ], "csharp": [ - "public static void SplashKit.CloseAdc(string name);" + "public static bool SplashKit.IsZeroVector(Vector2D v);" ], "pascal": [ - "procedure CloseAdc(const name: String)" + "function IsZeroVector(const v: Vector2D): Boolean" ] } }, { - "signature": "void close_all_adc();", - "name": "close_all_adc", + "signature": "bool ray_intersection_point(const point_2d &from_pt,const vector_2d &heading,const line &l,point_2d &pt);", + "name": "ray_intersection_point", "method_name": null, - "unique_global_name": "close_all_adc", + "unique_global_name": "ray_intersection_point", "unique_method_name": null, "suffix_name": null, - "description": "Closes all ADC devices that have been opened.", + "description": "Casts a ray in a heading and returns true is it intersects with a line", "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "True if the line and ray will intersect, in which case\nthe value of `pt` will be changed to be the point where\nthe intersection occurs.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "from_pt": { + "type": "point_2d", + "description": "The origin of the ray", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "heading": { + "type": "vector_2d", + "description": "The direction the ray is heading (as a `vector_2d`)", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "l": { + "type": "line", + "description": "The line to be checked", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pt": { + "type": "point_2d", + "description": "Outputs the point where the line and ray intersect", + "is_pointer": false, + "is_const": false, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def close_all_adc():" - ], "cpp": [ - "void close_all_adc()" + "bool ray_intersection_point(const point_2d &from_pt, const vector_2d &heading, const line &l, point_2d &pt)" + ], + "python": [ + "def ray_intersection_point(from_pt, heading, l, pt):" ], "csharp": [ - "public static void SplashKit.CloseAllAdc();" + "public static bool SplashKit.RayIntersectionPoint(Point2D fromPt, Vector2D heading, Line l, ref Point2D pt);" ], "pascal": [ - "procedure CloseAllAdc()" + "function RayIntersectionPoint(const fromPt: Point2D; const heading: Vector2D; const l: Line; var pt: Point2D): Boolean" ] } }, { - "signature": "bool has_adc_device(const string &name);", - "name": "has_adc_device", + "signature": "vector_2d unit_vector(const vector_2d &v);", + "name": "unit_vector", "method_name": null, - "unique_global_name": "has_adc_device", + "unique_global_name": "unit_vector", "unique_method_name": null, "suffix_name": null, - "description": "Checks if an ADC device with the given name has been loaded.", + "description": "Returns the unit vector of the parameter vector (v). The unit vector has a\nmagnitude of 1, resulting in a vector that indicates the direction of\nthe original vector.", "brief": null, "return": { - "type": "bool", - "description": "true if an ADC device with the supplied name exists.", + "type": "vector_2d", + "description": "The unit vector of `v`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name used to identify the ADC device.", + "v": { + "type": "vector_2d", + "description": "The vector", "is_pointer": false, "is_const": true, "is_reference": true, @@ -74323,45 +71214,45 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def has_adc_device(name):" - ], "cpp": [ - "bool has_adc_device(const string &name)" + "vector_2d unit_vector(const vector_2d &v)" + ], + "python": [ + "def unit_vector(v):" ], "csharp": [ - "public static bool SplashKit.HasAdcDevice(string name);" + "public static Vector2D SplashKit.UnitVector(Vector2D v);" ], "pascal": [ - "function HasAdcDevice(const name: String): Boolean" + "function UnitVector(const v: Vector2D): Vector2D" ] } }, { - "signature": "adc_device open_adc(const string &name,adc_type type_of_adc);", - "name": "open_adc", + "signature": "vector_2d vector_add(const vector_2d &v1,const vector_2d &v2);", + "name": "vector_add", "method_name": null, - "unique_global_name": "open_adc", + "unique_global_name": "vector_add", "unique_method_name": null, "suffix_name": null, - "description": "Opens an ADC device with the specified name and type. Defaults to bus 1 and address 0x48.", + "description": "Adds the two passed in vectors returns the result as new `vector_2d`.", "brief": null, "return": { - "type": "adc_device", - "description": "A valid adc_device on success, or nullptr on failure.", + "type": "vector_2d", + "description": "The result of adding the movements of the two vectors\ntogether.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name of the ADC device to open.", + "v1": { + "type": "vector_2d", + "description": "The first vector.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -74372,12 +71263,12 @@ "is_vector": false, "type_parameter": null }, - "type_of_adc": { - "type": "adc_type", - "description": "The type of ADC device (e.g., ADS7830, PCF8591).", + "v2": { + "type": "vector_2d", + "description": "The other vector.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -74387,89 +71278,47 @@ } }, "attributes": { - "class": "adc_device", - "constructor": true, - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def open_adc(name, type_of_adc):" - ], "cpp": [ - "adc_device open_adc(const string &name, adc_type type_of_adc)" + "vector_2d vector_add(const vector_2d &v1, const vector_2d &v2)" + ], + "python": [ + "def vector_add(v1, v2):" ], "csharp": [ - "public static AdcDevice SplashKit.OpenAdc(string name, AdcType typeOfAdc);", - "public AdcDevice(string name, AdcType typeOfAdc);" + "public static Vector2D SplashKit.VectorAdd(Vector2D v1, Vector2D v2);" ], "pascal": [ - "function OpenAdc(const name: String; typeOfAdc: AdcType): AdcDevice" + "function VectorAdd(const v1: Vector2D; const v2: Vector2D): Vector2D" ] } }, { - "signature": "adc_device open_adc(const string &name,int bus,int address,adc_type type_of_adc);", - "name": "open_adc", + "signature": "double vector_angle(const vector_2d v);", + "name": "vector_angle", "method_name": null, - "unique_global_name": "open_adc_with_bus", + "unique_global_name": "vector_angle", "unique_method_name": null, "suffix_name": null, - "description": "Loads an ADC device on the specified I2C bus at a given address.", + "description": "Calculates the angle of a vector", "brief": null, "return": { - "type": "adc_device", - "description": "A valid adc_device on success, or nullptr on failure.", + "type": "double", + "description": "The angle of the vector in degrees", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name to assign this ADC device.", + "v": { + "type": "vector_2d", + "description": "The vector", "is_pointer": false, "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "bus": { - "type": "int", - "description": "The I2C bus number.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "address": { - "type": "int", - "description": "The I2C address of the ADC device.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "type_of_adc": { - "type": "adc_type", - "description": "The type of ADC device (e.g., ADS7830, PCF8591).", - "is_pointer": false, - "is_const": false, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -74480,49 +71329,45 @@ } }, "attributes": { - "class": "adc_device", - "constructor": true, - "suffix": "with_bus", - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def open_adc_with_bus(name, bus, address, type_of_adc):" - ], "cpp": [ - "adc_device open_adc(const string &name, int bus, int address, adc_type type_of_adc)" + "double vector_angle(const vector_2d v)" + ], + "python": [ + "def vector_angle(v):" ], "csharp": [ - "public static AdcDevice SplashKit.OpenAdc(string name, int bus, int address, AdcType typeOfAdc);", - "public AdcDevice(string name, int bus, int address, AdcType typeOfAdc);" + "public static double SplashKit.VectorAngle(Vector2D v);" ], "pascal": [ - "function OpenAdc(const name: String; bus: Integer; address: Integer; typeOfAdc: AdcType): AdcDevice" + "function VectorAngle(v: Vector2D): Double" ] } }, { - "signature": "int read_adc(adc_device adc,adc_pin channel);", - "name": "read_adc", - "method_name": "read", - "unique_global_name": "read_adc", - "unique_method_name": "adc_device.read", + "signature": "vector_2d vector_from_angle(double angle,double magnitude);", + "name": "vector_from_angle", + "method_name": null, + "unique_global_name": "vector_from_angle", + "unique_method_name": null, "suffix_name": null, - "description": "Reads an 8-bit value from the specified ADC channel on the device.", + "description": "Returns a `vector_2d` from the supplied angle and distance.", "brief": null, "return": { - "type": "int", - "description": "The ADC conversion value (0–255), or -1 on error.", + "type": "vector_2d", + "description": "A vector that will move things at that angle and\nmagnitude", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "adc": { - "type": "adc_device", - "description": "The ADC device to read from.", + "angle": { + "type": "double", + "description": "The angle in degrees", "is_pointer": false, "is_const": false, "is_reference": false, @@ -74533,9 +71378,9 @@ "is_vector": false, "type_parameter": null }, - "channel": { - "type": "adc_pin", - "description": "The channel number to read (range depends on ADC type).", + "magnitude": { + "type": "double", + "description": "The length of the vector", "is_pointer": false, "is_const": false, "is_reference": false, @@ -74548,117 +71393,112 @@ } }, "attributes": { - "class": "adc_device", - "method": "read", - "self": "adc", - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def read_adc(adc, channel):" - ], "cpp": [ - "int read_adc(adc_device adc, adc_pin channel)" + "vector_2d vector_from_angle(double angle, double magnitude)" + ], + "python": [ + "def vector_from_angle(angle, magnitude):" ], "csharp": [ - "public int AdcDevice.Read(AdcPin channel);", - "public static int SplashKit.ReadAdc(AdcDevice adc, AdcPin channel);" + "public static Vector2D SplashKit.VectorFromAngle(double angle, double magnitude);" ], "pascal": [ - "function ReadAdc(adc: AdcDevice; channel: AdcPin): Integer" + "function VectorFromAngle(angle: Double; magnitude: Double): Vector2D" ] } }, { - "signature": "int read_adc(const string &name,adc_pin channel);", - "name": "read_adc", + "signature": "vector_2d vector_from_line(const line &l);", + "name": "vector_from_line", "method_name": null, - "unique_global_name": "read_adc_named", + "unique_global_name": "vector_from_line", "unique_method_name": null, "suffix_name": null, - "description": "Reads an 8-bit value from the specified ADC channel on the device using its name.", + "description": "Returns a vector that points from the start to the end of a line.", "brief": null, "return": { - "type": "int", - "description": "The ADC conversion value (0–255), or -1 on error.", + "type": "vector_2d", + "description": "A vector that will move things from the start to the end of the\nline", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The ADC name string to close.", + "l": { + "type": "line", + "description": "The line", "is_pointer": false, "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ - ], - "is_vector": false, - "type_parameter": null - }, - "channel": { - "type": "adc_pin", - "description": "The channel number to read (range depends on ADC type).", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - ], "is_vector": false, "type_parameter": null } }, "attributes": { - "suffix": "named", - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def read_adc_named(name, channel):" - ], "cpp": [ - "int read_adc(const string &name, adc_pin channel)" + "vector_2d vector_from_line(const line &l)" + ], + "python": [ + "def vector_from_line(l):" ], "csharp": [ - "public static int SplashKit.ReadAdc(string name, AdcPin channel);" + "public static Vector2D SplashKit.VectorFromLine(Line l);" ], "pascal": [ - "function ReadAdc(const name: String; channel: AdcPin): Integer" + "function VectorFromLine(const l: Line): Vector2D" ] } }, { - "signature": "unsigned short get_alpha_font_14_seg(char ascii_char);", - "name": "get_alpha_font_14_seg", + "signature": "vector_2d vector_from_point_to_rect(const point_2d &pt,const rectangle &rect);", + "name": "vector_from_point_to_rect", "method_name": null, - "unique_global_name": "get_alpha_font_14_seg", + "unique_global_name": "vector_from_point_to_rect", "unique_method_name": null, "suffix_name": null, - "description": "Converts an ASCII character to a binary value to be used with the Quad 14-segment display module (HT16K33 backpack).", + "description": "Returns a vector from a point to a rectangle.", "brief": null, "return": { - "type": "unsigned short", - "description": "The binary value used to display a character on the 14-segment display.", + "type": "vector_2d", + "description": "A vector representing the distance and direction from `pt`\nto `rect`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "ascii_char": { - "type": "char", - "description": "The ascii character to be converted to a 16-bit binary value.", + "pt": { + "type": "point_2d", + "description": "The point", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect": { + "type": "rectangle", + "description": "The rectangle", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -74668,48 +71508,61 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def get_alpha_font_14_seg(ascii_char):" - ], "cpp": [ - "unsigned short get_alpha_font_14_seg(char ascii_char)" + "vector_2d vector_from_point_to_rect(const point_2d &pt, const rectangle &rect)" + ], + "python": [ + "def vector_from_point_to_rect(pt, rect):" ], "csharp": [ - "public static ushort SplashKit.GetAlphaFont14Seg(char asciiChar);" + "public static Vector2D SplashKit.VectorFromPointToRect(Point2D pt, Rectangle rect);" ], "pascal": [ - "function GetAlphaFont14Seg(asciiChar: Char): Word" + "function VectorFromPointToRect(const pt: Point2D; const rect: Rectangle): Vector2D" ] } }, { - "signature": "int gpio_pin_to_int(gpio_pin_value value);", - "name": "gpio_pin_to_int", + "signature": "bool vector_in_rect(const vector_2d &v,const rectangle &rect);", + "name": "vector_in_rect", "method_name": null, - "unique_global_name": "gpio_pin_to_int", + "unique_global_name": "vector_in_rect", "unique_method_name": null, "suffix_name": null, - "description": "Converts the specified pin value to an integer, to use in calculations.", - "brief": "Converts a GPIO Pin Value to an integer.", + "description": "Returns true if the resulting vector would end in the rectangle if\nplaced at the origin.", + "brief": null, "return": { - "type": "int", - "description": "The pin value as an integer.", + "type": "bool", + "description": "True if the vector would end in the rectangle", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "value": { - "type": "gpio_pin_value", - "description": "The pin to read the value from.", + "v": { + "type": "vector_2d", + "description": "The vector", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect": { + "type": "rectangle", + "description": "The rectangle", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -74719,124 +71572,163 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def gpio_pin_to_int(value):" - ], "cpp": [ - "int gpio_pin_to_int(gpio_pin_value value)" + "bool vector_in_rect(const vector_2d &v, const rectangle &rect)" + ], + "python": [ + "def vector_in_rect(v, rect):" ], "csharp": [ - "public static int SplashKit.GpioPinToInt(GpioPinValue value);" + "public static bool SplashKit.VectorInRect(Vector2D v, Rectangle rect);" ], "pascal": [ - "function GpioPinToInt(value: GpioPinValue): Integer" + "function VectorInRect(const v: Vector2D; const rect: Rectangle): Boolean" ] } }, { - "signature": "bool has_gpio();", - "name": "has_gpio", + "signature": "vector_2d vector_invert(const vector_2d &v);", + "name": "vector_invert", "method_name": null, - "unique_global_name": "has_gpio", + "unique_global_name": "vector_invert", "unique_method_name": null, "suffix_name": null, - "description": "Checks if the system has GPIO capabilities.", + "description": "Returns a new Vector that is an inverted version of the parameter\nvector (v). In other words, the -/+ sign of the x and y values are changed.", "brief": null, "return": { - "type": "bool", - "description": "true if the system has GPIO capabilities, false otherwise.", + "type": "vector_2d", + "description": "The inverse (reverse) of `v`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "v": { + "type": "vector_2d", + "description": "The vector", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def has_gpio():" - ], "cpp": [ - "bool has_gpio()" + "vector_2d vector_invert(const vector_2d &v)" + ], + "python": [ + "def vector_invert(v):" ], "csharp": [ - "public static bool SplashKit.HasGpio();" + "public static Vector2D SplashKit.VectorInvert(Vector2D v);" ], "pascal": [ - "function HasGpio(): Boolean" + "function VectorInvert(const v: Vector2D): Vector2D" ] } }, { - "signature": "void raspi_cleanup();", - "name": "raspi_cleanup", + "signature": "vector_2d vector_limit(const vector_2d &v,double limit);", + "name": "vector_limit", "method_name": null, - "unique_global_name": "raspi_cleanup", + "unique_global_name": "vector_limit", "unique_method_name": null, "suffix_name": null, - "description": "This function should be called when you are finished using the GPIO library. It sets all pin modes to INPUT and values to LOW.", - "brief": "Cleans up and releases any resources used by the GPIO library.", + "description": "Returns a scaled vector that ensures the new vector points\nin the same direction as v, but has a magnitude that is\nlimited to the length specified in the limit prameter.", + "brief": null, "return": { - "type": "void", - "description": null, + "type": "vector_2d", + "description": "A new vector in the same direction as v, but with a\nmagnitude that is less than or equal to the limit.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "v": { + "type": "vector_2d", + "description": "The vector", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "limit": { + "type": "double", + "description": "Its maximum magnitude", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_cleanup():" - ], "cpp": [ - "void raspi_cleanup()" + "vector_2d vector_limit(const vector_2d &v, double limit)" + ], + "python": [ + "def vector_limit(v, limit):" ], "csharp": [ - "public static void SplashKit.RaspiCleanup();" + "public static Vector2D SplashKit.VectorLimit(Vector2D v, double limit);" ], "pascal": [ - "procedure RaspiCleanup()" + "function VectorLimit(const v: Vector2D; limit: Double): Vector2D" ] } }, { - "signature": "gpio_pin_mode raspi_get_mode(gpio_pin pin);", - "name": "raspi_get_mode", + "signature": "double vector_magnitude(const vector_2d &v);", + "name": "vector_magnitude", "method_name": null, - "unique_global_name": "raspi_get_mode", + "unique_global_name": "vector_magnitude", "unique_method_name": null, "suffix_name": null, - "description": "This function retrieves the mode of the specified pin.", - "brief": "Gets the mode of the specified pin.", + "description": "Returns the magnitude (or \"length\") of the vector.", + "brief": null, "return": { - "type": "gpio_pin_mode", - "description": "The mode of the pin.", + "type": "double", + "description": "Its magnitude", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pin": { - "type": "gpio_pin", - "description": "The pin to get the mode for.", + "v": { + "type": "vector_2d", + "description": "The vector", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -74846,48 +71738,48 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_get_mode(pin):" - ], "cpp": [ - "gpio_pin_mode raspi_get_mode(gpio_pin pin)" + "double vector_magnitude(const vector_2d &v)" + ], + "python": [ + "def vector_magnitude(v):" ], "csharp": [ - "public static GpioPinMode SplashKit.RaspiGetMode(GpioPin pin);" + "public static double SplashKit.VectorMagnitude(Vector2D v);" ], "pascal": [ - "function RaspiGetMode(pin: GpioPin): GpioPinMode" + "function VectorMagnitude(const v: Vector2D): Double" ] } }, { - "signature": "int raspi_get_servo_pulsewidth(gpio_pin pin);", - "name": "raspi_get_servo_pulsewidth", + "signature": "double vector_magnitude_squared(const vector_2d &v);", + "name": "vector_magnitude_squared", "method_name": null, - "unique_global_name": "raspi_get_servo_pulsewidth", + "unique_global_name": "vector_magnitude_squared", "unique_method_name": null, "suffix_name": null, - "description": "This function retrieves the pulse width for the specified pin.", - "brief": "Gets the pulse width for the specified pin.", + "description": "Returns the squared magnitude (or \"length\") of the vector.", + "brief": null, "return": { - "type": "int", - "description": "The pulse width of the pin.", + "type": "double", + "description": "Its squared magnitude", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pin": { - "type": "gpio_pin", - "description": "The pin to get the pulse width for.", + "v": { + "type": "vector_2d", + "description": "The vector", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -74897,48 +71789,48 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_get_servo_pulsewidth(pin):" - ], "cpp": [ - "int raspi_get_servo_pulsewidth(gpio_pin pin)" + "double vector_magnitude_squared(const vector_2d &v)" + ], + "python": [ + "def vector_magnitude_squared(v):" ], "csharp": [ - "public static int SplashKit.RaspiGetServoPulsewidth(GpioPin pin);" + "public static double SplashKit.VectorMagnitudeSquared(Vector2D v);" ], "pascal": [ - "function RaspiGetServoPulsewidth(pin: GpioPin): Integer" + "function VectorMagnitudeSquared(const v: Vector2D): Double" ] } }, { - "signature": "int raspi_i2c_open(int bus,int address);", - "name": "raspi_i2c_open", + "signature": "vector_2d vector_multiply(const vector_2d &v1,double s);", + "name": "vector_multiply", "method_name": null, - "unique_global_name": "raspi_i2c_open", + "unique_global_name": "vector_multiply", "unique_method_name": null, "suffix_name": null, - "description": "Opens I2C communication on selected address. It will return -1 if not using Raspberry Pi.", + "description": "Multiplies the vector by the passed in value.", "brief": null, "return": { - "type": "int", - "description": "The handle referencing this particular connection.", + "type": "vector_2d", + "description": "A new vector", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "bus": { - "type": "int", - "description": "The bus of the I2C device.", + "v1": { + "type": "vector_2d", + "description": "The original vector", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -74946,9 +71838,9 @@ "is_vector": false, "type_parameter": null }, - "address": { - "type": "int", - "description": "The address of the I2C device.", + "s": { + "type": "double", + "description": "The amount to multiply by", "is_pointer": false, "is_const": false, "is_reference": false, @@ -74961,61 +71853,48 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_i2c_open(bus, address):" - ], "cpp": [ - "int raspi_i2c_open(int bus, int address)" + "vector_2d vector_multiply(const vector_2d &v1, double s)" + ], + "python": [ + "def vector_multiply(v1, s):" ], "csharp": [ - "public static int SplashKit.RaspiI2cOpen(int bus, int address);" + "public static Vector2D SplashKit.VectorMultiply(Vector2D v1, double s);" ], "pascal": [ - "function RaspiI2cOpen(bus: Integer; address: Integer): Integer" + "function VectorMultiply(const v1: Vector2D; s: Double): Vector2D" ] } }, { - "signature": "void raspi_i2c_write(int handle,int data);", - "name": "raspi_i2c_write", + "signature": "vector_2d vector_normal(const vector_2d &v);", + "name": "vector_normal", "method_name": null, - "unique_global_name": "raspi_i2c_write", + "unique_global_name": "vector_normal", "unique_method_name": null, "suffix_name": null, - "description": "Writes data to specified I2C connection.", + "description": "Returns a new `vector_2d` that is perpendicular (\"normal\") to the parameter\nvector `v` provided. The concept of a \"normal\" vector is usually\nextracted from (or associated with) a line.\n\nNote: when passed a zero or null vector (a vector with no\nmagnitude or direction) then this function returns a zero/null vector.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "vector_2d", + "description": "The normal of `v`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "handle": { - "type": "int", - "description": "The reference for a specific I2C connection.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "data": { - "type": "int", - "description": "The data to send.", + "v": { + "type": "vector_2d", + "description": "The vector", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75025,61 +71904,48 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_i2c_write(handle, data):" - ], "cpp": [ - "void raspi_i2c_write(int handle, int data)" + "vector_2d vector_normal(const vector_2d &v)" + ], + "python": [ + "def vector_normal(v):" ], "csharp": [ - "public static void SplashKit.RaspiI2cWrite(int handle, int data);" + "public static Vector2D SplashKit.VectorNormal(Vector2D v);" ], "pascal": [ - "procedure RaspiI2cWrite(handle: Integer; data: Integer)" + "function VectorNormal(const v: Vector2D): Vector2D" ] } }, { - "signature": "void raspi_i2c_write(int handle,int reg,int data,int bytes);", - "name": "raspi_i2c_write", + "signature": "vector_2d vector_out_of_circle_from_circle(const circle &src,const circle &bounds,const vector_2d &velocity);", + "name": "vector_out_of_circle_from_circle", "method_name": null, - "unique_global_name": "raspi_i2c_write_data", + "unique_global_name": "vector_out_of_circle_from_circle", "unique_method_name": null, "suffix_name": null, - "description": "Writes 8-bit (1 byte) or 16-bit (2 bytes) data to specified I2C connection.", + "description": "Returns a vector to back one circle out of another, assuming the first circle was\nmoving at a specified velocity.", "brief": null, "return": { - "type": "void", - "description": null, + "type": "vector_2d", + "description": "A vector that can move the circle out of the bounds", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "handle": { - "type": "int", - "description": "The reference for a specific I2C connection.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "reg": { - "type": "int", - "description": "The register to send the data to", + "src": { + "type": "circle", + "description": "The circle that is moving", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75087,12 +71953,12 @@ "is_vector": false, "type_parameter": null }, - "data": { - "type": "int", - "description": "The data to send.", + "bounds": { + "type": "circle", + "description": "The area you want to move the circle out of", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75100,12 +71966,12 @@ "is_vector": false, "type_parameter": null }, - "bytes": { - "type": "int", - "description": "The number of bytes to be transferred.", + "velocity": { + "type": "vector_2d", + "description": "The circle's velocity", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75115,87 +71981,151 @@ } }, "attributes": { - "suffix": "data", - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_i2c_write_data(handle, reg, data, bytes):" - ], "cpp": [ - "void raspi_i2c_write(int handle, int reg, int data, int bytes)" + "vector_2d vector_out_of_circle_from_circle(const circle &src, const circle &bounds, const vector_2d &velocity)" + ], + "python": [ + "def vector_out_of_circle_from_circle(src, bounds, velocity):" ], "csharp": [ - "public static void SplashKit.RaspiI2cWrite(int handle, int reg, int data, int bytes);" + "public static Vector2D SplashKit.VectorOutOfCircleFromCircle(Circle src, Circle bounds, Vector2D velocity);" ], "pascal": [ - "procedure RaspiI2cWrite(handle: Integer; reg: Integer; data: Integer; bytes: Integer)" + "function VectorOutOfCircleFromCircle(const src: Circle; const bounds: Circle; const velocity: Vector2D): Vector2D" ] } }, { - "signature": "void raspi_init();", - "name": "raspi_init", + "signature": "vector_2d vector_out_of_circle_from_point(const point_2d &pt,const circle &c,const vector_2d &velocity);", + "name": "vector_out_of_circle_from_point", "method_name": null, - "unique_global_name": "raspi_init", + "unique_global_name": "vector_out_of_circle_from_point", "unique_method_name": null, "suffix_name": null, - "description": "This function initializes the GPIO library for use. It should be called before any other GPIO functions.", - "brief": "Initializes the GPIO library.", + "description": "Returns the vector out to move a point back out of a circle,\ngiven the point was moving at the specified velocity.", + "brief": null, "return": { - "type": "void", - "description": null, + "type": "vector_2d", + "description": "A vector that can move the point out of the circle", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "pt": { + "type": "point_2d", + "description": "The point that is moving", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "c": { + "type": "circle", + "description": "The circle you want to move the point out of", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "velocity": { + "type": "vector_2d", + "description": "The point's velocity", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_init():" - ], "cpp": [ - "void raspi_init()" + "vector_2d vector_out_of_circle_from_point(const point_2d &pt, const circle &c, const vector_2d &velocity)" + ], + "python": [ + "def vector_out_of_circle_from_point(pt, c, velocity):" ], "csharp": [ - "public static void SplashKit.RaspiInit();" + "public static Vector2D SplashKit.VectorOutOfCircleFromPoint(Point2D pt, Circle c, Vector2D velocity);" ], "pascal": [ - "procedure RaspiInit()" + "function VectorOutOfCircleFromPoint(const pt: Point2D; const c: Circle; const velocity: Vector2D): Vector2D" ] } }, { - "signature": "gpio_pin_value raspi_read(gpio_pin pin);", - "name": "raspi_read", + "signature": "vector_2d vector_out_of_rect_from_circle(const circle &c,const rectangle &rect,const vector_2d &velocity);", + "name": "vector_out_of_rect_from_circle", "method_name": null, - "unique_global_name": "raspi_read", + "unique_global_name": "vector_out_of_rect_from_circle", "unique_method_name": null, "suffix_name": null, - "description": "This function reads the value from the specified pin.", - "brief": "Reads the value from the specified pin.", + "description": "Returns a vector that can be used to move a circle back out of a rectangle,\ngiven that the circle is moving at the specified velocity.", + "brief": null, "return": { - "type": "gpio_pin_value", - "description": "The value read from the pin.", + "type": "vector_2d", + "description": "A vector that will move the circle out of the rectangle", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pin": { - "type": "gpio_pin", - "description": "The pin to read the value from.", + "c": { + "type": "circle", + "description": "The circle that is moving", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "rect": { + "type": "rectangle", + "description": "The area you wan to move the circle out of", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "velocity": { + "type": "vector_2d", + "description": "The circle's velocity", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75205,48 +72135,48 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_read(pin):" - ], "cpp": [ - "gpio_pin_value raspi_read(gpio_pin pin)" + "vector_2d vector_out_of_rect_from_circle(const circle &c, const rectangle &rect, const vector_2d &velocity)" + ], + "python": [ + "def vector_out_of_rect_from_circle(c, rect, velocity):" ], "csharp": [ - "public static GpioPinValue SplashKit.RaspiRead(GpioPin pin);" + "public static Vector2D SplashKit.VectorOutOfRectFromCircle(Circle c, Rectangle rect, Vector2D velocity);" ], "pascal": [ - "function RaspiRead(pin: GpioPin): GpioPinValue" + "function VectorOutOfRectFromCircle(const c: Circle; const rect: Rectangle; const velocity: Vector2D): Vector2D" ] } }, { - "signature": "void raspi_set_mode(gpio_pin pin,gpio_pin_mode mode);", - "name": "raspi_set_mode", + "signature": "vector_2d vector_out_of_rect_from_point(const point_2d &pt,const rectangle &rect,const vector_2d &velocity);", + "name": "vector_out_of_rect_from_point", "method_name": null, - "unique_global_name": "raspi_set_mode", + "unique_global_name": "vector_out_of_rect_from_point", "unique_method_name": null, "suffix_name": null, - "description": "This function sets the mode of the specified pin to the specified mode.", - "brief": "Sets the mode of the specified pin.", + "description": "Determines the vector needed to move back from point `pt` out of rectangle `rect` given\nthe point was moving at the velocity specified.", + "brief": null, "return": { - "type": "void", - "description": null, + "type": "vector_2d", + "description": "A vector that can move the point outside of the\nrectangle.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pin": { - "type": "gpio_pin", - "description": "The pin to set the mode for.", + "pt": { + "type": "point_2d", + "description": "The point you want to move out of a rectangle", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75254,12 +72184,25 @@ "is_vector": false, "type_parameter": null }, - "mode": { - "type": "gpio_pin_mode", - "description": "The mode to set for the pin.", + "rect": { + "type": "rectangle", + "description": "The rectangle to move out of", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "velocity": { + "type": "vector_2d", + "description": "The velocity of the point. This is used to determine\nwhere the point should return to.", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75269,48 +72212,48 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_set_mode(pin, mode):" - ], "cpp": [ - "void raspi_set_mode(gpio_pin pin, gpio_pin_mode mode)" + "vector_2d vector_out_of_rect_from_point(const point_2d &pt, const rectangle &rect, const vector_2d &velocity)" + ], + "python": [ + "def vector_out_of_rect_from_point(pt, rect, velocity):" ], "csharp": [ - "public static void SplashKit.RaspiSetMode(GpioPin pin, GpioPinMode mode);" + "public static Vector2D SplashKit.VectorOutOfRectFromPoint(Point2D pt, Rectangle rect, Vector2D velocity);" ], "pascal": [ - "procedure RaspiSetMode(pin: GpioPin; mode: GpioPinMode)" + "function VectorOutOfRectFromPoint(const pt: Point2D; const rect: Rectangle; const velocity: Vector2D): Vector2D" ] } }, { - "signature": "void raspi_set_pull_up_down(gpio_pin pin,pull_up_down pud);", - "name": "raspi_set_pull_up_down", + "signature": "vector_2d vector_out_of_rect_from_rect(const rectangle &src,const rectangle &bounds,const vector_2d &velocity);", + "name": "vector_out_of_rect_from_rect", "method_name": null, - "unique_global_name": "raspi_set_pull_up_down", + "unique_global_name": "vector_out_of_rect_from_rect", "unique_method_name": null, "suffix_name": null, - "description": "This function sets the pull-up/down mode for the specified pin.", - "brief": "Sets the pull up/down mode for the specified pin.", + "description": "Returns the vector needed to move rectangle `src` back out of rectangle `bounds`\nassuming the rectangle was moving at the velocity specified.", + "brief": null, "return": { - "type": "void", - "description": null, + "type": "vector_2d", + "description": "A vector that can move the rectangle out of the bounds", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pin": { - "type": "gpio_pin", - "description": "The pin to set the pull up/down mode for.", + "src": { + "type": "rectangle", + "description": "The rectangle you want to move.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75318,12 +72261,25 @@ "is_vector": false, "type_parameter": null }, - "pud": { - "type": "pull_up_down", - "description": "The pull up/down mode to set for the pin.", + "bounds": { + "type": "rectangle", + "description": "The area you want to move the rectangle out of", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "velocity": { + "type": "vector_2d", + "description": "The velocity of the `src` rectangle", + "is_pointer": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75333,48 +72289,48 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_set_pull_up_down(pin, pud):" - ], "cpp": [ - "void raspi_set_pull_up_down(gpio_pin pin, pull_up_down pud)" + "vector_2d vector_out_of_rect_from_rect(const rectangle &src, const rectangle &bounds, const vector_2d &velocity)" + ], + "python": [ + "def vector_out_of_rect_from_rect(src, bounds, velocity):" ], "csharp": [ - "public static void SplashKit.RaspiSetPullUpDown(GpioPin pin, PullUpDown pud);" + "public static Vector2D SplashKit.VectorOutOfRectFromRect(Rectangle src, Rectangle bounds, Vector2D velocity);" ], "pascal": [ - "procedure RaspiSetPullUpDown(pin: GpioPin; pud: PullUpDown)" + "function VectorOutOfRectFromRect(const src: Rectangle; const bounds: Rectangle; const velocity: Vector2D): Vector2D" ] } }, { - "signature": "void raspi_set_pwm_dutycycle(gpio_pin pin,int dutycycle);", - "name": "raspi_set_pwm_dutycycle", + "signature": "vector_2d vector_point_to_point(const point_2d &start,const point_2d &end_pt);", + "name": "vector_point_to_point", "method_name": null, - "unique_global_name": "raspi_set_pwm_dutycycle", + "unique_global_name": "vector_point_to_point", "unique_method_name": null, "suffix_name": null, - "description": "This function sets the PWM duty cycle for the specified pin.", - "brief": "Sets the PWM duty cycle for the specified pin.", + "description": "Returns a `vector_2d` created from the difference from the `p1` to\nthe second `p2` points (`Point2D`).", + "brief": null, "return": { - "type": "void", - "description": null, + "type": "vector_2d", + "description": "A vector that will move things from the starting point to\nthe ending point", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pin": { - "type": "gpio_pin", - "description": "The pin to set the PWM duty cycle for.", + "start": { + "type": "point_2d", + "description": "The starting point", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75382,12 +72338,12 @@ "is_vector": false, "type_parameter": null }, - "dutycycle": { - "type": "int", - "description": "The PWM duty cycle to set for the pin.", + "end_pt": { + "type": "point_2d", + "description": "The ending point", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75397,48 +72353,48 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_set_pwm_dutycycle(pin, dutycycle):" - ], "cpp": [ - "void raspi_set_pwm_dutycycle(gpio_pin pin, int dutycycle)" + "vector_2d vector_point_to_point(const point_2d &start, const point_2d &end_pt)" + ], + "python": [ + "def vector_point_to_point(start, end_pt):" ], "csharp": [ - "public static void SplashKit.RaspiSetPwmDutycycle(GpioPin pin, int dutycycle);" + "public static Vector2D SplashKit.VectorPointToPoint(Point2D start, Point2D endPt);" ], "pascal": [ - "procedure RaspiSetPwmDutycycle(pin: GpioPin; dutycycle: Integer)" + "function VectorPointToPoint(const start: Point2D; const endPt: Point2D): Vector2D" ] } }, { - "signature": "void raspi_set_pwm_frequency(gpio_pin pin,int frequency);", - "name": "raspi_set_pwm_frequency", + "signature": "vector_2d vector_subtract(const vector_2d &v1,const vector_2d &v2);", + "name": "vector_subtract", "method_name": null, - "unique_global_name": "raspi_set_pwm_frequency", + "unique_global_name": "vector_subtract", "unique_method_name": null, "suffix_name": null, - "description": "This function sets the PWM frequency for the specified pin.", - "brief": "Sets the PWM frequency for the specified pin.", + "description": "Subtracts the second vector parameter (`v2`) from the first vector\n(`v1`) and returns the result as new `vector_2d`.", + "brief": null, "return": { - "type": "void", - "description": null, + "type": "vector_2d", + "description": "The result of subtracting the movements of `v2` from `v1`.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pin": { - "type": "gpio_pin", - "description": "The pin to set the PWM frequency for.", + "v1": { + "type": "vector_2d", + "description": "The first vector.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75446,12 +72402,12 @@ "is_vector": false, "type_parameter": null }, - "frequency": { - "type": "int", - "description": "The PWM frequency to set for the pin.", + "v2": { + "type": "vector_2d", + "description": "The other vector.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75461,61 +72417,48 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_set_pwm_frequency(pin, frequency):" - ], "cpp": [ - "void raspi_set_pwm_frequency(gpio_pin pin, int frequency)" + "vector_2d vector_subtract(const vector_2d &v1, const vector_2d &v2)" + ], + "python": [ + "def vector_subtract(v1, v2):" ], "csharp": [ - "public static void SplashKit.RaspiSetPwmFrequency(GpioPin pin, int frequency);" + "public static Vector2D SplashKit.VectorSubtract(Vector2D v1, Vector2D v2);" ], "pascal": [ - "procedure RaspiSetPwmFrequency(pin: GpioPin; frequency: Integer)" + "function VectorSubtract(const v1: Vector2D; const v2: Vector2D): Vector2D" ] } }, { - "signature": "void raspi_set_pwm_range(gpio_pin pin,int range);", - "name": "raspi_set_pwm_range", + "signature": "vector_2d vector_to(const point_2d &p1);", + "name": "vector_to", "method_name": null, - "unique_global_name": "raspi_set_pwm_range", + "unique_global_name": "vector_to_point", "unique_method_name": null, "suffix_name": null, - "description": "This function sets the PWM range for the specified pin.\nValid values for the range are 25 - 40000", - "brief": "Sets the PWM range for the specified pin.", + "description": "Returns a new `vector_2d` using the x and y value of a `point_2d` parameter.\nThis is a vector from the origin to that point.", + "brief": null, "return": { - "type": "void", - "description": null, + "type": "vector_2d", + "description": "A vector from the origin to `p1`", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pin": { - "type": "gpio_pin", - "description": "The pin to set the PWM range for.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "range": { - "type": "int", - "description": "The PWM range to set for the pin.", + "p1": { + "type": "point_2d", + "description": "The point", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75525,45 +72468,46 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "suffix": "point", + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_set_pwm_range(pin, range):" - ], "cpp": [ - "void raspi_set_pwm_range(gpio_pin pin, int range)" + "vector_2d vector_to(const point_2d &p1)" + ], + "python": [ + "def vector_to_point(p1):" ], "csharp": [ - "public static void SplashKit.RaspiSetPwmRange(GpioPin pin, int range);" + "public static Vector2D SplashKit.VectorTo(Point2D p1);" ], "pascal": [ - "procedure RaspiSetPwmRange(pin: GpioPin; range: Integer)" + "function VectorTo(const p1: Point2D): Vector2D" ] } }, { - "signature": "void raspi_set_servo_pulsewidth(gpio_pin pin,int pulsewidth);", - "name": "raspi_set_servo_pulsewidth", + "signature": "vector_2d vector_to(double x,double y);", + "name": "vector_to", "method_name": null, - "unique_global_name": "raspi_set_servo_pulsewidth", + "unique_global_name": "vector_to", "unique_method_name": null, "suffix_name": null, - "description": "This function sets the pulse width for the specified pin.", - "brief": "Sets the pulse width for the specified pin.", + "description": "Returns a vector to the indicated point.", + "brief": null, "return": { - "type": "void", - "description": null, + "type": "vector_2d", + "description": "A vector that will move things the indicated amount", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pin": { - "type": "gpio_pin", - "description": "The pin to set the pulse width for.", + "x": { + "type": "double", + "description": "The amount to move horizontally", "is_pointer": false, "is_const": false, "is_reference": false, @@ -75574,9 +72518,9 @@ "is_vector": false, "type_parameter": null }, - "pulsewidth": { - "type": "int", - "description": "The pulse width to set for the pin.", + "y": { + "type": "double", + "description": "The amount to move vertically", "is_pointer": false, "is_const": false, "is_reference": false, @@ -75589,48 +72533,48 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_set_servo_pulsewidth(pin, pulsewidth):" - ], "cpp": [ - "void raspi_set_servo_pulsewidth(gpio_pin pin, int pulsewidth)" + "vector_2d vector_to(double x, double y)" + ], + "python": [ + "def vector_to(x, y):" ], "csharp": [ - "public static void SplashKit.RaspiSetServoPulsewidth(GpioPin pin, int pulsewidth);" + "public static Vector2D SplashKit.VectorTo(double x, double y);" ], "pascal": [ - "procedure RaspiSetServoPulsewidth(pin: GpioPin; pulsewidth: Integer)" + "function VectorTo(x: Double; y: Double): Vector2D" ] } }, { - "signature": "int raspi_spi_close(int handle);", - "name": "raspi_spi_close", + "signature": "string vector_to_string(const vector_2d &v);", + "name": "vector_to_string", "method_name": null, - "unique_global_name": "raspi_spi_close", + "unique_global_name": "vector_to_string", "unique_method_name": null, "suffix_name": null, - "description": "This function closes SPI communication on a particular channel.", - "brief": "Closes SPI communication on selected channel. It will return -1 if not using Raspberry Pi.", + "description": "Get a text description of the `vector_2d`.", + "brief": null, "return": { - "type": "int", - "description": "A value indicating success or failure.", + "type": "string", + "description": "A string representation of the vector", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "handle": { - "type": "int", - "description": "A reference to the specific SPI connection to close.", + "v": { + "type": "vector_2d", + "description": "The vector", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75640,61 +72584,48 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_spi_close(handle):" - ], "cpp": [ - "int raspi_spi_close(int handle)" + "string vector_to_string(const vector_2d &v)" + ], + "python": [ + "def vector_to_string(v):" ], "csharp": [ - "public static int SplashKit.RaspiSpiClose(int handle);" + "public static string SplashKit.VectorToString(Vector2D v);" ], "pascal": [ - "function RaspiSpiClose(handle: Integer): Integer" + "function VectorToString(const v: Vector2D): String" ] } }, { - "signature": "int raspi_spi_open(int channel,int speed,int spi_flags);", - "name": "raspi_spi_open", + "signature": "bool vectors_equal(const vector_2d &v1,const vector_2d v2);", + "name": "vectors_equal", "method_name": null, - "unique_global_name": "raspi_spi_open", + "unique_global_name": "vectors_equal", "unique_method_name": null, "suffix_name": null, - "description": "This function opens SPI communication on a particular channel. It will return -1 if not using Raspberry Pi.", - "brief": "Opens SPI communication on selected channel.", + "description": "Determines if two vectors are the same.", + "brief": null, "return": { - "type": "int", - "description": "The handle referencing this particular connection.", + "type": "bool", + "description": "True if the two vectors are equal.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "channel": { - "type": "int", - "description": "The SPI channel to use.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "speed": { - "type": "int", - "description": "The speed of data transfer (in baud).", + "v1": { + "type": "vector_2d", + "description": "The first vector", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75702,11 +72633,11 @@ "is_vector": false, "type_parameter": null }, - "spi_flags": { - "type": "int", - "description": "Optional flags for the SPI modes and settings.", + "v2": { + "type": "vector_2d", + "description": "The other vector", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -75717,48 +72648,48 @@ } }, "attributes": { - "group": "raspberry", - "static": "raspberry" + "group": "physics", + "static": "vector_2d" }, "signatures": { - "python": [ - "def raspi_spi_open(channel, speed, spi_flags):" - ], "cpp": [ - "int raspi_spi_open(int channel, int speed, int spi_flags)" + "bool vectors_equal(const vector_2d &v1, const vector_2d v2)" + ], + "python": [ + "def vectors_equal(v1, v2):" ], "csharp": [ - "public static int SplashKit.RaspiSpiOpen(int channel, int speed, int spiFlags);" + "public static bool SplashKit.VectorsEqual(Vector2D v1, Vector2D v2);" ], "pascal": [ - "function RaspiSpiOpen(channel: Integer; speed: Integer; spiFlags: Integer): Integer" + "function VectorsEqual(const v1: Vector2D; v2: Vector2D): Boolean" ] } }, { - "signature": "string raspi_spi_transfer(int handle,const string &send,int count,int &bytes_transfered);", - "name": "raspi_spi_transfer", + "signature": "bool vectors_not_equal(const vector_2d &v1,const vector_2d v2);", + "name": "vectors_not_equal", "method_name": null, - "unique_global_name": "raspi_spi_transfer", + "unique_global_name": "vectors_not_equal", "unique_method_name": null, "suffix_name": null, - "description": "This function transfers data through SPI, it sends data from sendBuf and receives it into recvBuf.", - "brief": "Transfers data on specified SPI connection. It will return -1 if not using Raspberry Pi.", + "description": "Determines if two vectors are not the same.", + "brief": null, "return": { - "type": "string", - "description": "The data returned from the spi transfer", + "type": "bool", + "description": "True if the two vectors are different.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "handle": { - "type": "int", - "description": "The reference for a specific SPI connection.", + "v1": { + "type": "vector_2d", + "description": "The first vector", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75766,37 +72697,115 @@ "is_vector": false, "type_parameter": null }, - "send": { - "type": "string", - "description": "The data to send.", + "v2": { + "type": "vector_2d", + "description": "The other vector", "is_pointer": false, "is_const": true, - "is_reference": true, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ ], "is_vector": false, "type_parameter": null - }, - "count": { - "type": "int", - "description": "The number of bytes to be transferred.", + } + }, + "attributes": { + "group": "physics", + "static": "vector_2d" + }, + "signatures": { + "cpp": [ + "bool vectors_not_equal(const vector_2d &v1, const vector_2d v2)" + ], + "python": [ + "def vectors_not_equal(v1, v2):" + ], + "csharp": [ + "public static bool SplashKit.VectorsNotEqual(Vector2D v1, Vector2D v2);" + ], + "pascal": [ + "function VectorsNotEqual(const v1: Vector2D; v2: Vector2D): Boolean" + ] + } + } + ], + "typedefs": [ + + ], + "structs": [ + { + "signature": "struct matrix_2d {double elements[3][3];};", + "name": "matrix_2d", + "description": "In SplashKit, matrices can be used to combine together a number of\noperations that need to be performed on `vector_2d` values. You can\ntranslate, rotate and scale, and combine these together into a\nsingle matrix that can then be applied to vectors and points.", + "brief": null, + "fields": { + "elements": { + "type": "double", + "description": "The elements of the matrix", "is_pointer": false, "is_const": false, "is_reference": false, - "is_array": false, + "is_array": true, "array_dimension_sizes": [ - + 3, + 3 ], "is_vector": false, "type_parameter": null - }, - "bytes_transfered": { - "type": "int", - "description": "The number of bytes transferred (output)", + } + }, + "attributes": { + "group": "physics", + "static": "matrix_2d" + }, + "properties": { + }, + "constructors": [ + + ], + "methods": [ + + ], + "is_alias": false, + "is_struct": true + } + ], + "enums": [ + + ], + "defines": [ + + ] + }, + "raspberry": { + "brief": "Provides support for using an ADC device with the GPIO pins on the Raspberry Pi.Splashkit allows you to read and write to the GPIO pins on the Raspberry Pi.", + "description": "", + "functions": [ + { + "signature": "adc_device adc_device_named(const string &name);", + "name": "adc_device_named", + "method_name": null, + "unique_global_name": "adc_device_named", + "unique_method_name": null, + "suffix_name": null, + "description": "Retrieve an ADC device that has been loaded.", + "brief": null, + "return": { + "type": "adc_device", + "description": "The adc_device pointer if found; otherwise, nullptr.", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "name": { + "type": "string", + "description": "The name of the ADC device.", "is_pointer": false, - "is_const": false, + "is_const": true, "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75811,29 +72820,29 @@ "static": "raspberry" }, "signatures": { - "python": [ - "def raspi_spi_transfer(handle, send, count, bytes_transfered):" - ], "cpp": [ - "string raspi_spi_transfer(int handle, const string &send, int count, int &bytes_transfered)" + "adc_device adc_device_named(const string &name)" + ], + "python": [ + "def adc_device_named(name):" ], "csharp": [ - "public static string SplashKit.RaspiSpiTransfer(int handle, string send, int count, ref int bytesTransfered);" + "public static AdcDevice SplashKit.AdcDeviceNamed(string name);" ], "pascal": [ - "function RaspiSpiTransfer(handle: Integer; const send: String; count: Integer; var bytesTransfered: Integer): String" + "function AdcDeviceNamed(const name: String): AdcDevice" ] } }, { - "signature": "void raspi_write(gpio_pin pin,gpio_pin_value value);", - "name": "raspi_write", + "signature": "void close_adc(adc_device adc);", + "name": "close_adc", "method_name": null, - "unique_global_name": "raspi_write", + "unique_global_name": "close_adc", "unique_method_name": null, "suffix_name": null, - "description": "This function writes the specified value to the specified pin.", - "brief": "Writes a value to the specified pin.", + "description": "Closes an ADC device given its pointer.", + "brief": null, "return": { "type": "void", "description": null, @@ -75843,9 +72852,9 @@ "type_parameter": null }, "parameters": { - "pin": { - "type": "gpio_pin", - "description": "The pin to write the value to.", + "adc": { + "type": "adc_device", + "description": "The ADC device to close.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -75855,13 +72864,54 @@ ], "is_vector": false, "type_parameter": null - }, - "value": { - "type": "gpio_pin_value", - "description": "The value to write to the pin.", + } + }, + "attributes": { + "class": "adc_device", + "destructor": true, + "self": "adc", + "group": "raspberry", + "static": "raspberry" + }, + "signatures": { + "cpp": [ + "void close_adc(adc_device adc)" + ], + "python": [ + "def close_adc(adc):" + ], + "csharp": [ + "public static void SplashKit.CloseAdc(AdcDevice adc);" + ], + "pascal": [ + "procedure CloseAdc(adc: AdcDevice)" + ] + } + }, + { + "signature": "void close_adc(const string &name);", + "name": "close_adc", + "method_name": null, + "unique_global_name": "close_adc_named", + "unique_method_name": null, + "suffix_name": null, + "description": "Closes an ADC device given its name.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "name": { + "type": "string", + "description": "The name of the ADC device to close.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75870,49 +72920,88 @@ "type_parameter": null } }, + "attributes": { + "suffix": "named", + "group": "raspberry", + "static": "raspberry" + }, + "signatures": { + "cpp": [ + "void close_adc(const string &name)" + ], + "python": [ + "def close_adc_named(name):" + ], + "csharp": [ + "public static void SplashKit.CloseAdc(string name);" + ], + "pascal": [ + "procedure CloseAdc(const name: String)" + ] + } + }, + { + "signature": "void close_all_adc();", + "name": "close_all_adc", + "method_name": null, + "unique_global_name": "close_all_adc", + "unique_method_name": null, + "suffix_name": null, + "description": "Closes all ADC devices that have been opened.", + "brief": null, + "return": { + "type": "void", + "description": null, + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + }, "attributes": { "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def raspi_write(pin, value):" - ], "cpp": [ - "void raspi_write(gpio_pin pin, gpio_pin_value value)" + "void close_all_adc()" + ], + "python": [ + "def close_all_adc():" ], "csharp": [ - "public static void SplashKit.RaspiWrite(GpioPin pin, GpioPinValue value);" + "public static void SplashKit.CloseAllAdc();" ], "pascal": [ - "procedure RaspiWrite(pin: GpioPin; value: GpioPinValue)" + "procedure CloseAllAdc()" ] } }, { - "signature": "bool remote_raspi_cleanup(connection pi);", - "name": "remote_raspi_cleanup", + "signature": "bool has_adc_device(const string &name);", + "name": "has_adc_device", "method_name": null, - "unique_global_name": "remote_raspi_cleanup", + "unique_global_name": "has_adc_device", "unique_method_name": null, "suffix_name": null, - "description": "This function closes the connection to the remote Raspberry Pi and releases any resources associated with it.", - "brief": "Cleans up and releases the connection to a remote Raspberry Pi.", + "description": "Checks if an ADC device with the given name has been loaded.", + "brief": null, "return": { "type": "bool", - "description": "true if the cleanup was successful, false otherwise.", + "description": "true if an ADC device with the supplied name exists.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pi": { - "type": "connection", - "description": "The connection object to the remote Raspberry Pi.", + "name": { + "type": "string", + "description": "The name used to identify the ADC device.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75926,44 +73015,44 @@ "static": "raspberry" }, "signatures": { - "python": [ - "def remote_raspi_cleanup(pi):" - ], "cpp": [ - "bool remote_raspi_cleanup(connection pi)" + "bool has_adc_device(const string &name)" + ], + "python": [ + "def has_adc_device(name):" ], "csharp": [ - "public static bool SplashKit.RemoteRaspiCleanup(Connection pi);" + "public static bool SplashKit.HasAdcDevice(string name);" ], "pascal": [ - "function RemoteRaspiCleanup(pi: Connection): Boolean" + "function HasAdcDevice(const name: String): Boolean" ] } }, { - "signature": "gpio_pin_mode remote_raspi_get_mode(connection pi,gpio_pin pin);", - "name": "remote_raspi_get_mode", + "signature": "adc_device open_adc(const string &name,adc_type type);", + "name": "open_adc", "method_name": null, - "unique_global_name": "remote_raspi_get_mode", + "unique_global_name": "open_adc", "unique_method_name": null, "suffix_name": null, - "description": "This function retrieves the mode of a specific pin on a remote Raspberry Pi.", - "brief": "Gets the mode of the specified pin on a remote Raspberry Pi.", + "description": "Opens an ADC device with the specified name and type. Defaults to bus 1 and address 0x48.", + "brief": null, "return": { - "type": "gpio_pin_mode", - "description": "The mode of the pin.", + "type": "adc_device", + "description": "A valid adc_device on success, or nullptr on failure.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pi": { - "type": "connection", - "description": "The connection object to the remote Raspberry Pi.", + "name": { + "type": "string", + "description": "The name of the ADC device to open.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -75971,9 +73060,9 @@ "is_vector": false, "type_parameter": null }, - "pin": { - "type": "gpio_pin", - "description": "The pin to get the mode for.", + "type": { + "type": "adc_type", + "description": "The type of ADC device (e.g., ADS7830, PCF8591).", "is_pointer": false, "is_const": false, "is_reference": false, @@ -75986,36 +73075,39 @@ } }, "attributes": { + "class": "adc_device", + "constructor": true, "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def remote_raspi_get_mode(pi, pin):" - ], "cpp": [ - "gpio_pin_mode remote_raspi_get_mode(connection pi, gpio_pin pin)" + "adc_device open_adc(const string &name, adc_type type)" + ], + "python": [ + "def open_adc(name, type):" ], "csharp": [ - "public static GpioPinMode SplashKit.RemoteRaspiGetMode(Connection pi, GpioPin pin);" + "public static AdcDevice SplashKit.OpenAdc(string name, AdcType type);", + "public AdcDevice(string name, AdcType type);" ], "pascal": [ - "function RemoteRaspiGetMode(pi: Connection; pin: GpioPin): GpioPinMode" + "function OpenAdc(const name: String; type: AdcType): AdcDevice" ] } }, { - "signature": "connection remote_raspi_init(const string &name,const string &host,unsigned short int port);", - "name": "remote_raspi_init", + "signature": "adc_device open_adc(const string &name,int bus,int address,adc_type type);", + "name": "open_adc", "method_name": null, - "unique_global_name": "remote_raspi_init", + "unique_global_name": "open_adc_with_bus", "unique_method_name": null, "suffix_name": null, - "description": "This function initialises a connection to a remote Raspberry Pi using the specified name, host, and port.", - "brief": "Initialises a remote connection to a Raspberry Pi.", + "description": "Loads an ADC device on the specified I2C bus at a given address.", + "brief": null, "return": { - "type": "connection", - "description": "The connection object used to communicate with the remote Raspberry Pi.", + "type": "adc_device", + "description": "A valid adc_device on success, or nullptr on failure.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -76024,7 +73116,7 @@ "parameters": { "name": { "type": "string", - "description": "The name of the connection.", + "description": "The name to assign this ADC device.", "is_pointer": false, "is_const": true, "is_reference": true, @@ -76035,12 +73127,12 @@ "is_vector": false, "type_parameter": null }, - "host": { - "type": "string", - "description": "The host address of the Raspberry Pi.", + "bus": { + "type": "int", + "description": "The I2C bus number.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -76048,9 +73140,22 @@ "is_vector": false, "type_parameter": null }, - "port": { - "type": "unsigned short", - "description": "The port to use for the connection.", + "address": { + "type": "int", + "description": "The I2C address of the ADC device.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "type": { + "type": "adc_type", + "description": "The type of ADC device (e.g., ADS7830, PCF8591).", "is_pointer": false, "is_const": false, "is_reference": false, @@ -76063,45 +73168,49 @@ } }, "attributes": { + "class": "adc_device", + "constructor": true, + "suffix": "with_bus", "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def remote_raspi_init(name, host, port):" - ], "cpp": [ - "connection remote_raspi_init(const string &name, const string &host, unsigned short port)" + "adc_device open_adc(const string &name, int bus, int address, adc_type type)" + ], + "python": [ + "def open_adc_with_bus(name, bus, address, type):" ], "csharp": [ - "public static Connection SplashKit.RemoteRaspiInit(string name, string host, ushort port);" + "public static AdcDevice SplashKit.OpenAdc(string name, int bus, int address, AdcType type);", + "public AdcDevice(string name, int bus, int address, AdcType type);" ], "pascal": [ - "function RemoteRaspiInit(const name: String; const host: String; port: Word): Connection" + "function OpenAdc(const name: String; bus: Integer; address: Integer; type: AdcType): AdcDevice" ] } }, { - "signature": "gpio_pin_value remote_raspi_read(connection pi,gpio_pin pin);", - "name": "remote_raspi_read", - "method_name": null, - "unique_global_name": "remote_raspi_read", - "unique_method_name": null, + "signature": "int read_adc(adc_device adc,adc_pin channel);", + "name": "read_adc", + "method_name": "read", + "unique_global_name": "read_adc", + "unique_method_name": "adc_device.read", "suffix_name": null, - "description": "This function reads the value from a specific pin on a remote Raspberry Pi.", - "brief": "Reads the value from the specified pin on a remote Raspberry Pi.", + "description": "Reads an 8-bit value from the specified ADC channel on the device.", + "brief": null, "return": { - "type": "gpio_pin_value", - "description": "The value read from the pin.", + "type": "int", + "description": "The ADC conversion value (0–255), or -1 on error.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pi": { - "type": "connection", - "description": "The connection object to the remote Raspberry Pi.", + "adc": { + "type": "adc_device", + "description": "The ADC device to read from.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -76112,9 +73221,9 @@ "is_vector": false, "type_parameter": null }, - "pin": { - "type": "gpio_pin", - "description": "The pin to read the value from.", + "channel": { + "type": "adc_pin", + "description": "The channel number to read (range depends on ADC type).", "is_pointer": false, "is_const": false, "is_reference": false, @@ -76127,61 +73236,52 @@ } }, "attributes": { + "class": "adc_device", + "method": "read", + "self": "adc", "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def remote_raspi_read(pi, pin):" - ], "cpp": [ - "gpio_pin_value remote_raspi_read(connection pi, gpio_pin pin)" + "int read_adc(adc_device adc, adc_pin channel)" + ], + "python": [ + "def read_adc(adc, channel):" ], "csharp": [ - "public static GpioPinValue SplashKit.RemoteRaspiRead(Connection pi, GpioPin pin);" + "public int AdcDevice.Read(AdcPin channel);", + "public static int SplashKit.ReadAdc(AdcDevice adc, AdcPin channel);" ], "pascal": [ - "function RemoteRaspiRead(pi: Connection; pin: GpioPin): GpioPinValue" + "function ReadAdc(adc: AdcDevice; channel: AdcPin): Integer" ] } }, { - "signature": "void remote_raspi_set_mode(connection pi,gpio_pin pin,gpio_pin_mode mode);", - "name": "remote_raspi_set_mode", + "signature": "int read_adc(const string &name,adc_pin channel);", + "name": "read_adc", "method_name": null, - "unique_global_name": "remote_raspi_set_mode", + "unique_global_name": "read_adc_named", "unique_method_name": null, "suffix_name": null, - "description": "This function sets the mode of a specific pin on a remote Raspberry Pi.", - "brief": "Sets the mode of the specified pin on a remote Raspberry Pi.", + "description": "Reads an 8-bit value from the specified ADC channel on the device using its name.", + "brief": null, "return": { - "type": "void", - "description": null, + "type": "int", + "description": "The ADC conversion value (0–255), or -1 on error.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pi": { - "type": "connection", - "description": "The connection object to the remote Raspberry Pi.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "pin": { - "type": "gpio_pin", - "description": "The pin to set the mode for.", + "name": { + "type": "string", + "description": "The ADC name string to close.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -76189,9 +73289,9 @@ "is_vector": false, "type_parameter": null }, - "mode": { - "type": "gpio_pin_mode", - "description": "The mode to set for the pin.", + "channel": { + "type": "adc_pin", + "description": "The channel number to read (range depends on ADC type).", "is_pointer": false, "is_const": false, "is_reference": false, @@ -76204,110 +73304,72 @@ } }, "attributes": { + "suffix": "named", "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def remote_raspi_set_mode(pi, pin, mode):" - ], "cpp": [ - "void remote_raspi_set_mode(connection pi, gpio_pin pin, gpio_pin_mode mode)" + "int read_adc(const string &name, adc_pin channel)" + ], + "python": [ + "def read_adc_named(name, channel):" ], "csharp": [ - "public static void SplashKit.RemoteRaspiSetMode(Connection pi, GpioPin pin, GpioPinMode mode);" + "public static int SplashKit.ReadAdc(string name, AdcPin channel);" ], "pascal": [ - "procedure RemoteRaspiSetMode(pi: Connection; pin: GpioPin; mode: GpioPinMode)" + "function ReadAdc(const name: String; channel: AdcPin): Integer" ] } }, { - "signature": "void remote_raspi_set_pull_up_down(connection pi,gpio_pin pin,pull_up_down pud);", - "name": "remote_raspi_set_pull_up_down", + "signature": "bool has_gpio();", + "name": "has_gpio", "method_name": null, - "unique_global_name": "remote_raspi_set_pull_up_down", + "unique_global_name": "has_gpio", "unique_method_name": null, "suffix_name": null, - "description": "This function sets the pull-up/down mode of a specific pin on a remote Raspberry Pi.", - "brief": "Sets the pull up/down mode for the specified pin on a remote Raspberry Pi.", + "description": "Checks if the system has GPIO capabilities.", + "brief": null, "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "true if the system has GPIO capabilities, false otherwise.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pi": { - "type": "connection", - "description": "The connection object to the remote Raspberry Pi.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "pin": { - "type": "gpio_pin", - "description": "The pin to set the pull up/down mode for.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "pud": { - "type": "pull_up_down", - "description": "The pull up/down mode to set for the pin.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def remote_raspi_set_pull_up_down(pi, pin, pud):" - ], "cpp": [ - "void remote_raspi_set_pull_up_down(connection pi, gpio_pin pin, pull_up_down pud)" + "bool has_gpio()" + ], + "python": [ + "def has_gpio():" ], "csharp": [ - "public static void SplashKit.RemoteRaspiSetPullUpDown(Connection pi, GpioPin pin, PullUpDown pud);" + "public static bool SplashKit.HasGpio();" ], "pascal": [ - "procedure RemoteRaspiSetPullUpDown(pi: Connection; pin: GpioPin; pud: PullUpDown)" + "function HasGpio(): Boolean" ] } }, { - "signature": "void remote_raspi_set_pwm_dutycycle(connection pi,gpio_pin pin,int dutycycle);", - "name": "remote_raspi_set_pwm_dutycycle", + "signature": "void raspi_cleanup();", + "name": "raspi_cleanup", "method_name": null, - "unique_global_name": "remote_raspi_set_pwm_dutycycle", + "unique_global_name": "raspi_cleanup", "unique_method_name": null, "suffix_name": null, - "description": "This function sets the PWM duty cycle for a specific pin on a remote Raspberry Pi.", - "brief": "Sets the PWM duty cycle for the specified pin on a remote Raspberry Pi.", + "description": "This function should be called when you are finished using the GPIO library. It sets all pin modes to INPUT and values to LOW.", + "brief": "Cleans up and releases any resources used by the GPIO library.", "return": { "type": "void", "description": null, @@ -76317,112 +73379,47 @@ "type_parameter": null }, "parameters": { - "pi": { - "type": "connection", - "description": "The connection object to the remote Raspberry Pi.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "pin": { - "type": "gpio_pin", - "description": "The pin to set the PWM duty cycle for.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "dutycycle": { - "type": "int", - "description": "The PWM duty cycle to set for the pin.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } }, "attributes": { "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def remote_raspi_set_pwm_dutycycle(pi, pin, dutycycle):" - ], "cpp": [ - "void remote_raspi_set_pwm_dutycycle(connection pi, gpio_pin pin, int dutycycle)" + "void raspi_cleanup()" + ], + "python": [ + "def raspi_cleanup():" ], "csharp": [ - "public static void SplashKit.RemoteRaspiSetPwmDutycycle(Connection pi, GpioPin pin, int dutycycle);" + "public static void SplashKit.RaspiCleanup();" ], "pascal": [ - "procedure RemoteRaspiSetPwmDutycycle(pi: Connection; pin: GpioPin; dutycycle: Integer)" + "procedure RaspiCleanup()" ] } }, { - "signature": "void remote_raspi_set_pwm_frequency(connection pi,gpio_pin pin,int frequency);", - "name": "remote_raspi_set_pwm_frequency", + "signature": "gpio_pin_mode raspi_get_mode(gpio_pin pin);", + "name": "raspi_get_mode", "method_name": null, - "unique_global_name": "remote_raspi_set_pwm_frequency", + "unique_global_name": "raspi_get_mode", "unique_method_name": null, "suffix_name": null, - "description": "This function sets the PWM frequency for a specific pin on a remote Raspberry Pi.", - "brief": "Sets the PWM frequency for the specified pin on a remote Raspberry Pi.", + "description": "This function retrieves the mode of the specified pin.", + "brief": "Gets the mode of the specified pin.", "return": { - "type": "void", - "description": null, + "type": "gpio_pin_mode", + "description": "The mode of the pin.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "pi": { - "type": "connection", - "description": "The connection object to the remote Raspberry Pi.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, "pin": { "type": "gpio_pin", - "description": "The pin to set the PWM frequency for.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "frequency": { - "type": "int", - "description": "The PWM frequency to set for the pin.", + "description": "The pin to get the mode for.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -76439,29 +73436,29 @@ "static": "raspberry" }, "signatures": { - "python": [ - "def remote_raspi_set_pwm_frequency(pi, pin, frequency):" - ], "cpp": [ - "void remote_raspi_set_pwm_frequency(connection pi, gpio_pin pin, int frequency)" + "gpio_pin_mode raspi_get_mode(gpio_pin pin)" + ], + "python": [ + "def raspi_get_mode(pin):" ], "csharp": [ - "public static void SplashKit.RemoteRaspiSetPwmFrequency(Connection pi, GpioPin pin, int frequency);" + "public static GpioPinMode SplashKit.RaspiGetMode(GpioPin pin);" ], "pascal": [ - "procedure RemoteRaspiSetPwmFrequency(pi: Connection; pin: GpioPin; frequency: Integer)" + "function RaspiGetMode(pin: GpioPin): GpioPinMode" ] } }, { - "signature": "void remote_raspi_set_pwm_range(connection pi,gpio_pin pin,int range);", - "name": "remote_raspi_set_pwm_range", + "signature": "void raspi_init();", + "name": "raspi_init", "method_name": null, - "unique_global_name": "remote_raspi_set_pwm_range", + "unique_global_name": "raspi_init", "unique_method_name": null, "suffix_name": null, - "description": "This function sets the PWM range for a specific pin on a remote Raspberry Pi.\nValid values for the range are 25 - 40000", - "brief": "Sets the PWM range for the specified pin on a remote Raspberry Pi.", + "description": "This function initializes the GPIO library for use. It should be called before any other GPIO functions.", + "brief": "Initializes the GPIO library.", "return": { "type": "void", "description": null, @@ -76471,35 +73468,47 @@ "type_parameter": null }, "parameters": { - "pi": { - "type": "connection", - "description": "The connection object to the remote Raspberry Pi.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "pin": { - "type": "gpio_pin", - "description": "The pin to set the PWM range for.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "range": { - "type": "int", - "description": "The PWM range to set for the pin.", + }, + "attributes": { + "group": "raspberry", + "static": "raspberry" + }, + "signatures": { + "cpp": [ + "void raspi_init()" + ], + "python": [ + "def raspi_init():" + ], + "csharp": [ + "public static void SplashKit.RaspiInit();" + ], + "pascal": [ + "procedure RaspiInit()" + ] + } + }, + { + "signature": "gpio_pin_value raspi_read(gpio_pin pin);", + "name": "raspi_read", + "method_name": null, + "unique_global_name": "raspi_read", + "unique_method_name": null, + "suffix_name": null, + "description": "This function reads the value from the specified pin.", + "brief": "Reads the value from the specified pin.", + "return": { + "type": "gpio_pin_value", + "description": "The value read from the pin.", + "is_pointer": false, + "is_reference": false, + "is_vector": false, + "type_parameter": null + }, + "parameters": { + "pin": { + "type": "gpio_pin", + "description": "The pin to read the value from.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -76516,29 +73525,29 @@ "static": "raspberry" }, "signatures": { - "python": [ - "def remote_raspi_set_pwm_range(pi, pin, range):" - ], "cpp": [ - "void remote_raspi_set_pwm_range(connection pi, gpio_pin pin, int range)" + "gpio_pin_value raspi_read(gpio_pin pin)" + ], + "python": [ + "def raspi_read(pin):" ], "csharp": [ - "public static void SplashKit.RemoteRaspiSetPwmRange(Connection pi, GpioPin pin, int range);" + "public static GpioPinValue SplashKit.RaspiRead(GpioPin pin);" ], "pascal": [ - "procedure RemoteRaspiSetPwmRange(pi: Connection; pin: GpioPin; range: Integer)" + "function RaspiRead(pin: GpioPin): GpioPinValue" ] } }, { - "signature": "void remote_raspi_write(connection pi,gpio_pin pin,gpio_pin_value value);", - "name": "remote_raspi_write", + "signature": "void raspi_set_mode(gpio_pin pin,gpio_pin_mode mode);", + "name": "raspi_set_mode", "method_name": null, - "unique_global_name": "remote_raspi_write", + "unique_global_name": "raspi_set_mode", "unique_method_name": null, "suffix_name": null, - "description": "This function writes a specified value to a specific pin on a remote Raspberry Pi.", - "brief": "Writes a value to the specified pin on a remote Raspberry Pi.", + "description": "This function sets the mode of the specified pin to the specified mode.", + "brief": "Sets the mode of the specified pin.", "return": { "type": "void", "description": null, @@ -76548,22 +73557,9 @@ "type_parameter": null }, "parameters": { - "pi": { - "type": "connection", - "description": "The connection object to the remote Raspberry Pi.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, "pin": { "type": "gpio_pin", - "description": "The pin to write the value to.", + "description": "The pin to set the mode for.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -76574,9 +73570,9 @@ "is_vector": false, "type_parameter": null }, - "value": { - "type": "gpio_pin_value", - "description": "The value to write to the pin.", + "mode": { + "type": "gpio_pin_mode", + "description": "The mode to set for the pin.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -76593,29 +73589,29 @@ "static": "raspberry" }, "signatures": { - "python": [ - "def remote_raspi_write(pi, pin, value):" - ], "cpp": [ - "void remote_raspi_write(connection pi, gpio_pin pin, gpio_pin_value value)" + "void raspi_set_mode(gpio_pin pin, gpio_pin_mode mode)" + ], + "python": [ + "def raspi_set_mode(pin, mode):" ], "csharp": [ - "public static void SplashKit.RemoteRaspiWrite(Connection pi, GpioPin pin, GpioPinValue value);" + "public static void SplashKit.RaspiSetMode(GpioPin pin, GpioPinMode mode);" ], "pascal": [ - "procedure RemoteRaspiWrite(pi: Connection; pin: GpioPin; value: GpioPinValue)" + "procedure RaspiSetMode(pin: GpioPin; mode: GpioPinMode)" ] } }, { - "signature": "void close_all_motors();", - "name": "close_all_motors", + "signature": "void raspi_set_pull_up_down(gpio_pin pin,pull_up_down pud);", + "name": "raspi_set_pull_up_down", "method_name": null, - "unique_global_name": "close_all_motors", + "unique_global_name": "raspi_set_pull_up_down", "unique_method_name": null, "suffix_name": null, - "description": "Closes all opened motor devices.", - "brief": null, + "description": "This function sets the pull-up/down mode for the specified pin.", + "brief": "Sets the pull up/down mode for the specified pin.", "return": { "type": "void", "description": null, @@ -76625,35 +73621,61 @@ "type_parameter": null }, "parameters": { + "pin": { + "type": "gpio_pin", + "description": "The pin to set the pull up/down mode for.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pud": { + "type": "pull_up_down", + "description": "The pull up/down mode to set for the pin.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def close_all_motors():" - ], "cpp": [ - "void close_all_motors()" + "void raspi_set_pull_up_down(gpio_pin pin, pull_up_down pud)" + ], + "python": [ + "def raspi_set_pull_up_down(pin, pud):" ], "csharp": [ - "public static void SplashKit.CloseAllMotors();" + "public static void SplashKit.RaspiSetPullUpDown(GpioPin pin, PullUpDown pud);" ], "pascal": [ - "procedure CloseAllMotors()" + "procedure RaspiSetPullUpDown(pin: GpioPin; pud: PullUpDown)" ] } }, { - "signature": "void close_motor(const string &name);", - "name": "close_motor", + "signature": "void raspi_set_pwm_dutycycle(gpio_pin pin,int dutycycle);", + "name": "raspi_set_pwm_dutycycle", "method_name": null, - "unique_global_name": "close_motor_named", + "unique_global_name": "raspi_set_pwm_dutycycle", "unique_method_name": null, "suffix_name": null, - "description": "Closes and frees a motor device by name.", - "brief": null, + "description": "This function sets the PWM duty cycle for the specified pin.", + "brief": "Sets the PWM duty cycle for the specified pin.", "return": { "type": "void", "description": null, @@ -76663,12 +73685,25 @@ "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "Name of the motor device.", + "pin": { + "type": "gpio_pin", + "description": "The pin to set the PWM duty cycle for.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "dutycycle": { + "type": "int", + "description": "The PWM duty cycle to set for the pin.", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -76678,34 +73713,33 @@ } }, "attributes": { - "suffix": "named", "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def close_motor_named(name):" - ], "cpp": [ - "void close_motor(const string &name)" + "void raspi_set_pwm_dutycycle(gpio_pin pin, int dutycycle)" + ], + "python": [ + "def raspi_set_pwm_dutycycle(pin, dutycycle):" ], "csharp": [ - "public static void SplashKit.CloseMotor(string name);" + "public static void SplashKit.RaspiSetPwmDutycycle(GpioPin pin, int dutycycle);" ], "pascal": [ - "procedure CloseMotor(const name: String)" + "procedure RaspiSetPwmDutycycle(pin: GpioPin; dutycycle: Integer)" ] } }, { - "signature": "void close_motor(motor_device dev);", - "name": "close_motor", + "signature": "void raspi_set_pwm_frequency(gpio_pin pin,int frequency);", + "name": "raspi_set_pwm_frequency", "method_name": null, - "unique_global_name": "close_motor", + "unique_global_name": "raspi_set_pwm_frequency", "unique_method_name": null, "suffix_name": null, - "description": "Closes and frees resources for a motor device.", - "brief": null, + "description": "This function sets the PWM frequency for the specified pin.", + "brief": "Sets the PWM frequency for the specified pin.", "return": { "type": "void", "description": null, @@ -76715,9 +73749,22 @@ "type_parameter": null }, "parameters": { - "dev": { - "type": "motor_device", - "description": "The motor device handle.", + "pin": { + "type": "gpio_pin", + "description": "The pin to set the PWM frequency for.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "frequency": { + "type": "int", + "description": "The PWM frequency to set for the pin.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -76734,29 +73781,29 @@ "static": "raspberry" }, "signatures": { - "python": [ - "def close_motor(dev):" - ], "cpp": [ - "void close_motor(motor_device dev)" + "void raspi_set_pwm_frequency(gpio_pin pin, int frequency)" + ], + "python": [ + "def raspi_set_pwm_frequency(pin, frequency):" ], "csharp": [ - "public static void SplashKit.CloseMotor(MotorDevice dev);" + "public static void SplashKit.RaspiSetPwmFrequency(GpioPin pin, int frequency);" ], "pascal": [ - "procedure CloseMotor(dev: MotorDevice)" + "procedure RaspiSetPwmFrequency(pin: GpioPin; frequency: Integer)" ] } }, { - "signature": "void free_motor_device(motor_device dev);", - "name": "free_motor_device", + "signature": "void raspi_set_pwm_range(gpio_pin pin,int range);", + "name": "raspi_set_pwm_range", "method_name": null, - "unique_global_name": "free_motor_device", + "unique_global_name": "raspi_set_pwm_range", "unique_method_name": null, "suffix_name": null, - "description": "Free the resources associated with a motor device.", - "brief": null, + "description": "This function sets the PWM range for the specified pin.\nValid values for the range are 25 - 40000", + "brief": "Sets the PWM range for the specified pin.", "return": { "type": "void", "description": null, @@ -76766,9 +73813,22 @@ "type_parameter": null }, "parameters": { - "dev": { - "type": "motor_device", - "description": "The motor device to be destroyed.", + "pin": { + "type": "gpio_pin", + "description": "The pin to set the PWM range for.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "range": { + "type": "int", + "description": "The PWM range to set for the pin.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -76781,51 +73841,48 @@ } }, "attributes": { - "class": "motor_device", - "destructor": true, "group": "raspberry", - "static": "raspberry", - "self": "dev" + "static": "raspberry" }, "signatures": { - "python": [ - "def free_motor_device(dev):" - ], "cpp": [ - "void free_motor_device(motor_device dev)" + "void raspi_set_pwm_range(gpio_pin pin, int range)" + ], + "python": [ + "def raspi_set_pwm_range(pin, range):" ], "csharp": [ - "public static void SplashKit.FreeMotorDevice(MotorDevice dev);" + "public static void SplashKit.RaspiSetPwmRange(GpioPin pin, int range);" ], "pascal": [ - "procedure FreeMotorDevice(dev: MotorDevice)" + "procedure RaspiSetPwmRange(pin: GpioPin; range: Integer)" ] } }, { - "signature": "bool has_motor_device(const string &name);", - "name": "has_motor_device", + "signature": "int raspi_spi_close(int handle);", + "name": "raspi_spi_close", "method_name": null, - "unique_global_name": "has_motor_device", + "unique_global_name": "raspi_spi_close", "unique_method_name": null, "suffix_name": null, - "description": "Checks if a motor device with the given name is already opened.", - "brief": null, + "description": "This function closes SPI communication on a particular channel.", + "brief": "Closes SPI communication on selected channel. It will return -1 if not using Raspberry Pi.", "return": { - "type": "bool", - "description": "true if open, false otherwise.", + "type": "int", + "description": "A value indicating success or failure.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "Identifier for the motor driver.", + "handle": { + "type": "int", + "description": "A reference to the specific SPI connection to close.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -76839,44 +73896,70 @@ "static": "raspberry" }, "signatures": { - "python": [ - "def has_motor_device(name):" - ], "cpp": [ - "bool has_motor_device(const string &name)" + "int raspi_spi_close(int handle)" + ], + "python": [ + "def raspi_spi_close(handle):" ], "csharp": [ - "public static bool SplashKit.HasMotorDevice(string name);" + "public static int SplashKit.RaspiSpiClose(int handle);" ], "pascal": [ - "function HasMotorDevice(const name: String): Boolean" + "function RaspiSpiClose(handle: Integer): Integer" ] } }, { - "signature": "motor_device motor_named(const string &name);", - "name": "motor_named", + "signature": "int raspi_spi_open(int channel,int speed,int spi_flags);", + "name": "raspi_spi_open", "method_name": null, - "unique_global_name": "motor_named", + "unique_global_name": "raspi_spi_open", "unique_method_name": null, "suffix_name": null, - "description": "Retrieves an existing motor device handle by name.", - "brief": null, + "description": "This function opens SPI communication on a particular channel. It will return -1 if not using Raspberry Pi.", + "brief": "Opens SPI communication on selected channel.", "return": { - "type": "motor_device", - "description": "motor_device pointer or nullptr.", + "type": "int", + "description": "The handle referencing this particular connection.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "Identifier for the motor driver.", + "channel": { + "type": "int", + "description": "The SPI channel to use.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "speed": { + "type": "int", + "description": "The speed of data transfer (in baud).", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "spi_flags": { + "type": "int", + "description": "Optional flags for the SPI modes and settings.", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -76890,54 +73973,41 @@ "static": "raspberry" }, "signatures": { - "python": [ - "def motor_named(name):" - ], "cpp": [ - "motor_device motor_named(const string &name)" + "int raspi_spi_open(int channel, int speed, int spi_flags)" + ], + "python": [ + "def raspi_spi_open(channel, speed, spi_flags):" ], "csharp": [ - "public static MotorDevice SplashKit.MotorNamed(string name);" + "public static int SplashKit.RaspiSpiOpen(int channel, int speed, int spiFlags);" ], "pascal": [ - "function MotorNamed(const name: String): MotorDevice" + "function RaspiSpiOpen(channel: Integer; speed: Integer; spiFlags: Integer): Integer" ] } }, { - "signature": "motor_device open_motor(const string &name,motor_driver_type type,gpio_pin in1_pin,gpio_pin in2_pin,gpio_pin en_pin);", - "name": "open_motor", + "signature": "string raspi_spi_transfer(int handle,const string &send,int count,int &bytes_transfered);", + "name": "raspi_spi_transfer", "method_name": null, - "unique_global_name": "open_motor", + "unique_global_name": "raspi_spi_transfer", "unique_method_name": null, "suffix_name": null, - "description": "Opens a motor device with the specified parameters.", - "brief": null, + "description": "This function transfers data through SPI, it sends data from sendBuf and receives it into recvBuf.", + "brief": "Transfers data on specified SPI connection. It will return -1 if not using Raspberry Pi.", "return": { - "type": "motor_device", - "description": "A valid motor_device on success, or nullptr on failure.", + "type": "string", + "description": "The data returned from the spi transfer", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "Identifier for the motor driver.", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "type": { - "type": "motor_driver_type", - "description": "Type of motor driver (e.g., L298N).", + "handle": { + "type": "int", + "description": "The reference for a specific SPI connection.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -76948,12 +74018,12 @@ "is_vector": false, "type_parameter": null }, - "in1_pin": { - "type": "gpio_pin", - "description": "GPIO pin for IN1.", + "send": { + "type": "string", + "description": "The data to send.", "is_pointer": false, - "is_const": false, - "is_reference": false, + "is_const": true, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -76961,9 +74031,9 @@ "is_vector": false, "type_parameter": null }, - "in2_pin": { - "type": "gpio_pin", - "description": "GPIO pin for IN2.", + "count": { + "type": "int", + "description": "The number of bytes to be transferred.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -76974,12 +74044,12 @@ "is_vector": false, "type_parameter": null }, - "en_pin": { - "type": "gpio_pin", - "description": "GPIO pin for ENA.", + "bytes_transfered": { + "type": "int", + "description": "The number of bytes transferred (output)", "is_pointer": false, "is_const": false, - "is_reference": false, + "is_reference": true, "is_array": false, "array_dimension_sizes": [ @@ -76993,29 +74063,29 @@ "static": "raspberry" }, "signatures": { - "python": [ - "def open_motor(name, type, in1_pin, in2_pin, en_pin):" - ], "cpp": [ - "motor_device open_motor(const string &name, motor_driver_type type, gpio_pin in1_pin, gpio_pin in2_pin, gpio_pin en_pin)" + "string raspi_spi_transfer(int handle, const string &send, int count, int &bytes_transfered)" + ], + "python": [ + "def raspi_spi_transfer(handle, send, count, bytes_transfered):" ], "csharp": [ - "public static MotorDevice SplashKit.OpenMotor(string name, MotorDriverType type, GpioPin in1Pin, GpioPin in2Pin, GpioPin enPin);" + "public static string SplashKit.RaspiSpiTransfer(int handle, string send, int count, ref int bytesTransfered);" ], "pascal": [ - "function OpenMotor(const name: String; type: MotorDriverType; in1Pin: GpioPin; in2Pin: GpioPin; enPin: GpioPin): MotorDevice" + "function RaspiSpiTransfer(handle: Integer; const send: String; count: Integer; var bytesTransfered: Integer): String" ] } }, { - "signature": "void set_motor_direction(motor_device dev,motor_direction dir);", - "name": "set_motor_direction", + "signature": "void raspi_write(gpio_pin pin,gpio_pin_value value);", + "name": "raspi_write", "method_name": null, - "unique_global_name": "set_motor_direction", + "unique_global_name": "raspi_write", "unique_method_name": null, "suffix_name": null, - "description": "Sets the motor rotation direction.", - "brief": null, + "description": "This function writes the specified value to the specified pin.", + "brief": "Writes a value to the specified pin.", "return": { "type": "void", "description": null, @@ -77025,9 +74095,9 @@ "type_parameter": null }, "parameters": { - "dev": { - "type": "motor_device", - "description": "The motor device handle.", + "pin": { + "type": "gpio_pin", + "description": "The pin to write the value to.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -77038,9 +74108,9 @@ "is_vector": false, "type_parameter": null }, - "dir": { - "type": "motor_direction", - "description": "Desired rotation direction.", + "value": { + "type": "gpio_pin_value", + "description": "The value to write to the pin.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -77057,54 +74127,41 @@ "static": "raspberry" }, "signatures": { - "python": [ - "def set_motor_direction(dev, dir):" - ], "cpp": [ - "void set_motor_direction(motor_device dev, motor_direction dir)" + "void raspi_write(gpio_pin pin, gpio_pin_value value)" + ], + "python": [ + "def raspi_write(pin, value):" ], "csharp": [ - "public static void SplashKit.SetMotorDirection(MotorDevice dev, MotorDirection dir);" + "public static void SplashKit.RaspiWrite(GpioPin pin, GpioPinValue value);" ], "pascal": [ - "procedure SetMotorDirection(dev: MotorDevice; dir: MotorDirection)" + "procedure RaspiWrite(pin: GpioPin; value: GpioPinValue)" ] } }, { - "signature": "void set_motor_speed(motor_device dev,double speed);", - "name": "set_motor_speed", + "signature": "bool remote_raspi_cleanup(connection pi);", + "name": "remote_raspi_cleanup", "method_name": null, - "unique_global_name": "set_motor_speed", + "unique_global_name": "remote_raspi_cleanup", "unique_method_name": null, "suffix_name": null, - "description": "Sets the PWM speed of the motor (0-1).", - "brief": null, + "description": "This function closes the connection to the remote Raspberry Pi and releases any resources associated with it.", + "brief": "Cleans up and releases the connection to a remote Raspberry Pi.", "return": { - "type": "void", - "description": null, + "type": "bool", + "description": "true if the cleanup was successful, false otherwise.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "dev": { - "type": "motor_device", - "description": "The motor device handle.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "speed": { - "type": "double", - "description": "Duty cycle speed (0..1).", + "pi": { + "type": "connection", + "description": "The connection object to the remote Raspberry Pi.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -77121,41 +74178,54 @@ "static": "raspberry" }, "signatures": { - "python": [ - "def set_motor_speed(dev, speed):" - ], "cpp": [ - "void set_motor_speed(motor_device dev, double speed)" + "bool remote_raspi_cleanup(connection pi)" + ], + "python": [ + "def remote_raspi_cleanup(pi):" ], "csharp": [ - "public static void SplashKit.SetMotorSpeed(MotorDevice dev, double speed);" + "public static bool SplashKit.RemoteRaspiCleanup(Connection pi);" ], "pascal": [ - "procedure SetMotorSpeed(dev: MotorDevice; speed: Double)" + "function RemoteRaspiCleanup(pi: Connection): Boolean" ] } }, { - "signature": "void stop_motor(motor_device dev);", - "name": "stop_motor", + "signature": "gpio_pin_mode remote_raspi_get_mode(connection pi,gpio_pin pin);", + "name": "remote_raspi_get_mode", "method_name": null, - "unique_global_name": "stop_motor", + "unique_global_name": "remote_raspi_get_mode", "unique_method_name": null, "suffix_name": null, - "description": "Stops the motor immediately (brake).", - "brief": null, + "description": "This function retrieves the mode of a specific pin on a remote Raspberry Pi.", + "brief": "Gets the mode of the specified pin on a remote Raspberry Pi.", "return": { - "type": "void", - "description": null, + "type": "gpio_pin_mode", + "description": "The mode of the pin.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "dev": { - "type": "motor_device", - "description": "The motor device handle.", + "pi": { + "type": "connection", + "description": "The connection object to the remote Raspberry Pi.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pin": { + "type": "gpio_pin", + "description": "The pin to get the mode for.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -77172,82 +74242,134 @@ "static": "raspberry" }, "signatures": { - "python": [ - "def stop_motor(dev):" - ], "cpp": [ - "void stop_motor(motor_device dev)" + "gpio_pin_mode remote_raspi_get_mode(connection pi, gpio_pin pin)" + ], + "python": [ + "def remote_raspi_get_mode(pi, pin):" ], "csharp": [ - "public static void SplashKit.StopMotor(MotorDevice dev);" + "public static GpioPinMode SplashKit.RemoteRaspiGetMode(Connection pi, GpioPin pin);" ], "pascal": [ - "procedure StopMotor(dev: MotorDevice)" + "function RemoteRaspiGetMode(pi: Connection; pin: GpioPin): GpioPinMode" ] } }, { - "signature": "void close_all_servos();", - "name": "close_all_servos", + "signature": "connection remote_raspi_init(const string &name,const string &host,unsigned short int port);", + "name": "remote_raspi_init", "method_name": null, - "unique_global_name": "close_all_servos", + "unique_global_name": "remote_raspi_init", "unique_method_name": null, "suffix_name": null, - "description": "Close *all* servos.", - "brief": null, + "description": "This function initialises a connection to a remote Raspberry Pi using the specified name, host, and port.", + "brief": "Initialises a remote connection to a Raspberry Pi.", "return": { - "type": "void", - "description": null, + "type": "connection", + "description": "The connection object used to communicate with the remote Raspberry Pi.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { + "name": { + "type": "string", + "description": "The name of the connection.", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "host": { + "type": "string", + "description": "The host address of the Raspberry Pi.", + "is_pointer": false, + "is_const": true, + "is_reference": true, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "port": { + "type": "unsigned short", + "description": "The port to use for the connection.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + } }, "attributes": { "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def close_all_servos():" - ], "cpp": [ - "void close_all_servos()" + "connection remote_raspi_init(const string &name, const string &host, unsigned short port)" + ], + "python": [ + "def remote_raspi_init(name, host, port):" ], "csharp": [ - "public static void SplashKit.CloseAllServos();" + "public static Connection SplashKit.RemoteRaspiInit(string name, string host, ushort port);" ], "pascal": [ - "procedure CloseAllServos()" + "function RemoteRaspiInit(const name: String; const host: String; port: Word): Connection" ] } }, { - "signature": "void close_servo(const string &name);", - "name": "close_servo", + "signature": "gpio_pin_value remote_raspi_read(connection pi,gpio_pin pin);", + "name": "remote_raspi_read", "method_name": null, - "unique_global_name": "close_servo_named", + "unique_global_name": "remote_raspi_read", "unique_method_name": null, "suffix_name": null, - "description": "Closes a servo device given its name.", - "brief": null, + "description": "This function reads the value from a specific pin on a remote Raspberry Pi.", + "brief": "Reads the value from the specified pin on a remote Raspberry Pi.", "return": { - "type": "void", - "description": null, + "type": "gpio_pin_value", + "description": "The value read from the pin.", "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "The name of the servo device to close.", + "pi": { + "type": "connection", + "description": "The connection object to the remote Raspberry Pi.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pin": { + "type": "gpio_pin", + "description": "The pin to read the value from.", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -77257,34 +74379,33 @@ } }, "attributes": { - "suffix": "named", "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def close_servo_named(name):" - ], "cpp": [ - "void close_servo(const string &name)" + "gpio_pin_value remote_raspi_read(connection pi, gpio_pin pin)" + ], + "python": [ + "def remote_raspi_read(pi, pin):" ], "csharp": [ - "public static void SplashKit.CloseServo(string name);" + "public static GpioPinValue SplashKit.RemoteRaspiRead(Connection pi, GpioPin pin);" ], "pascal": [ - "procedure CloseServo(const name: String)" + "function RemoteRaspiRead(pi: Connection; pin: GpioPin): GpioPinValue" ] } }, { - "signature": "void close_servo(servo_device dev);", - "name": "close_servo", - "method_name": "close", - "unique_global_name": "close_servo", - "unique_method_name": "servo_device.close", + "signature": "void remote_raspi_set_mode(connection pi,gpio_pin pin,gpio_pin_mode mode);", + "name": "remote_raspi_set_mode", + "method_name": null, + "unique_global_name": "remote_raspi_set_mode", + "unique_method_name": null, "suffix_name": null, - "description": "Close one servo (by handle) or by name.\nCloses a servo device given its pointer.", - "brief": null, + "description": "This function sets the mode of a specific pin on a remote Raspberry Pi.", + "brief": "Sets the mode of the specified pin on a remote Raspberry Pi.", "return": { "type": "void", "description": null, @@ -77294,9 +74415,35 @@ "type_parameter": null }, "parameters": { - "dev": { - "type": "servo_device", - "description": "The servo device to close.", + "pi": { + "type": "connection", + "description": "The connection object to the remote Raspberry Pi.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pin": { + "type": "gpio_pin", + "description": "The pin to set the mode for.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "mode": { + "type": "gpio_pin_mode", + "description": "The mode to set for the pin.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -77309,53 +74456,74 @@ } }, "attributes": { - "class": "servo_device", - "destructor": true, - "method": "close", - "self": "dev", "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def close_servo(dev):" - ], "cpp": [ - "void close_servo(servo_device dev)" + "void remote_raspi_set_mode(connection pi, gpio_pin pin, gpio_pin_mode mode)" + ], + "python": [ + "def remote_raspi_set_mode(pi, pin, mode):" ], "csharp": [ - "public void ServoDevice.Close();", - "public static void SplashKit.CloseServo(ServoDevice dev);" + "public static void SplashKit.RemoteRaspiSetMode(Connection pi, GpioPin pin, GpioPinMode mode);" ], "pascal": [ - "procedure CloseServo(dev: ServoDevice)" + "procedure RemoteRaspiSetMode(pi: Connection; pin: GpioPin; mode: GpioPinMode)" ] } }, { - "signature": "bool has_servo_device(const string &name);", - "name": "has_servo_device", + "signature": "void remote_raspi_set_pull_up_down(connection pi,gpio_pin pin,pull_up_down pud);", + "name": "remote_raspi_set_pull_up_down", "method_name": null, - "unique_global_name": "has_servo_device", + "unique_global_name": "remote_raspi_set_pull_up_down", "unique_method_name": null, "suffix_name": null, - "description": "Returns true if a servo with this name is already open.", - "brief": null, + "description": "This function sets the pull-up/down mode of a specific pin on a remote Raspberry Pi.", + "brief": "Sets the pull up/down mode for the specified pin on a remote Raspberry Pi.", "return": { - "type": "bool", - "description": "true if the servo is open, false otherwise.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "Your identifier for this servo.", + "pi": { + "type": "connection", + "description": "The connection object to the remote Raspberry Pi.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pin": { + "type": "gpio_pin", + "description": "The pin to set the pull up/down mode for.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pud": { + "type": "pull_up_down", + "description": "The pull up/down mode to set for the pin.", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -77369,44 +74537,44 @@ "static": "raspberry" }, "signatures": { - "python": [ - "def has_servo_device(name):" - ], "cpp": [ - "bool has_servo_device(const string &name)" + "void remote_raspi_set_pull_up_down(connection pi, gpio_pin pin, pull_up_down pud)" + ], + "python": [ + "def remote_raspi_set_pull_up_down(pi, pin, pud):" ], "csharp": [ - "public static bool SplashKit.HasServoDevice(string name);" + "public static void SplashKit.RemoteRaspiSetPullUpDown(Connection pi, GpioPin pin, PullUpDown pud);" ], "pascal": [ - "function HasServoDevice(const name: String): Boolean" + "procedure RemoteRaspiSetPullUpDown(pi: Connection; pin: GpioPin; pud: PullUpDown)" ] } }, { - "signature": "servo_device open_servo(const string &name,gpio_pin control_pin);", - "name": "open_servo", + "signature": "void remote_raspi_set_pwm_dutycycle(connection pi,gpio_pin pin,int dutycycle);", + "name": "remote_raspi_set_pwm_dutycycle", "method_name": null, - "unique_global_name": "open_servo", + "unique_global_name": "remote_raspi_set_pwm_dutycycle", "unique_method_name": null, "suffix_name": null, - "description": "Open (and initialize) a servo on the given board pin.", - "brief": null, + "description": "This function sets the PWM duty cycle for a specific pin on a remote Raspberry Pi.", + "brief": "Sets the PWM duty cycle for the specified pin on a remote Raspberry Pi.", "return": { - "type": "servo_device", - "description": "A valid servo_device, or nullptr on failure.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "Your identifier for this servo.", + "pi": { + "type": "connection", + "description": "The connection object to the remote Raspberry Pi.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -77414,9 +74582,22 @@ "is_vector": false, "type_parameter": null }, - "control_pin": { + "pin": { "type": "gpio_pin", - "description": "Board‐numbered GPIO pin for the servo signal line.", + "description": "The pin to set the PWM duty cycle for.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "dutycycle": { + "type": "int", + "description": "The PWM duty cycle to set for the pin.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -77429,51 +74610,74 @@ } }, "attributes": { - "class": "servo_device", - "constructor": true, "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def open_servo(name, control_pin):" - ], "cpp": [ - "servo_device open_servo(const string &name, gpio_pin control_pin)" + "void remote_raspi_set_pwm_dutycycle(connection pi, gpio_pin pin, int dutycycle)" + ], + "python": [ + "def remote_raspi_set_pwm_dutycycle(pi, pin, dutycycle):" ], "csharp": [ - "public static ServoDevice SplashKit.OpenServo(string name, GpioPin controlPin);", - "public ServoDevice(string name, GpioPin controlPin);" + "public static void SplashKit.RemoteRaspiSetPwmDutycycle(Connection pi, GpioPin pin, int dutycycle);" ], "pascal": [ - "function OpenServo(const name: String; controlPin: GpioPin): ServoDevice" + "procedure RemoteRaspiSetPwmDutycycle(pi: Connection; pin: GpioPin; dutycycle: Integer)" ] } }, { - "signature": "servo_device servo_named(const string &name);", - "name": "servo_named", + "signature": "void remote_raspi_set_pwm_frequency(connection pi,gpio_pin pin,int frequency);", + "name": "remote_raspi_set_pwm_frequency", "method_name": null, - "unique_global_name": "servo_named", + "unique_global_name": "remote_raspi_set_pwm_frequency", "unique_method_name": null, "suffix_name": null, - "description": "Look up an already‐opened servo by name.", - "brief": null, + "description": "This function sets the PWM frequency for a specific pin on a remote Raspberry Pi.", + "brief": "Sets the PWM frequency for the specified pin on a remote Raspberry Pi.", "return": { - "type": "servo_device", - "description": "A valid servo_device, or nullptr if not found.", + "type": "void", + "description": null, "is_pointer": false, "is_reference": false, "is_vector": false, "type_parameter": null }, "parameters": { - "name": { - "type": "string", - "description": "Your identifier for this servo.", + "pi": { + "type": "connection", + "description": "The connection object to the remote Raspberry Pi.", "is_pointer": false, - "is_const": true, - "is_reference": true, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pin": { + "type": "gpio_pin", + "description": "The pin to set the PWM frequency for.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "frequency": { + "type": "int", + "description": "The PWM frequency to set for the pin.", + "is_pointer": false, + "is_const": false, + "is_reference": false, "is_array": false, "array_dimension_sizes": [ @@ -77487,29 +74691,29 @@ "static": "raspberry" }, "signatures": { - "python": [ - "def servo_named(name):" - ], "cpp": [ - "servo_device servo_named(const string &name)" + "void remote_raspi_set_pwm_frequency(connection pi, gpio_pin pin, int frequency)" + ], + "python": [ + "def remote_raspi_set_pwm_frequency(pi, pin, frequency):" ], "csharp": [ - "public static ServoDevice SplashKit.ServoNamed(string name);" + "public static void SplashKit.RemoteRaspiSetPwmFrequency(Connection pi, GpioPin pin, int frequency);" ], "pascal": [ - "function ServoNamed(const name: String): ServoDevice" + "procedure RemoteRaspiSetPwmFrequency(pi: Connection; pin: GpioPin; frequency: Integer)" ] } }, { - "signature": "void set_servo_angle(servo_device dev,double angle_degrees);", - "name": "set_servo_angle", - "method_name": "set_angle", - "unique_global_name": "set_servo_angle", - "unique_method_name": "servo_device.set_angle", + "signature": "void remote_raspi_set_pwm_range(connection pi,gpio_pin pin,int range);", + "name": "remote_raspi_set_pwm_range", + "method_name": null, + "unique_global_name": "remote_raspi_set_pwm_range", + "unique_method_name": null, "suffix_name": null, - "description": "Convenience: map an angle (0…180°) into the 500…2500 µs range.\nThis is a linear mapping, so it may not be accurate for all servos.", - "brief": null, + "description": "This function sets the PWM range for a specific pin on a remote Raspberry Pi.\nValid values for the range are 25 - 40000", + "brief": "Sets the PWM range for the specified pin on a remote Raspberry Pi.", "return": { "type": "void", "description": null, @@ -77519,9 +74723,9 @@ "type_parameter": null }, "parameters": { - "dev": { - "type": "servo_device", - "description": "The servo device to control.", + "pi": { + "type": "connection", + "description": "The connection object to the remote Raspberry Pi.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -77532,9 +74736,22 @@ "is_vector": false, "type_parameter": null }, - "angle_degrees": { - "type": "double", - "description": "The angle in degrees (0…180).", + "pin": { + "type": "gpio_pin", + "description": "The pin to set the PWM range for.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "range": { + "type": "int", + "description": "The PWM range to set for the pin.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -77547,37 +74764,33 @@ } }, "attributes": { - "class": "servo_device", - "method": "set_angle", - "self": "dev", "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def set_servo_angle(dev, angle_degrees):" - ], "cpp": [ - "void set_servo_angle(servo_device dev, double angle_degrees)" + "void remote_raspi_set_pwm_range(connection pi, gpio_pin pin, int range)" + ], + "python": [ + "def remote_raspi_set_pwm_range(pi, pin, range):" ], "csharp": [ - "public void ServoDevice.SetAngle(double angleDegrees);", - "public static void SplashKit.SetServoAngle(ServoDevice dev, double angleDegrees);" + "public static void SplashKit.RemoteRaspiSetPwmRange(Connection pi, GpioPin pin, int range);" ], "pascal": [ - "procedure SetServoAngle(dev: ServoDevice; angleDegrees: Double)" + "procedure RemoteRaspiSetPwmRange(pi: Connection; pin: GpioPin; range: Integer)" ] } }, { - "signature": "void stop_servo(servo_device dev);", - "name": "stop_servo", - "method_name": "stop", - "unique_global_name": "stop_servo", - "unique_method_name": "servo_device.stop", + "signature": "void remote_raspi_write(connection pi,gpio_pin pin,gpio_pin_value value);", + "name": "remote_raspi_write", + "method_name": null, + "unique_global_name": "remote_raspi_write", + "unique_method_name": null, "suffix_name": null, - "description": "Stop sending pulses (servo will hold last position or drift).\nThis is a convenience function that sets the pulse width to 0.", - "brief": null, + "description": "This function writes a specified value to a specific pin on a remote Raspberry Pi.", + "brief": "Writes a value to the specified pin on a remote Raspberry Pi.", "return": { "type": "void", "description": null, @@ -77587,9 +74800,35 @@ "type_parameter": null }, "parameters": { - "dev": { - "type": "servo_device", - "description": "The servo device to control.", + "pi": { + "type": "connection", + "description": "The connection object to the remote Raspberry Pi.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "pin": { + "type": "gpio_pin", + "description": "The pin to write the value to.", + "is_pointer": false, + "is_const": false, + "is_reference": false, + "is_array": false, + "array_dimension_sizes": [ + + ], + "is_vector": false, + "type_parameter": null + }, + "value": { + "type": "gpio_pin_value", + "description": "The value to write to the pin.", "is_pointer": false, "is_const": false, "is_reference": false, @@ -77602,25 +74841,21 @@ } }, "attributes": { - "class": "servo_device", - "method": "stop", - "self": "dev", "group": "raspberry", "static": "raspberry" }, "signatures": { - "python": [ - "def stop_servo(dev):" - ], "cpp": [ - "void stop_servo(servo_device dev)" + "void remote_raspi_write(connection pi, gpio_pin pin, gpio_pin_value value)" + ], + "python": [ + "def remote_raspi_write(pi, pin, value):" ], "csharp": [ - "public void ServoDevice.Stop();", - "public static void SplashKit.StopServo(ServoDevice dev);" + "public static void SplashKit.RemoteRaspiWrite(Connection pi, GpioPin pin, GpioPinValue value);" ], "pascal": [ - "procedure StopServo(dev: ServoDevice)" + "procedure RemoteRaspiWrite(pi: Connection; pin: GpioPin; value: GpioPinValue)" ] } } @@ -77629,7 +74864,7 @@ { "signature": "typedef struct _adc_data *adc_device;", "name": "adc_device", - "description": "The `adc_device` type is used to refer to ADC (Analog-to-Digital Converter)\ndevices that can be managed by the SplashKit ADC code, such as ADS7830.\nADC devices are:\n\n- loaded with `open_adc`,\n- accessed using `adc_device_named` or checked with `has_adc_device`,\n- read using `read_adc` to retrieve analog values from specific channels,\n- and must be closed using `close_adc` (to release a specific\nADC device) or `close_all_adc` (to release all loaded ADC devices).\n\nADC devices allow you to interface with external analog sensors or inputs,\nconverting their signals into digital values for processing in your application.", + "description": "The `adc_device` type is used to refer to ADC (Analog-to-Digital Converter)\ndevices that can be managed by the SplashKit ADC code. ADC devices are:\n\n- loaded with `load_adc_device`,\n\n- accessed using `adc_device_named` or checked with `has_adc_device`,\n\n- read using `read_adc_channel` to retrieve analog values from specific channels,\n\n- and must be released using `free_adc_device` (to release a specific\nADC device) or `free_all_adc_devices` (to release all loaded ADC devices).\n\nADC devices allow you to interface with external analog sensors or inputs,\nconverting their signals into digital values for processing in your application.\n\nYou can check if an ADC device is loaded using `has_adc_device`.\n\nUse `free_adc_device` to release resources associated with a specific ADC device,\nor `free_all_adc_devices` to clean up all ADC devices.", "brief": null, "attributes": { "class": "adc_device", @@ -77641,38 +74876,6 @@ "aliased_identifier": null, "is_pointer": false, "new_identifier": null - }, - { - "signature": "typedef struct _motor_data *motor_device;", - "name": "motor_device", - "description": "The `motor_device` type is used to refer to motor driver devices that can\nbe managed by the SplashKit motor driver code. Motor devices are:\n\n- checked with `has_motor_device` to see if a motor is already opened,\n\n- accessed using `motor_named` to retrieve an existing motor device by name,\n\n- opened using `open_motor` with specific parameters such as motor type and GPIO pins,\n\n- controlled using `set_motor_direction` to set the rotation direction and\n`set_motor_speed` to adjust the PWM speed,\n\n- stopped immediately using `stop_motor` for braking,\n\n- and must be released using `close_motor` (to release a specific motor device\nby handle or name) or `close_all_motors` (to release all opened motor devices).\n\nMotor devices allow you to control DC motors or similar devices using GPIO pins\nand PWM signals, enabling precise control over speed and direction.\n\nUse `close_motor` or `close_all_motors` to release resources associated with\nmotor devices when they are no longer needed.", - "brief": "Opaque handle for an L298N motor driver instance.", - "attributes": { - "class": "motor_device", - "group": "raspberry", - "static": "raspberry" - }, - "is_function_pointer": false, - "aliased_type": null, - "aliased_identifier": null, - "is_pointer": false, - "new_identifier": null - }, - { - "signature": "typedef struct _servo_data *servo_device;", - "name": "servo_device", - "description": "The `servo_device` type is used to refer to servo driver devices that can\nbe managed by the SplashKit servo driver code. Servo devices are:\nOpaque handle for a single‐pin servo device.\nServo devices are:\n- checked with `has_servo_device` to see if a servo is already opened,\n\n- accessed using `servo_named` to retrieve an existing servo device by name,\n\n- opened using `open_servo` with specific parameters such as a unique name\nand the GPIO pin for the servo signal line,\n\n- controlled using `set_servo_pulsewidth` to send raw pulse-width signals\nor `set_servo_angle` to map an angle (0–180°) into the pulse-width range,\n\n- stopped using `stop_servo` to halt signal pulses while holding the last\nposition or allowing the servo to drift,\n\n- and must be released using `close_servo` (to release a specific servo device\nby handle or name) or `close_all_servos` (to release all opened servo devices).\n\nServo devices allow you to control hobby servos or similar devices using GPIO pins\nand PWM signals, enabling precise control over position and movement.\n\nUse `close_servo` or `close_all_servos` to release resources associated with\nservo devices when they are no longer needed.", - "brief": null, - "attributes": { - "class": "servo_device", - "group": "raspberry", - "static": "raspberry" - }, - "is_function_pointer": false, - "aliased_type": null, - "aliased_identifier": null, - "is_pointer": false, - "new_identifier": null } ], "structs": [ @@ -77726,12 +74929,12 @@ "static": "resource_bundle" }, "signatures": { - "python": [ - "def free_resource_bundle(name):" - ], "cpp": [ "void free_resource_bundle(const string name)" ], + "python": [ + "def free_resource_bundle(name):" + ], "csharp": [ "public static void SplashKit.FreeResourceBundle(string name);" ], @@ -77777,12 +74980,12 @@ "static": "resource_bundle" }, "signatures": { - "python": [ - "def has_resource_bundle(name):" - ], "cpp": [ "bool has_resource_bundle(const string &name)" ], + "python": [ + "def has_resource_bundle(name):" + ], "csharp": [ "public static bool SplashKit.HasResourceBundle(string name);" ], @@ -77841,12 +75044,12 @@ "static": "resource_bundle" }, "signatures": { - "python": [ - "def load_resource_bundle(name, filename):" - ], "cpp": [ "void load_resource_bundle(const string &name, const string &filename)" ], + "python": [ + "def load_resource_bundle(name, filename):" + ], "csharp": [ "public static void SplashKit.LoadResourceBundle(string name, string filename);" ], @@ -77910,12 +75113,12 @@ "static": "resources" }, "signatures": { - "python": [ - "def deregister_free_notifier(handler):" - ], "cpp": [ "void deregister_free_notifier(free_notifier *handler)" ], + "python": [ + "def deregister_free_notifier(handler):" + ], "csharp": [ "public static void SplashKit.DeregisterFreeNotifier(FreeNotifier handler);" ], @@ -77974,12 +75177,12 @@ "static": "resources" }, "signatures": { - "python": [ - "def path_to_resource(filename, kind):" - ], "cpp": [ "string path_to_resource(const string &filename, resource_kind kind)" ], + "python": [ + "def path_to_resource(filename, kind):" + ], "csharp": [ "public static string SplashKit.PathToResource(string filename, ResourceKind kind);" ], @@ -78012,12 +75215,12 @@ "static": "resources" }, "signatures": { - "python": [ - "def path_to_resources():" - ], "cpp": [ "string path_to_resources()" ], + "python": [ + "def path_to_resources():" + ], "csharp": [ "public static string SplashKit.PathToResources();" ], @@ -78064,12 +75267,12 @@ "static": "resources" }, "signatures": { - "python": [ - "def path_to_resources_for_kind(kind):" - ], "cpp": [ "string path_to_resources(resource_kind kind)" ], + "python": [ + "def path_to_resources_for_kind(kind):" + ], "csharp": [ "public static string SplashKit.PathToResources(ResourceKind kind);" ], @@ -78115,12 +75318,12 @@ "static": "resources" }, "signatures": { - "python": [ - "def register_free_notifier(fn):" - ], "cpp": [ "void register_free_notifier(free_notifier *fn)" ], + "python": [ + "def register_free_notifier(fn):" + ], "csharp": [ "public static void SplashKit.RegisterFreeNotifier(FreeNotifier fn);" ], @@ -78166,12 +75369,12 @@ "static": "resources" }, "signatures": { - "python": [ - "def set_resources_path(path):" - ], "cpp": [ "void set_resources_path(const string &path)" ], + "python": [ + "def set_resources_path(path):" + ], "csharp": [ "public static void SplashKit.SetResourcesPath(string path);" ], @@ -78263,8 +75466,8 @@ "static": "resources" }, "signatures": { - "python": "public enum {ResourceKind.animation_resource = 0, ResourceKind.bundle_resource = 0, ResourceKind.font_resource = 0, ResourceKind.image_resource = 0, ResourceKind.json_resource = 0, ResourceKind.music_resource = 0, ResourceKind.server_resource = 0, ResourceKind.sound_resource = 0, ResourceKind.timer_resource = 0, ResourceKind.other_resource = 0}", "cpp": "class resource_kind {ANIMATION_RESOURCE = 0, BUNDLE_RESOURCE = 0, FONT_RESOURCE = 0, IMAGE_RESOURCE = 0, JSON_RESOURCE = 0, MUSIC_RESOURCE = 0, SERVER_RESOURCE = 0, SOUND_RESOURCE = 0, TIMER_RESOURCE = 0, OTHER_RESOURCE = 0};", + "python": "public enum {ResourceKind.animation_resource = 0, ResourceKind.bundle_resource = 0, ResourceKind.font_resource = 0, ResourceKind.image_resource = 0, ResourceKind.json_resource = 0, ResourceKind.music_resource = 0, ResourceKind.server_resource = 0, ResourceKind.sound_resource = 0, ResourceKind.timer_resource = 0, ResourceKind.other_resource = 0}", "csharp": "public enum {ResourceKind.AnimationResource = 0, ResourceKind.BundleResource = 0, ResourceKind.FontResource = 0, ResourceKind.ImageResource = 0, ResourceKind.JsonResource = 0, ResourceKind.MusicResource = 0, ResourceKind.ServerResource = 0, ResourceKind.SoundResource = 0, ResourceKind.TimerResource = 0, ResourceKind.OtherResource = 0}", "pascal": "public enum {ResourceKind.AnimationResource = 0, ResourceKind.BundleResource = 0, ResourceKind.FontResource = 0, ResourceKind.ImageResource = 0, ResourceKind.JsonResource = 0, ResourceKind.MusicResource = 0, ResourceKind.ServerResource = 0, ResourceKind.SoundResource = 0, ResourceKind.TimerResource = 0, ResourceKind.OtherResource = 0}" } @@ -78329,12 +75532,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def call_for_all_sprites_with_value(fn, val):" - ], "cpp": [ "void call_for_all_sprites(sprite_float_function *fn, float val)" ], + "python": [ + "def call_for_all_sprites_with_value(fn, val):" + ], "csharp": [ "public static void SplashKit.CallForAllSprites(SpriteFloatFunction fn, float val);" ], @@ -78380,12 +75583,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def call_for_all_sprites(fn):" - ], "cpp": [ "void call_for_all_sprites(sprite_function *fn)" ], + "python": [ + "def call_for_all_sprites(fn):" + ], "csharp": [ "public static void SplashKit.CallForAllSprites(SpriteFunction fn);" ], @@ -78431,12 +75634,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def call_on_sprite_event(handler):" - ], "cpp": [ "void call_on_sprite_event(sprite_event_handler *handler)" ], + "python": [ + "def call_on_sprite_event(handler):" + ], "csharp": [ "public static void SplashKit.CallOnSpriteEvent(SpriteEventHandler handler);" ], @@ -78484,12 +75687,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def create_sprite(layer):" - ], "cpp": [ "sprite create_sprite(bitmap layer)" ], + "python": [ + "def create_sprite(layer):" + ], "csharp": [ "public static Sprite SplashKit.CreateSprite(Bitmap layer);", "public Sprite(Bitmap layer);" @@ -78552,12 +75755,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def create_sprite_with_animation(layer, ani):" - ], "cpp": [ "sprite create_sprite(bitmap layer, animation_script ani)" ], + "python": [ + "def create_sprite_with_animation(layer, ani):" + ], "csharp": [ "public static Sprite SplashKit.CreateSprite(Bitmap layer, AnimationScript ani);", "public Sprite(Bitmap layer, AnimationScript ani);" @@ -78607,12 +75810,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def create_sprite_with_bitmap_named(bitmap_name):" - ], "cpp": [ "sprite create_sprite(const string &bitmap_name)" ], + "python": [ + "def create_sprite_with_bitmap_named(bitmap_name):" + ], "csharp": [ "public static Sprite SplashKit.CreateSprite(string bitmapName);", "public Sprite(string bitmapName);" @@ -78675,12 +75878,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def create_sprite_named(name, layer):" - ], "cpp": [ "sprite create_sprite(const string &name, bitmap layer)" ], + "python": [ + "def create_sprite_named(name, layer):" + ], "csharp": [ "public static Sprite SplashKit.CreateSprite(string name, Bitmap layer);", "public Sprite(string name, Bitmap layer);" @@ -78756,12 +75959,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def create_sprite_named_with_animation(name, layer, ani):" - ], "cpp": [ "sprite create_sprite(const string &name, bitmap layer, animation_script ani)" ], + "python": [ + "def create_sprite_named_with_animation(name, layer, ani):" + ], "csharp": [ "public static Sprite SplashKit.CreateSprite(string name, Bitmap layer, AnimationScript ani);", "public Sprite(string name, Bitmap layer, AnimationScript ani);" @@ -78824,12 +76027,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def create_sprite_with_bitmap_and_animation_named(bitmap_name, animation_name):" - ], "cpp": [ "sprite create_sprite(const string &bitmap_name, const string &animation_name)" ], + "python": [ + "def create_sprite_with_bitmap_and_animation_named(bitmap_name, animation_name):" + ], "csharp": [ "public static Sprite SplashKit.CreateSprite(string bitmapName, string animationName);", "public Sprite(string bitmapName, string animationName);" @@ -78876,12 +76079,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def create_sprite_pack(name):" - ], "cpp": [ "void create_sprite_pack(const string &name)" ], + "python": [ + "def create_sprite_pack(name):" + ], "csharp": [ "public static void SplashKit.CreateSpritePack(string name);" ], @@ -78914,12 +76117,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def current_sprite_pack():" - ], "cpp": [ "string current_sprite_pack()" ], + "python": [ + "def current_sprite_pack():" + ], "csharp": [ "public static string SplashKit.CurrentSpritePack();" ], @@ -78952,12 +76155,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def draw_all_sprites():" - ], "cpp": [ "void draw_all_sprites()" ], + "python": [ + "def draw_all_sprites():" + ], "csharp": [ "public static void SplashKit.DrawAllSprites();" ], @@ -79020,12 +76223,12 @@ "self": "s" }, "signatures": { - "python": [ - "def draw_sprite_offset_by(s, offset):" - ], "cpp": [ "void draw_sprite(sprite s, const vector_2d &offset)" ], + "python": [ + "def draw_sprite_offset_by(s, offset):" + ], "csharp": [ "public void Sprite.Draw(Vector2D offset);", "public static void SplashKit.DrawSprite(Sprite s, Vector2D offset);" @@ -79075,12 +76278,12 @@ "self": "s" }, "signatures": { - "python": [ - "def draw_sprite(s):" - ], "cpp": [ "void draw_sprite(sprite s)" ], + "python": [ + "def draw_sprite(s):" + ], "csharp": [ "public void Sprite.Draw();", "public static void SplashKit.DrawSprite(Sprite s);" @@ -79157,12 +76360,12 @@ "self": "s" }, "signatures": { - "python": [ - "def draw_sprite_offset_x_y(s, x_offset, y_offset):" - ], "cpp": [ "void draw_sprite(sprite s, double x_offset, double y_offset)" ], + "python": [ + "def draw_sprite_offset_x_y(s, x_offset, y_offset):" + ], "csharp": [ "public void Sprite.Draw(double xOffset, double yOffset);", "public static void SplashKit.DrawSprite(Sprite s, double xOffset, double yOffset);" @@ -79196,12 +76399,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def free_all_sprites():" - ], "cpp": [ "void free_all_sprites()" ], + "python": [ + "def free_all_sprites():" + ], "csharp": [ "public static void SplashKit.FreeAllSprites();" ], @@ -79250,12 +76453,12 @@ "self": "s" }, "signatures": { - "python": [ - "def free_sprite(s):" - ], "cpp": [ "void free_sprite(sprite s)" ], + "python": [ + "def free_sprite(s):" + ], "csharp": [ "public static void SplashKit.FreeSprite(Sprite s);" ], @@ -79301,12 +76504,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def free_sprite_pack(name):" - ], "cpp": [ "void free_sprite_pack(const string &name)" ], + "python": [ + "def free_sprite_pack(name):" + ], "csharp": [ "public static void SplashKit.FreeSpritePack(string name);" ], @@ -79352,12 +76555,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def has_sprite(name):" - ], "cpp": [ "bool has_sprite(const string &name)" ], + "python": [ + "def has_sprite(name):" + ], "csharp": [ "public static bool SplashKit.HasSprite(string name);" ], @@ -79403,12 +76606,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def has_sprite_pack(name):" - ], "cpp": [ "bool has_sprite_pack(const string &name)" ], + "python": [ + "def has_sprite_pack(name):" + ], "csharp": [ "public static bool SplashKit.HasSpritePack(string name);" ], @@ -79457,12 +76660,12 @@ "self": "s" }, "signatures": { - "python": [ - "def move_sprite(s):" - ], "cpp": [ "void move_sprite(sprite s)" ], + "python": [ + "def move_sprite(s):" + ], "csharp": [ "public void Sprite.Move();", "public static void SplashKit.MoveSprite(Sprite s);" @@ -79526,12 +76729,12 @@ "self": "s" }, "signatures": { - "python": [ - "def move_sprite_by_vector(s, distance):" - ], "cpp": [ "void move_sprite(sprite s, const vector_2d &distance)" ], + "python": [ + "def move_sprite_by_vector(s, distance):" + ], "csharp": [ "public void Sprite.Move(Vector2D distance);", "public static void SplashKit.MoveSprite(Sprite s, Vector2D distance);" @@ -79608,12 +76811,12 @@ "self": "s" }, "signatures": { - "python": [ - "def move_sprite_by_vector_percent(s, distance, pct):" - ], "cpp": [ "void move_sprite(sprite s, const vector_2d &distance, float pct)" ], + "python": [ + "def move_sprite_by_vector_percent(s, distance, pct):" + ], "csharp": [ "public void Sprite.Move(Vector2D distance, float pct);", "public static void SplashKit.MoveSprite(Sprite s, Vector2D distance, float pct);" @@ -79677,12 +76880,12 @@ "self": "s" }, "signatures": { - "python": [ - "def move_sprite_percent(s, pct):" - ], "cpp": [ "void move_sprite(sprite s, float pct)" ], + "python": [ + "def move_sprite_percent(s, pct):" + ], "csharp": [ "public void Sprite.Move(float pct);", "public static void SplashKit.MoveSprite(Sprite s, float pct);" @@ -79758,12 +76961,12 @@ "self": "s" }, "signatures": { - "python": [ - "def move_sprite_to(s, x, y):" - ], "cpp": [ "void move_sprite_to(sprite s, double x, double y)" ], + "python": [ + "def move_sprite_to(s, x, y):" + ], "csharp": [ "public void Sprite.MoveTo(double x, double y);", "public static void SplashKit.MoveSpriteTo(Sprite s, double x, double y);" @@ -79810,12 +77013,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def select_sprite_pack(name):" - ], "cpp": [ "void select_sprite_pack(const string &name)" ], + "python": [ + "def select_sprite_pack(name):" + ], "csharp": [ "public static void SplashKit.SelectSpritePack(string name);" ], @@ -79890,12 +77093,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def sprite_add_layer(s, new_layer, layer_name):" - ], "cpp": [ "int sprite_add_layer(sprite s, bitmap new_layer, const string &layer_name)" ], + "python": [ + "def sprite_add_layer(s, new_layer, layer_name):" + ], "csharp": [ "public int Sprite.AddLayer(Bitmap newLayer, string layerName);", "public static int SplashKit.SpriteAddLayer(Sprite s, Bitmap newLayer, string layerName);" @@ -79958,12 +77161,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_add_to_velocity(s, value):" - ], "cpp": [ "void sprite_add_to_velocity(sprite s, const vector_2d &value)" ], + "python": [ + "def sprite_add_to_velocity(s, value):" + ], "csharp": [ "public void Sprite.AddToVelocity(Vector2D value);", "public static void SplashKit.SpriteAddToVelocity(Sprite s, Vector2D value);" @@ -80026,12 +77229,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_add_value(s, name):" - ], "cpp": [ "void sprite_add_value(sprite s, const string &name)" ], + "python": [ + "def sprite_add_value(s, name):" + ], "csharp": [ "public void Sprite.AddValue(string name);", "public static void SplashKit.SpriteAddValue(Sprite s, string name);" @@ -80108,12 +77311,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_add_value_with_default(s, name, init_val):" - ], "cpp": [ "void sprite_add_value(sprite s, const string &name, float init_val)" ], + "python": [ + "def sprite_add_value_with_default(s, name, init_val):" + ], "csharp": [ "public void Sprite.AddValue(string name, float initVal);", "public static void SplashKit.SpriteAddValue(Sprite s, string name, float initVal);" @@ -80163,12 +77366,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_anchor_point(s):" - ], "cpp": [ "point_2d sprite_anchor_point(sprite s)" ], + "python": [ + "def sprite_anchor_point(s):" + ], "csharp": [ "public Point2D Sprite.AnchorPoint { get }", "public static Point2D SplashKit.SpriteAnchorPoint(Sprite s);" @@ -80215,12 +77418,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def sprite_anchor_position(s):" - ], "cpp": [ "point_2d sprite_anchor_position(sprite s)" ], + "python": [ + "def sprite_anchor_position(s):" + ], "csharp": [ "public static Point2D SplashKit.SpriteAnchorPosition(Sprite s);" ], @@ -80269,12 +77472,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_animation_has_ended(s):" - ], "cpp": [ "bool sprite_animation_has_ended(sprite s)" ], + "python": [ + "def sprite_animation_has_ended(s):" + ], "csharp": [ "public bool Sprite.AnimationHasEnded { get }", "public static bool SplashKit.SpriteAnimationHasEnded(Sprite s);" @@ -80324,12 +77527,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_animation_name(s):" - ], "cpp": [ "string sprite_animation_name(sprite s)" ], + "python": [ + "def sprite_animation_name(s):" + ], "csharp": [ "public string Sprite.AnimationName();", "public static string SplashKit.SpriteAnimationName(Sprite s);" @@ -80389,12 +77592,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def sprite_at(s, pt):" - ], "cpp": [ "bool sprite_at(sprite s, const point_2d &pt)" ], + "python": [ + "def sprite_at(s, pt):" + ], "csharp": [ "public static bool SplashKit.SpriteAt(Sprite s, Point2D pt);" ], @@ -80456,12 +77659,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_bring_layer_forward(s, visible_layer):" - ], "cpp": [ "void sprite_bring_layer_forward(sprite s, int visible_layer)" ], + "python": [ + "def sprite_bring_layer_forward(s, visible_layer):" + ], "csharp": [ "public void Sprite.SendLayerForward(int visibleLayer);", "public static void SplashKit.SpriteBringLayerForward(Sprite s, int visibleLayer);" @@ -80524,12 +77727,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_bring_layer_to_front(s, visible_layer):" - ], "cpp": [ "void sprite_bring_layer_to_front(sprite s, int visible_layer)" ], + "python": [ + "def sprite_bring_layer_to_front(s, visible_layer):" + ], "csharp": [ "public void Sprite.SendLayerTofront(int visibleLayer);", "public static void SplashKit.SpriteBringLayerToFront(Sprite s, int visibleLayer);" @@ -80592,12 +77795,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def sprite_call_on_event(s, handler):" - ], "cpp": [ "void sprite_call_on_event(sprite s, sprite_event_handler *handler)" ], + "python": [ + "def sprite_call_on_event(s, handler):" + ], "csharp": [ "public void Sprite.CallOnEvent(SpriteEventHandler handler);", "public static void SplashKit.SpriteCallOnEvent(Sprite s, SpriteEventHandler handler);" @@ -80647,12 +77850,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_center_point(s):" - ], "cpp": [ "point_2d sprite_center_point(sprite s)" ], + "python": [ + "def sprite_center_point(s):" + ], "csharp": [ "public Point2D Sprite.SpriteCenterPoint { get }", "public static Point2D SplashKit.SpriteCenterPoint(Sprite s);" @@ -80702,12 +77905,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_circle(s):" - ], "cpp": [ "circle sprite_circle(sprite s)" ], + "python": [ + "def sprite_circle(s):" + ], "csharp": [ "public Circle Sprite.Circle();", "public static Circle SplashKit.SpriteCircle(Sprite s);" @@ -80757,12 +77960,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_collision_bitmap(s):" - ], "cpp": [ "bitmap sprite_collision_bitmap(sprite s)" ], + "python": [ + "def sprite_collision_bitmap(s):" + ], "csharp": [ "public Bitmap Sprite.CollisionBitmap { get }", "public static Bitmap SplashKit.SpriteCollisionBitmap(Sprite s);" @@ -80812,12 +78015,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_collision_circle(s):" - ], "cpp": [ "circle sprite_collision_circle(sprite s)" ], + "python": [ + "def sprite_collision_circle(s):" + ], "csharp": [ "public Circle Sprite.CollisionCircle();", "public static Circle SplashKit.SpriteCollisionCircle(Sprite s);" @@ -80867,12 +78070,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_collision_kind(s):" - ], "cpp": [ "collision_test_kind sprite_collision_kind(sprite s)" ], + "python": [ + "def sprite_collision_kind(s):" + ], "csharp": [ "public CollisionTestKind Sprite.CollisionKind { get }", "public static CollisionTestKind SplashKit.SpriteCollisionKind(Sprite s);" @@ -80922,12 +78125,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_collision_rectangle(s):" - ], "cpp": [ "rectangle sprite_collision_rectangle(sprite s)" ], + "python": [ + "def sprite_collision_rectangle(s):" + ], "csharp": [ "public Rectangle Sprite.CollisionRectangle { get }", "public static Rectangle SplashKit.SpriteCollisionRectangle(Sprite s);" @@ -80977,12 +78180,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_current_cell(s):" - ], "cpp": [ "int sprite_current_cell(sprite s)" ], + "python": [ + "def sprite_current_cell(s):" + ], "csharp": [ "public int Sprite.CurrentCell { get }", "public static int SplashKit.SpriteCurrentCell(Sprite s);" @@ -81032,12 +78235,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_current_cell_rectangle(s):" - ], "cpp": [ "rectangle sprite_current_cell_rectangle(sprite s)" ], + "python": [ + "def sprite_current_cell_rectangle(s):" + ], "csharp": [ "public Rectangle Sprite.CurrentCellRectangle { get }", "public static Rectangle SplashKit.SpriteCurrentCellRectangle(Sprite s);" @@ -81087,12 +78290,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_dx(s):" - ], "cpp": [ "double sprite_dx(sprite s)" ], + "python": [ + "def sprite_dx(s):" + ], "csharp": [ "public double Sprite.Dx { get }", "public static double SplashKit.SpriteDx(Sprite s);" @@ -81142,12 +78345,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_dy(s):" - ], "cpp": [ "double sprite_dy(sprite s)" ], + "python": [ + "def sprite_dy(s):" + ], "csharp": [ "public double Sprite.Dy { get }", "public static double SplashKit.SpriteDy(Sprite s);" @@ -81207,12 +78410,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def sprite_has_value(s, name):" - ], "cpp": [ "bool sprite_has_value(sprite s, string name)" ], + "python": [ + "def sprite_has_value(s, name):" + ], "csharp": [ "public static bool SplashKit.SpriteHasValue(Sprite s, string name);" ], @@ -81261,12 +78464,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_heading(s):" - ], "cpp": [ "float sprite_heading(sprite s)" ], + "python": [ + "def sprite_heading(s):" + ], "csharp": [ "public float Sprite.Heading { get }", "public static float SplashKit.SpriteHeading(Sprite s);" @@ -81316,12 +78519,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_height(s):" - ], "cpp": [ "int sprite_height(sprite s)" ], + "python": [ + "def sprite_height(s):" + ], "csharp": [ "public int Sprite.Height { get }", "public static int SplashKit.SpriteHeight(Sprite s);" @@ -81385,12 +78588,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_hide_layer_named(s, name):" - ], "cpp": [ "void sprite_hide_layer(sprite s, const string &name)" ], + "python": [ + "def sprite_hide_layer_named(s, name):" + ], "csharp": [ "public void Sprite.HideLayer(string name);", "public static void SplashKit.SpriteHideLayer(Sprite s, string name);" @@ -81453,12 +78656,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_hide_layer(s, id):" - ], "cpp": [ "void sprite_hide_layer(sprite s, int id)" ], + "python": [ + "def sprite_hide_layer(s, id):" + ], "csharp": [ "public void Sprite.HideLayer(int id);", "public static void SplashKit.SpriteHideLayer(Sprite s, int id);" @@ -81522,12 +78725,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_named(s, name):" - ], "cpp": [ "bitmap sprite_layer(sprite s, const string &name)" ], + "python": [ + "def sprite_layer_named(s, name):" + ], "csharp": [ "public Bitmap Sprite.Layer(string name);", "public static Bitmap SplashKit.SpriteLayer(Sprite s, string name);" @@ -81591,12 +78794,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_at_index(s, idx):" - ], "cpp": [ "bitmap sprite_layer(sprite s, int idx)" ], + "python": [ + "def sprite_layer_at_index(s, idx):" + ], "csharp": [ "public Bitmap Sprite.Layer(int idx);", "public static Bitmap SplashKit.SpriteLayer(Sprite s, int idx);" @@ -81660,12 +78863,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_circle_named(s, name):" - ], "cpp": [ "circle sprite_layer_circle(sprite s, const string &name)" ], + "python": [ + "def sprite_layer_circle_named(s, name):" + ], "csharp": [ "public Circle Sprite.LayerCircle(string name);", "public static Circle SplashKit.SpriteLayerCircle(Sprite s, string name);" @@ -81729,12 +78932,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_circle_at_index(s, idx):" - ], "cpp": [ "circle sprite_layer_circle(sprite s, int idx)" ], + "python": [ + "def sprite_layer_circle_at_index(s, idx):" + ], "csharp": [ "public Circle Sprite.LayerCircle(int idx);", "public static Circle SplashKit.SpriteLayerCircle(Sprite s, int idx);" @@ -81784,12 +78987,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_count(s):" - ], "cpp": [ "int sprite_layer_count(sprite s)" ], + "python": [ + "def sprite_layer_count(s):" + ], "csharp": [ "public int Sprite.LayerCount { get }", "public static int SplashKit.SpriteLayerCount(Sprite s);" @@ -81853,12 +79056,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_height_named(s, name):" - ], "cpp": [ "int sprite_layer_height(sprite s, const string &name)" ], + "python": [ + "def sprite_layer_height_named(s, name):" + ], "csharp": [ "public int Sprite.LayerHeight(string name);", "public static int SplashKit.SpriteLayerHeight(Sprite s, string name);" @@ -81921,12 +79124,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_height(s, idx):" - ], "cpp": [ "int sprite_layer_height(sprite s, int idx)" ], + "python": [ + "def sprite_layer_height(s, idx):" + ], "csharp": [ "public int Sprite.LayerHeight(int idx);", "public static int SplashKit.SpriteLayerHeight(Sprite s, int idx);" @@ -81989,12 +79192,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_index(s, name):" - ], "cpp": [ "int sprite_layer_index(sprite s, const string &name)" ], + "python": [ + "def sprite_layer_index(s, name):" + ], "csharp": [ "public int Sprite.IndexOfLayer(string name);", "public static int SplashKit.SpriteLayerIndex(Sprite s, string name);" @@ -82057,12 +79260,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_name(s, idx):" - ], "cpp": [ "string sprite_layer_name(sprite s, int idx)" ], + "python": [ + "def sprite_layer_name(s, idx):" + ], "csharp": [ "public string Sprite.LayerName(int idx);", "public static string SplashKit.SpriteLayerName(Sprite s, int idx);" @@ -82126,12 +79329,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_offset_named(s, name):" - ], "cpp": [ "vector_2d sprite_layer_offset(sprite s, const string &name)" ], + "python": [ + "def sprite_layer_offset_named(s, name):" + ], "csharp": [ "public Vector2D Sprite.LayerOffset(string name);", "public static Vector2D SplashKit.SpriteLayerOffset(Sprite s, string name);" @@ -82194,12 +79397,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_offset(s, idx):" - ], "cpp": [ "vector_2d sprite_layer_offset(sprite s, int idx)" ], + "python": [ + "def sprite_layer_offset(s, idx):" + ], "csharp": [ "public Vector2D Sprite.LayerOffset(int idx);", "public static Vector2D SplashKit.SpriteLayerOffset(Sprite s, int idx);" @@ -82263,12 +79466,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_rectangle_named(s, name):" - ], "cpp": [ "rectangle sprite_layer_rectangle(sprite s, const string &name)" ], + "python": [ + "def sprite_layer_rectangle_named(s, name):" + ], "csharp": [ "public Rectangle Sprite.LayerRectangle(string name);", "public static Rectangle SplashKit.SpriteLayerRectangle(Sprite s, string name);" @@ -82332,12 +79535,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_rectangle_at_index(s, idx):" - ], "cpp": [ "rectangle sprite_layer_rectangle(sprite s, int idx)" ], + "python": [ + "def sprite_layer_rectangle_at_index(s, idx):" + ], "csharp": [ "public Rectangle Sprite.LayerRectangle(int idx);", "public static Rectangle SplashKit.SpriteLayerRectangle(Sprite s, int idx);" @@ -82401,12 +79604,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_width_named(s, name):" - ], "cpp": [ "int sprite_layer_width(sprite s, const string &name)" ], + "python": [ + "def sprite_layer_width_named(s, name):" + ], "csharp": [ "public int Sprite.LayerWidth(string name);", "public static int SplashKit.SpriteLayerWidth(Sprite s, string name);" @@ -82469,12 +79672,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_layer_width(s, idx):" - ], "cpp": [ "int sprite_layer_width(sprite s, int idx)" ], + "python": [ + "def sprite_layer_width(s, idx):" + ], "csharp": [ "public int Sprite.LayerWidth(int idx);", "public static int SplashKit.SpriteLayerWidth(Sprite s, int idx);" @@ -82524,12 +79727,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_location_matrix(s):" - ], "cpp": [ "matrix_2d sprite_location_matrix(sprite s)" ], + "python": [ + "def sprite_location_matrix(s):" + ], "csharp": [ "public Matrix2D Sprite.LocationMatrix { get }", "public static Matrix2D SplashKit.SpriteLocationMatrix(Sprite s);" @@ -82579,12 +79782,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_mass(s):" - ], "cpp": [ "float sprite_mass(sprite s)" ], + "python": [ + "def sprite_mass(s):" + ], "csharp": [ "public float Sprite.Mass { get }", "public static float SplashKit.SpriteMass(Sprite s);" @@ -82634,12 +79837,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_move_from_anchor_point(s):" - ], "cpp": [ "bool sprite_move_from_anchor_point(sprite s)" ], + "python": [ + "def sprite_move_from_anchor_point(s):" + ], "csharp": [ "public bool Sprite.MoveFromAnchorPoint { get }", "public static bool SplashKit.SpriteMoveFromAnchorPoint(Sprite s);" @@ -82716,12 +79919,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_move_to_taking_seconds(s, pt, taking_seconds):" - ], "cpp": [ "void sprite_move_to(sprite s, const point_2d &pt, float taking_seconds)" ], + "python": [ + "def sprite_move_to_taking_seconds(s, pt, taking_seconds):" + ], "csharp": [ "public void Sprite.MoveTo(Point2D pt, float takingSeconds);", "public static void SplashKit.SpriteMoveTo(Sprite s, Point2D pt, float takingSeconds);" @@ -82771,12 +79974,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_name(s):" - ], "cpp": [ "string sprite_name(sprite s)" ], + "python": [ + "def sprite_name(s):" + ], "csharp": [ "public string Sprite.Name { get }", "public static string SplashKit.SpriteName(Sprite s);" @@ -82823,12 +80026,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def sprite_named(name):" - ], "cpp": [ "sprite sprite_named(const string &name)" ], + "python": [ + "def sprite_named(name):" + ], "csharp": [ "public static Sprite SplashKit.SpriteNamed(string name);" ], @@ -82877,12 +80080,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_offscreen(s):" - ], "cpp": [ "bool sprite_offscreen(sprite s)" ], + "python": [ + "def sprite_offscreen(s):" + ], "csharp": [ "public bool Sprite.Offscreen();", "public static bool SplashKit.SpriteOffscreen(Sprite s);" @@ -82946,12 +80149,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_on_screen_at_point(s, pt):" - ], "cpp": [ "bool sprite_on_screen_at(sprite s, const point_2d &pt)" ], + "python": [ + "def sprite_on_screen_at_point(s, pt):" + ], "csharp": [ "public bool Sprite.OnScreenAt(Point2D pt);", "public static bool SplashKit.SpriteOnScreenAt(Sprite s, Point2D pt);" @@ -83027,12 +80230,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_on_screen_at(s, x, y):" - ], "cpp": [ "bool sprite_on_screen_at(sprite s, double x, double y)" ], + "python": [ + "def sprite_on_screen_at(s, x, y):" + ], "csharp": [ "public bool Sprite.OnScreenAt(double x, double y);", "public static bool SplashKit.SpriteOnScreenAt(Sprite s, double x, double y);" @@ -83082,12 +80285,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_position(s):" - ], "cpp": [ "point_2d sprite_position(sprite s)" ], + "python": [ + "def sprite_position(s):" + ], "csharp": [ "public Point2D Sprite.Position { get }", "public static Point2D SplashKit.SpritePosition(Sprite s);" @@ -83137,12 +80340,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_replay_animation(s):" - ], "cpp": [ "void sprite_replay_animation(sprite s)" ], + "python": [ + "def sprite_replay_animation(s):" + ], "csharp": [ "public void Sprite.ReplayAnimation();", "public static void SplashKit.SpriteReplayAnimation(Sprite s);" @@ -83206,12 +80409,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_replay_animation_with_sound(s, with_sound):" - ], "cpp": [ "void sprite_replay_animation(sprite s, bool with_sound)" ], + "python": [ + "def sprite_replay_animation_with_sound(s, with_sound):" + ], "csharp": [ "public void Sprite.ReplayAnimation(bool withSound);", "public static void SplashKit.SpriteReplayAnimation(Sprite s, bool withSound);" @@ -83261,12 +80464,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_rotation(s):" - ], "cpp": [ "float sprite_rotation(sprite s)" ], + "python": [ + "def sprite_rotation(s):" + ], "csharp": [ "public float Sprite.Rotation { get }", "public static float SplashKit.SpriteRotation(Sprite s);" @@ -83316,12 +80519,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_scale(s):" - ], "cpp": [ "float sprite_scale(sprite s)" ], + "python": [ + "def sprite_scale(s):" + ], "csharp": [ "public float Sprite.Scale { get }", "public static float SplashKit.SpriteScale(Sprite s);" @@ -83371,12 +80574,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_screen_rectangle(s):" - ], "cpp": [ "rectangle sprite_screen_rectangle(sprite s)" ], + "python": [ + "def sprite_screen_rectangle(s):" + ], "csharp": [ "public Rectangle Sprite.ScreenRectangle { get }", "public static Rectangle SplashKit.SpriteScreenRectangle(Sprite s);" @@ -83439,12 +80642,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_send_layer_backward(s, visible_layer):" - ], "cpp": [ "void sprite_send_layer_backward(sprite s, int visible_layer)" ], + "python": [ + "def sprite_send_layer_backward(s, visible_layer):" + ], "csharp": [ "public void Sprite.SendLayerTobackward(int visibleLayer);", "public static void SplashKit.SpriteSendLayerBackward(Sprite s, int visibleLayer);" @@ -83507,12 +80710,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_send_layer_to_back(s, visible_layer):" - ], "cpp": [ "void sprite_send_layer_to_back(sprite s, int visible_layer)" ], + "python": [ + "def sprite_send_layer_to_back(s, visible_layer):" + ], "csharp": [ "public void Sprite.SendLayerToBack(int visibleLayer);", "public static void SplashKit.SpriteSendLayerToBack(Sprite s, int visibleLayer);" @@ -83575,12 +80778,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_anchor_point(s, pt):" - ], "cpp": [ "void sprite_set_anchor_point(sprite s, const point_2d &pt)" ], + "python": [ + "def sprite_set_anchor_point(s, pt):" + ], "csharp": [ "public void Sprite.AnchorPoint { set }", "public static void SplashKit.SpriteSetAnchorPoint(Sprite s, Point2D pt);" @@ -83643,12 +80846,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_collision_bitmap(s, bmp):" - ], "cpp": [ "void sprite_set_collision_bitmap(sprite s, bitmap bmp)" ], + "python": [ + "def sprite_set_collision_bitmap(s, bmp):" + ], "csharp": [ "public void Sprite.CollisionBitmap { set }", "public static void SplashKit.SpriteSetCollisionBitmap(Sprite s, Bitmap bmp);" @@ -83711,12 +80914,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_collision_kind(s, value):" - ], "cpp": [ "void sprite_set_collision_kind(sprite s, collision_test_kind value)" ], + "python": [ + "def sprite_set_collision_kind(s, value):" + ], "csharp": [ "public void Sprite.CollisionKind { set }", "public static void SplashKit.SpriteSetCollisionKind(Sprite s, CollisionTestKind value);" @@ -83779,12 +80982,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_dx(s, value):" - ], "cpp": [ "void sprite_set_dx(sprite s, double value)" ], + "python": [ + "def sprite_set_dx(s, value):" + ], "csharp": [ "public void Sprite.Dx { set }", "public static void SplashKit.SpriteSetDx(Sprite s, double value);" @@ -83847,12 +81050,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_dy(s, value):" - ], "cpp": [ "void sprite_set_dy(sprite s, double value)" ], + "python": [ + "def sprite_set_dy(s, value):" + ], "csharp": [ "public void Sprite.Dy { set }", "public static void SplashKit.SpriteSetDy(Sprite s, double value);" @@ -83915,12 +81118,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_heading(s, value):" - ], "cpp": [ "void sprite_set_heading(sprite s, float value)" ], + "python": [ + "def sprite_set_heading(s, value):" + ], "csharp": [ "public void Sprite.Heading { set }", "public static void SplashKit.SpriteSetHeading(Sprite s, float value);" @@ -83997,12 +81200,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_layer_offset_named(s, name, value):" - ], "cpp": [ "void sprite_set_layer_offset(sprite s, const string &name, const vector_2d &value)" ], + "python": [ + "def sprite_set_layer_offset_named(s, name, value):" + ], "csharp": [ "public void Sprite.SetLayerOffset(string name, Vector2D value);", "public static void SplashKit.SpriteSetLayerOffset(Sprite s, string name, Vector2D value);" @@ -84079,12 +81282,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_layer_offset_at_index(s, idx, value):" - ], "cpp": [ "void sprite_set_layer_offset(sprite s, int idx, const vector_2d &value)" ], + "python": [ + "def sprite_set_layer_offset_at_index(s, idx, value):" + ], "csharp": [ "public void Sprite.SetLayerOffset(int idx, Vector2D value);", "public static void SplashKit.SpriteSetLayerOffset(Sprite s, int idx, Vector2D value);" @@ -84147,12 +81350,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_mass(s, value):" - ], "cpp": [ "void sprite_set_mass(sprite s, float value)" ], + "python": [ + "def sprite_set_mass(s, value):" + ], "csharp": [ "public void Sprite.Mass { set }", "public static void SplashKit.SpriteSetMass(Sprite s, float value);" @@ -84215,12 +81418,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_move_from_anchor_point(s, value):" - ], "cpp": [ "void sprite_set_move_from_anchor_point(sprite s, bool value)" ], + "python": [ + "def sprite_set_move_from_anchor_point(s, value):" + ], "csharp": [ "public void Sprite.MoveFromAnchorPoint { set }", "public static void SplashKit.SpriteSetMoveFromAnchorPoint(Sprite s, bool value);" @@ -84283,12 +81486,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_position(s, value):" - ], "cpp": [ "void sprite_set_position(sprite s, const point_2d &value)" ], + "python": [ + "def sprite_set_position(s, value):" + ], "csharp": [ "public void Sprite.Position { set }", "public static void SplashKit.SpriteSetPosition(Sprite s, Point2D value);" @@ -84351,12 +81554,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_rotation(s, value):" - ], "cpp": [ "void sprite_set_rotation(sprite s, float value)" ], + "python": [ + "def sprite_set_rotation(s, value):" + ], "csharp": [ "public void Sprite.Rotation { set }", "public static void SplashKit.SpriteSetRotation(Sprite s, float value);" @@ -84419,12 +81622,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_scale(s, value):" - ], "cpp": [ "void sprite_set_scale(sprite s, float value)" ], + "python": [ + "def sprite_set_scale(s, value):" + ], "csharp": [ "public void Sprite.Scale { set }", "public static void SplashKit.SpriteSetScale(Sprite s, float value);" @@ -84487,12 +81690,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_speed(s, value):" - ], "cpp": [ "void sprite_set_speed(sprite s, double value)" ], + "python": [ + "def sprite_set_speed(s, value):" + ], "csharp": [ "public void Sprite.Speed { set }", "public static void SplashKit.SpriteSetSpeed(Sprite s, double value);" @@ -84569,12 +81772,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_value_named(s, name, val):" - ], "cpp": [ "void sprite_set_value(sprite s, const string &name, float val)" ], + "python": [ + "def sprite_set_value_named(s, name, val):" + ], "csharp": [ "public void Sprite.SetValue(string name, float val);", "public static void SplashKit.SpriteSetValue(Sprite s, string name, float val);" @@ -84637,12 +81840,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_velocity(s, value):" - ], "cpp": [ "void sprite_set_velocity(sprite s, const vector_2d &value)" ], + "python": [ + "def sprite_set_velocity(s, value):" + ], "csharp": [ "public void Sprite.Velocity { set }", "public static void SplashKit.SpriteSetVelocity(Sprite s, Vector2D value);" @@ -84705,12 +81908,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_x(s, value):" - ], "cpp": [ "void sprite_set_x(sprite s, double value)" ], + "python": [ + "def sprite_set_x(s, value):" + ], "csharp": [ "public void Sprite.X { set }", "public static void SplashKit.SpriteSetX(Sprite s, double value);" @@ -84773,12 +81976,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_set_y(s, value):" - ], "cpp": [ "void sprite_set_y(sprite s, double value)" ], + "python": [ + "def sprite_set_y(s, value):" + ], "csharp": [ "public void Sprite.Y { set }", "public static void SplashKit.SpriteSetY(Sprite s, double value);" @@ -84842,12 +82045,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_show_layer_named(s, name):" - ], "cpp": [ "int sprite_show_layer(sprite s, const string &name)" ], + "python": [ + "def sprite_show_layer_named(s, name):" + ], "csharp": [ "public int Sprite.ShowLayer(string name);", "public static int SplashKit.SpriteShowLayer(Sprite s, string name);" @@ -84910,12 +82113,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_show_layer(s, id):" - ], "cpp": [ "int sprite_show_layer(sprite s, int id)" ], + "python": [ + "def sprite_show_layer(s, id):" + ], "csharp": [ "public int Sprite.ShowLayer(int id);", "public static int SplashKit.SpriteShowLayer(Sprite s, int id);" @@ -84965,12 +82168,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_speed(s):" - ], "cpp": [ "double sprite_speed(sprite s)" ], + "python": [ + "def sprite_speed(s):" + ], "csharp": [ "public double Sprite.Speed { get }", "public static double SplashKit.SpriteSpeed(Sprite s);" @@ -85034,12 +82237,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_start_animation_named(s, named):" - ], "cpp": [ "void sprite_start_animation(sprite s, const string &named)" ], + "python": [ + "def sprite_start_animation_named(s, named):" + ], "csharp": [ "public void Sprite.StartAnimation(string named);", "public static void SplashKit.SpriteStartAnimation(Sprite s, string named);" @@ -85116,12 +82319,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_start_animation_named_with_sound(s, named, with_sound):" - ], "cpp": [ "void sprite_start_animation(sprite s, const string &named, bool with_sound)" ], + "python": [ + "def sprite_start_animation_named_with_sound(s, named, with_sound):" + ], "csharp": [ "public void Sprite.StartAnimation(string named, bool withSound);", "public static void SplashKit.SpriteStartAnimation(Sprite s, string named, bool withSound);" @@ -85184,12 +82387,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_start_animation(s, idx):" - ], "cpp": [ "void sprite_start_animation(sprite s, int idx)" ], + "python": [ + "def sprite_start_animation(s, idx):" + ], "csharp": [ "public void Sprite.StartAnimation(int idx);", "public static void SplashKit.SpriteStartAnimation(Sprite s, int idx);" @@ -85266,12 +82469,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_start_animation_with_sound(s, idx, with_sound):" - ], "cpp": [ "void sprite_start_animation(sprite s, int idx, bool with_sound)" ], + "python": [ + "def sprite_start_animation_with_sound(s, idx, with_sound):" + ], "csharp": [ "public void Sprite.StartAnimation(int idx, bool withSound);", "public static void SplashKit.SpriteStartAnimation(Sprite s, int idx, bool withSound);" @@ -85334,12 +82537,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def sprite_stop_calling_on_event(s, handler):" - ], "cpp": [ "void sprite_stop_calling_on_event(sprite s, sprite_event_handler *handler)" ], + "python": [ + "def sprite_stop_calling_on_event(s, handler):" + ], "csharp": [ "public void Sprite.StopCallingOnEvent(SpriteEventHandler handler);", "public static void SplashKit.SpriteStopCallingOnEvent(Sprite s, SpriteEventHandler handler);" @@ -85403,12 +82606,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_toggle_layer_visible_named(s, name):" - ], "cpp": [ "void sprite_toggle_layer_visible(sprite s, const string &name)" ], + "python": [ + "def sprite_toggle_layer_visible_named(s, name):" + ], "csharp": [ "public void Sprite.ToggleLayerVisible(string name);", "public static void SplashKit.SpriteToggleLayerVisible(Sprite s, string name);" @@ -85471,12 +82674,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_toggle_layer_visible(s, id):" - ], "cpp": [ "void sprite_toggle_layer_visible(sprite s, int id)" ], + "python": [ + "def sprite_toggle_layer_visible(s, id):" + ], "csharp": [ "public void Sprite.ToggleLayerVisible(int id);", "public static void SplashKit.SpriteToggleLayerVisible(Sprite s, int id);" @@ -85539,12 +82742,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_value(s, name):" - ], "cpp": [ "float sprite_value(sprite s, const string &name)" ], + "python": [ + "def sprite_value(s, name):" + ], "csharp": [ "public float Sprite.Value(string name);", "public static float SplashKit.SpriteValue(Sprite s, string name);" @@ -85594,12 +82797,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_value_count(s):" - ], "cpp": [ "int sprite_value_count(sprite s)" ], + "python": [ + "def sprite_value_count(s):" + ], "csharp": [ "public int Sprite.ValueCount { get }", "public static int SplashKit.SpriteValueCount(Sprite s);" @@ -85649,12 +82852,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_velocity(s):" - ], "cpp": [ "vector_2d sprite_velocity(sprite s)" ], + "python": [ + "def sprite_velocity(s):" + ], "csharp": [ "public Vector2D Sprite.Velocity { get }", "public static Vector2D SplashKit.SpriteVelocity(Sprite s);" @@ -85718,12 +82921,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_visible_index_of_layer_named(s, name):" - ], "cpp": [ "int sprite_visible_index_of_layer(sprite s, const string &name)" ], + "python": [ + "def sprite_visible_index_of_layer_named(s, name):" + ], "csharp": [ "public int Sprite.VisibleIndexOfLayer(string name);", "public static int SplashKit.SpriteVisibleIndexOfLayer(Sprite s, string name);" @@ -85786,12 +82989,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_visible_index_of_layer(s, id):" - ], "cpp": [ "int sprite_visible_index_of_layer(sprite s, int id)" ], + "python": [ + "def sprite_visible_index_of_layer(s, id):" + ], "csharp": [ "public int Sprite.VisibleIndexOfLayer(int id);", "public static int SplashKit.SpriteVisibleIndexOfLayer(Sprite s, int id);" @@ -85854,12 +83057,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_visible_layer(s, idx):" - ], "cpp": [ "int sprite_visible_layer(sprite s, int idx)" ], + "python": [ + "def sprite_visible_layer(s, idx):" + ], "csharp": [ "public int Sprite.VisibleLayer(int idx);", "public static int SplashKit.SpriteVisibleLayer(Sprite s, int idx);" @@ -85909,12 +83112,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_visible_layer_count(s):" - ], "cpp": [ "int sprite_visible_layer_count(sprite s)" ], + "python": [ + "def sprite_visible_layer_count(s):" + ], "csharp": [ "public int Sprite.VisibleLayerCount { get }", "public static int SplashKit.SpriteVisibleLayerCount(Sprite s);" @@ -85977,12 +83180,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_visible_layer_id(s, idx):" - ], "cpp": [ "int sprite_visible_layer_id(sprite s, int idx)" ], + "python": [ + "def sprite_visible_layer_id(s, idx):" + ], "csharp": [ "public int Sprite.VisibleLayerIdAt(int idx);", "public static int SplashKit.SpriteVisibleLayerId(Sprite s, int idx);" @@ -86032,12 +83235,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_width(s):" - ], "cpp": [ "int sprite_width(sprite s)" ], + "python": [ + "def sprite_width(s):" + ], "csharp": [ "public int Sprite.Width { get }", "public static int SplashKit.SpriteWidth(Sprite s);" @@ -86087,12 +83290,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_x(s):" - ], "cpp": [ "double sprite_x(sprite s)" ], + "python": [ + "def sprite_x(s):" + ], "csharp": [ "public double Sprite.X { get }", "public static double SplashKit.SpriteX(Sprite s);" @@ -86142,12 +83345,12 @@ "self": "s" }, "signatures": { - "python": [ - "def sprite_y(s):" - ], "cpp": [ "double sprite_y(sprite s)" ], + "python": [ + "def sprite_y(s):" + ], "csharp": [ "public double Sprite.Y { get }", "public static double SplashKit.SpriteY(Sprite s);" @@ -86194,12 +83397,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def stop_calling_on_sprite_event(handler):" - ], "cpp": [ "void stop_calling_on_sprite_event(sprite_event_handler *handler)" ], + "python": [ + "def stop_calling_on_sprite_event(handler):" + ], "csharp": [ "public static void SplashKit.StopCallingOnSpriteEvent(SpriteEventHandler handler);" ], @@ -86232,12 +83435,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def update_all_sprites():" - ], "cpp": [ "void update_all_sprites()" ], + "python": [ + "def update_all_sprites():" + ], "csharp": [ "public static void SplashKit.UpdateAllSprites();" ], @@ -86284,12 +83487,12 @@ "static": "sprite" }, "signatures": { - "python": [ - "def update_all_sprites_percent(pct):" - ], "cpp": [ "void update_all_sprites(float pct)" ], + "python": [ + "def update_all_sprites_percent(pct):" + ], "csharp": [ "public static void SplashKit.UpdateAllSprites(float pct);" ], @@ -86338,12 +83541,12 @@ "self": "s" }, "signatures": { - "python": [ - "def update_sprite(s):" - ], "cpp": [ "void update_sprite(sprite s)" ], + "python": [ + "def update_sprite(s):" + ], "csharp": [ "public void Sprite.Update();", "public static void SplashKit.UpdateSprite(Sprite s);" @@ -86407,12 +83610,12 @@ "self": "s" }, "signatures": { - "python": [ - "def update_sprite_with_sound(s, with_sound):" - ], "cpp": [ "void update_sprite(sprite s, bool with_sound)" ], + "python": [ + "def update_sprite_with_sound(s, with_sound):" + ], "csharp": [ "public void Sprite.Update(bool withSound);", "public static void SplashKit.UpdateSprite(Sprite s, bool withSound);" @@ -86476,12 +83679,12 @@ "self": "s" }, "signatures": { - "python": [ - "def update_sprite_percent(s, pct):" - ], "cpp": [ "void update_sprite(sprite s, float pct)" ], + "python": [ + "def update_sprite_percent(s, pct):" + ], "csharp": [ "public void Sprite.Update(float pct);", "public static void SplashKit.UpdateSprite(Sprite s, float pct);" @@ -86558,12 +83761,12 @@ "self": "s" }, "signatures": { - "python": [ - "def update_sprite_percent_with_sound(s, pct, with_sound):" - ], "cpp": [ "void update_sprite(sprite s, float pct, bool with_sound)" ], + "python": [ + "def update_sprite_percent_with_sound(s, pct, with_sound):" + ], "csharp": [ "public void Sprite.Update(float pct, bool withSound);", "public static void SplashKit.UpdateSprite(Sprite s, float pct, bool withSound);" @@ -86613,12 +83816,12 @@ "self": "s" }, "signatures": { - "python": [ - "def update_sprite_animation(s):" - ], "cpp": [ "void update_sprite_animation(sprite s)" ], + "python": [ + "def update_sprite_animation(s):" + ], "csharp": [ "public void Sprite.UpdateAnimation();", "public static void SplashKit.UpdateSpriteAnimation(Sprite s);" @@ -86682,12 +83885,12 @@ "self": "s" }, "signatures": { - "python": [ - "def update_sprite_animation_with_sound(s, with_sound):" - ], "cpp": [ "void update_sprite_animation(sprite s, bool with_sound)" ], + "python": [ + "def update_sprite_animation_with_sound(s, with_sound):" + ], "csharp": [ "public void Sprite.UpdateAnimation(bool withSound);", "public static void SplashKit.UpdateSpriteAnimation(Sprite s, bool withSound);" @@ -86751,12 +83954,12 @@ "self": "s" }, "signatures": { - "python": [ - "def update_sprite_animation_percent(s, pct):" - ], "cpp": [ "void update_sprite_animation(sprite s, float pct)" ], + "python": [ + "def update_sprite_animation_percent(s, pct):" + ], "csharp": [ "public void Sprite.UpdateAnimation(float pct);", "public static void SplashKit.UpdateSpriteAnimation(Sprite s, float pct);" @@ -86833,12 +84036,12 @@ "self": "s" }, "signatures": { - "python": [ - "def update_sprite_animation_percent_with_sound(s, pct, with_sound):" - ], "cpp": [ "void update_sprite_animation(sprite s, float pct, bool with_sound)" ], + "python": [ + "def update_sprite_animation_percent_with_sound(s, pct, with_sound):" + ], "csharp": [ "public void Sprite.UpdateAnimation(float pct, bool withSound);", "public static void SplashKit.UpdateSpriteAnimation(Sprite s, float pct, bool withSound);" @@ -86902,12 +84105,12 @@ "self": "s" }, "signatures": { - "python": [ - "def vector_from_center_sprite_to_point_point(s, pt):" - ], "cpp": [ "vector_2d vector_from_center_sprite_to_point(sprite s, const point_2d &pt)" ], + "python": [ + "def vector_from_center_sprite_to_point_point(s, pt):" + ], "csharp": [ "public Vector2D Sprite.VectorTo(Point2D pt);", "public static Vector2D SplashKit.VectorFromCenterSpriteToPoint(Sprite s, Point2D pt);" @@ -86970,12 +84173,12 @@ "self": "s1" }, "signatures": { - "python": [ - "def vector_from_to(s1, s2):" - ], "cpp": [ "vector_2d vector_from_to(sprite s1, sprite s2)" ], + "python": [ + "def vector_from_to(s1, s2):" + ], "csharp": [ "public Vector2D Sprite.VectorTo(Sprite s2);", "public static Vector2D SplashKit.VectorFromTo(Sprite s1, Sprite s2);" @@ -87154,8 +84357,8 @@ "static": "sprite" }, "signatures": { - "python": "public enum {CollisionTestKind.pixel_collisions = 0, CollisionTestKind.aabb_collisions = 0}", "cpp": "class collision_test_kind {PIXEL_COLLISIONS = 0, AABB_COLLISIONS = 0};", + "python": "public enum {CollisionTestKind.pixel_collisions = 0, CollisionTestKind.aabb_collisions = 0}", "csharp": "public enum {CollisionTestKind.PixelCollisions = 0, CollisionTestKind.AabbCollisions = 0}", "pascal": "public enum {CollisionTestKind.PixelCollisions = 0, CollisionTestKind.AabbCollisions = 0}" } @@ -87184,8 +84387,8 @@ "static": "sprite" }, "signatures": { - "python": "public enum {SpriteEventKind.sprite_arrived_event = 0, SpriteEventKind.sprite_animation_ended_event = 0, SpriteEventKind.sprite_touched_event = 0, SpriteEventKind.sprite_clicked_event = 0}", "cpp": "class sprite_event_kind {SPRITE_ARRIVED_EVENT = 0, SPRITE_ANIMATION_ENDED_EVENT = 0, SPRITE_TOUCHED_EVENT = 0, SPRITE_CLICKED_EVENT = 0};", + "python": "public enum {SpriteEventKind.sprite_arrived_event = 0, SpriteEventKind.sprite_animation_ended_event = 0, SpriteEventKind.sprite_touched_event = 0, SpriteEventKind.sprite_clicked_event = 0}", "csharp": "public enum {SpriteEventKind.SpriteArrivedEvent = 0, SpriteEventKind.SpriteAnimationEndedEvent = 0, SpriteEventKind.SpriteTouchedEvent = 0, SpriteEventKind.SpriteClickedEvent = 0}", "pascal": "public enum {SpriteEventKind.SpriteArrivedEvent = 0, SpriteEventKind.SpriteAnimationEndedEvent = 0, SpriteEventKind.SpriteTouchedEvent = 0, SpriteEventKind.SpriteClickedEvent = 0}" } @@ -87223,12 +84426,12 @@ "static": "terminal" }, "signatures": { - "python": [ - "def read_char():" - ], "cpp": [ "char read_char()" ], + "python": [ + "def read_char():" + ], "csharp": [ "public static char SplashKit.ReadChar();" ], @@ -87261,12 +84464,12 @@ "static": "terminal" }, "signatures": { - "python": [ - "def read_line():" - ], "cpp": [ "string read_line()" ], + "python": [ + "def read_line():" + ], "csharp": [ "public static string SplashKit.ReadLine();" ], @@ -87299,12 +84502,12 @@ "static": "terminal" }, "signatures": { - "python": [ - "def terminal_has_input():" - ], "cpp": [ "bool terminal_has_input()" ], + "python": [ + "def terminal_has_input():" + ], "csharp": [ "public static bool SplashKit.TerminalHasInput();" ], @@ -87351,12 +84554,12 @@ "static": "terminal" }, "signatures": { - "python": [ - "def write_char(data):" - ], "cpp": [ "void write(char data)" ], + "python": [ + "def write_char(data):" + ], "csharp": [ "public static void SplashKit.Write(char data);" ], @@ -87403,12 +84606,12 @@ "static": "terminal" }, "signatures": { - "python": [ - "def write_double(data):" - ], "cpp": [ "void write(double data)" ], + "python": [ + "def write_double(data):" + ], "csharp": [ "public static void SplashKit.Write(double data);" ], @@ -87455,12 +84658,12 @@ "static": "terminal" }, "signatures": { - "python": [ - "def write_int(data):" - ], "cpp": [ "void write(int data)" ], + "python": [ + "def write_int(data):" + ], "csharp": [ "public static void SplashKit.Write(int data);" ], @@ -87506,12 +84709,12 @@ "static": "terminal" }, "signatures": { - "python": [ - "def write(text):" - ], "cpp": [ "void write(string text)" ], + "python": [ + "def write(text):" + ], "csharp": [ "public static void SplashKit.Write(string text);" ], @@ -87558,12 +84761,12 @@ "static": "terminal" }, "signatures": { - "python": [ - "def write_line_char(data):" - ], "cpp": [ "void write_line(char data)" ], + "python": [ + "def write_line_char(data):" + ], "csharp": [ "public static void SplashKit.WriteLine(char data);" ], @@ -87597,12 +84800,12 @@ "static": "terminal" }, "signatures": { - "python": [ - "def write_line_empty():" - ], "cpp": [ "void write_line()" ], + "python": [ + "def write_line_empty():" + ], "csharp": [ "public static void SplashKit.WriteLine();" ], @@ -87649,12 +84852,12 @@ "static": "terminal" }, "signatures": { - "python": [ - "def write_line_double(data):" - ], "cpp": [ "void write_line(double data)" ], + "python": [ + "def write_line_double(data):" + ], "csharp": [ "public static void SplashKit.WriteLine(double data);" ], @@ -87701,12 +84904,12 @@ "static": "terminal" }, "signatures": { - "python": [ - "def write_line_int(data):" - ], "cpp": [ "void write_line(int data)" ], + "python": [ + "def write_line_int(data):" + ], "csharp": [ "public static void SplashKit.WriteLine(int data);" ], @@ -87752,12 +84955,12 @@ "static": "terminal" }, "signatures": { - "python": [ - "def write_line(line):" - ], "cpp": [ "void write_line(string line)" ], + "python": [ + "def write_line(line):" + ], "csharp": [ "public static void SplashKit.WriteLine(string line);" ], @@ -87823,12 +85026,12 @@ "static": "timers" }, "signatures": { - "python": [ - "def create_timer(name):" - ], "cpp": [ "timer create_timer(string name)" ], + "python": [ + "def create_timer(name):" + ], "csharp": [ "public static Timer SplashKit.CreateTimer(string name);", "public Timer(string name);" @@ -87862,12 +85065,12 @@ "static": "timers" }, "signatures": { - "python": [ - "def free_all_timers():" - ], "cpp": [ "void free_all_timers()" ], + "python": [ + "def free_all_timers():" + ], "csharp": [ "public static void SplashKit.FreeAllTimers();" ], @@ -87879,9 +85082,9 @@ { "signature": "void free_timer(timer to_free);", "name": "free_timer", - "method_name": "free", + "method_name": null, "unique_global_name": "free_timer", - "unique_method_name": "timer.free", + "unique_method_name": null, "suffix_name": null, "description": "Free the memory used to store this timer.", "brief": null, @@ -87911,20 +85114,18 @@ "attributes": { "class": "timer", "destructor": true, - "method": "free", - "self": "to_free", "group": "timers", - "static": "timers" + "static": "timers", + "self": "to_free" }, "signatures": { - "python": [ - "def free_timer(to_free):" - ], "cpp": [ "void free_timer(timer to_free)" ], + "python": [ + "def free_timer(to_free):" + ], "csharp": [ - "public void Timer.Free();", "public static void SplashKit.FreeTimer(Timer toFree);" ], "pascal": [ @@ -87970,12 +85171,12 @@ "static": "timers" }, "signatures": { - "python": [ - "def has_timer_named(name):" - ], "cpp": [ "bool has_timer(string name)" ], + "python": [ + "def has_timer_named(name):" + ], "csharp": [ "public static bool SplashKit.HasTimer(string name);" ], @@ -88022,12 +85223,12 @@ "static": "timers" }, "signatures": { - "python": [ - "def pause_timer_named(name):" - ], "cpp": [ "void pause_timer(string name)" ], + "python": [ + "def pause_timer_named(name):" + ], "csharp": [ "public static void SplashKit.PauseTimer(string name);" ], @@ -88076,12 +85277,12 @@ "self": "to_pause" }, "signatures": { - "python": [ - "def pause_timer(to_pause):" - ], "cpp": [ "void pause_timer(timer to_pause)" ], + "python": [ + "def pause_timer(to_pause):" + ], "csharp": [ "public void Timer.Pause();", "public static void SplashKit.PauseTimer(Timer toPause);" @@ -88129,12 +85330,12 @@ "static": "timers" }, "signatures": { - "python": [ - "def reset_timer_named(name):" - ], "cpp": [ "void reset_timer(string name)" ], + "python": [ + "def reset_timer_named(name):" + ], "csharp": [ "public static void SplashKit.ResetTimer(string name);" ], @@ -88183,12 +85384,12 @@ "self": "tmr" }, "signatures": { - "python": [ - "def reset_timer(tmr):" - ], "cpp": [ "void reset_timer(timer tmr)" ], + "python": [ + "def reset_timer(tmr):" + ], "csharp": [ "public void Timer.Reset();", "public static void SplashKit.ResetTimer(Timer tmr);" @@ -88236,12 +85437,12 @@ "static": "timers" }, "signatures": { - "python": [ - "def resume_timer_named(name):" - ], "cpp": [ "void resume_timer(string name)" ], + "python": [ + "def resume_timer_named(name):" + ], "csharp": [ "public static void SplashKit.ResumeTimer(string name);" ], @@ -88290,12 +85491,12 @@ "self": "to_resume" }, "signatures": { - "python": [ - "def resume_timer(to_resume):" - ], "cpp": [ "void resume_timer(timer to_resume)" ], + "python": [ + "def resume_timer(to_resume):" + ], "csharp": [ "public void Timer.Resume();", "public static void SplashKit.ResumeTimer(Timer toResume);" @@ -88343,12 +85544,12 @@ "static": "timers" }, "signatures": { - "python": [ - "def start_timer_named(name):" - ], "cpp": [ "void start_timer(string name)" ], + "python": [ + "def start_timer_named(name):" + ], "csharp": [ "public static void SplashKit.StartTimer(string name);" ], @@ -88397,12 +85598,12 @@ "self": "to_start" }, "signatures": { - "python": [ - "def start_timer(to_start):" - ], "cpp": [ "void start_timer(timer to_start)" ], + "python": [ + "def start_timer(to_start):" + ], "csharp": [ "public void Timer.Start();", "public static void SplashKit.StartTimer(Timer toStart);" @@ -88450,12 +85651,12 @@ "static": "timers" }, "signatures": { - "python": [ - "def stop_timer_named(name):" - ], "cpp": [ "void stop_timer(string name)" ], + "python": [ + "def stop_timer_named(name):" + ], "csharp": [ "public static void SplashKit.StopTimer(string name);" ], @@ -88504,12 +85705,12 @@ "self": "to_stop" }, "signatures": { - "python": [ - "def stop_timer(to_stop):" - ], "cpp": [ "void stop_timer(timer to_stop)" ], + "python": [ + "def stop_timer(to_stop):" + ], "csharp": [ "public void Timer.Stop();", "public static void SplashKit.StopTimer(Timer toStop);" @@ -88556,12 +85757,12 @@ "static": "timers" }, "signatures": { - "python": [ - "def timer_named(name):" - ], "cpp": [ "timer timer_named(string name)" ], + "python": [ + "def timer_named(name):" + ], "csharp": [ "public static Timer SplashKit.TimerNamed(string name);" ], @@ -88608,12 +85809,12 @@ "static": "timers" }, "signatures": { - "python": [ - "def timer_paused_named(name):" - ], "cpp": [ "bool timer_paused(string name)" ], + "python": [ + "def timer_paused_named(name):" + ], "csharp": [ "public static bool SplashKit.TimerPaused(string name);" ], @@ -88662,12 +85863,12 @@ "self": "to_get" }, "signatures": { - "python": [ - "def timer_paused(to_get):" - ], "cpp": [ "bool timer_paused(timer to_get)" ], + "python": [ + "def timer_paused(to_get):" + ], "csharp": [ "public bool Timer.IsPaused { get }", "public static bool SplashKit.TimerPaused(Timer toGet);" @@ -88715,12 +85916,12 @@ "static": "timers" }, "signatures": { - "python": [ - "def timer_started_named(name):" - ], "cpp": [ "bool timer_started(string name)" ], + "python": [ + "def timer_started_named(name):" + ], "csharp": [ "public static bool SplashKit.TimerStarted(string name);" ], @@ -88769,12 +85970,12 @@ "self": "to_get" }, "signatures": { - "python": [ - "def timer_started(to_get):" - ], "cpp": [ "bool timer_started(timer to_get)" ], + "python": [ + "def timer_started(to_get):" + ], "csharp": [ "public bool Timer.IsStarted { get }", "public static bool SplashKit.TimerStarted(Timer toGet);" @@ -88822,12 +86023,12 @@ "static": "timers" }, "signatures": { - "python": [ - "def timer_ticks_named(name):" - ], "cpp": [ "unsigned int timer_ticks(string name)" ], + "python": [ + "def timer_ticks_named(name):" + ], "csharp": [ "public static uint SplashKit.TimerTicks(string name);" ], @@ -88876,12 +86077,12 @@ "self": "to_get" }, "signatures": { - "python": [ - "def timer_ticks(to_get):" - ], "cpp": [ "unsigned int timer_ticks(timer to_get)" ], + "python": [ + "def timer_ticks(to_get):" + ], "csharp": [ "public uint Timer.Ticks { get }", "public static uint SplashKit.TimerTicks(Timer toGet);" @@ -89100,12 +86301,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_circle_record(clr, c):" - ], "cpp": [ "void draw_circle(color clr, const circle &c)" ], + "python": [ + "def draw_circle_record(clr, c):" + ], "csharp": [ "public void Circle.Draw(Color clr);", "public static void SplashKit.DrawCircle(Color clr, Circle c);" @@ -89181,12 +86382,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def draw_circle_record_with_options(clr, c, opts):" - ], "cpp": [ "void draw_circle(color clr, const circle &c, drawing_options opts)" ], + "python": [ + "def draw_circle_record_with_options(clr, c, opts):" + ], "csharp": [ "public void Circle.Draw(Color clr, DrawingOptions opts);", "public static void SplashKit.DrawCircle(Color clr, Circle c, DrawingOptions opts);" @@ -89249,12 +86450,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def fill_circle_record(clr, c):" - ], "cpp": [ "void fill_circle(color clr, const circle &c)" ], + "python": [ + "def fill_circle_record(clr, c):" + ], "csharp": [ "public void Circle.Fill(Color clr);", "public static void SplashKit.FillCircle(Color clr, Circle c);" @@ -89330,12 +86531,12 @@ "group": "graphics" }, "signatures": { - "python": [ - "def fill_circle_record_with_options(clr, c, opts):" - ], "cpp": [ "void fill_circle(color clr, const circle &c, drawing_options opts)" ], + "python": [ + "def fill_circle_record_with_options(clr, c, opts):" + ], "csharp": [ "public void Circle.Fill(Color clr, DrawingOptions opts);", "public static void SplashKit.FillCircle(Color clr, Circle c, DrawingOptions opts);" @@ -89438,13 +86639,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_alice_blue():" - ], "cpp": [ "#define COLOR_ALICE_BLUE", "color color_alice_blue()" ], + "python": [ + "def color_alice_blue():" + ], "csharp": [ "public static Color Color.AliceBlue { get }", "public static Color SplashKit.ColorAliceBlue();" @@ -89482,13 +86683,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_antique_white():" - ], "cpp": [ "#define COLOR_ANTIQUE_WHITE", "color color_antique_white()" ], + "python": [ + "def color_antique_white():" + ], "csharp": [ "public static Color Color.AntiqueWhite { get }", "public static Color SplashKit.ColorAntiqueWhite();" @@ -89526,13 +86727,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_aqua():" - ], "cpp": [ "#define COLOR_AQUA", "color color_aqua()" ], + "python": [ + "def color_aqua():" + ], "csharp": [ "public static Color Color.Aqua { get }", "public static Color SplashKit.ColorAqua();" @@ -89570,13 +86771,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_aquamarine():" - ], "cpp": [ "#define COLOR_AQUAMARINE", "color color_aquamarine()" ], + "python": [ + "def color_aquamarine():" + ], "csharp": [ "public static Color Color.Aquamarine { get }", "public static Color SplashKit.ColorAquamarine();" @@ -89614,13 +86815,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_azure():" - ], "cpp": [ "#define COLOR_AZURE", "color color_azure()" ], + "python": [ + "def color_azure():" + ], "csharp": [ "public static Color Color.Azure { get }", "public static Color SplashKit.ColorAzure();" @@ -89658,13 +86859,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_beige():" - ], "cpp": [ "#define COLOR_BEIGE", "color color_beige()" ], + "python": [ + "def color_beige():" + ], "csharp": [ "public static Color Color.Beige { get }", "public static Color SplashKit.ColorBeige();" @@ -89702,13 +86903,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_bisque():" - ], "cpp": [ "#define COLOR_BISQUE", "color color_bisque()" ], + "python": [ + "def color_bisque():" + ], "csharp": [ "public static Color Color.Bisque { get }", "public static Color SplashKit.ColorBisque();" @@ -89746,13 +86947,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_black():" - ], "cpp": [ "#define COLOR_BLACK", "color color_black()" ], + "python": [ + "def color_black():" + ], "csharp": [ "public static Color Color.Black { get }", "public static Color SplashKit.ColorBlack();" @@ -89790,13 +86991,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_blanched_almond():" - ], "cpp": [ "#define COLOR_BLANCHED_ALMOND", "color color_blanched_almond()" ], + "python": [ + "def color_blanched_almond():" + ], "csharp": [ "public static Color Color.BlanchedAlmond { get }", "public static Color SplashKit.ColorBlanchedAlmond();" @@ -89834,13 +87035,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_blue():" - ], "cpp": [ "#define COLOR_BLUE", "color color_blue()" ], + "python": [ + "def color_blue():" + ], "csharp": [ "public static Color Color.Blue { get }", "public static Color SplashKit.ColorBlue();" @@ -89878,13 +87079,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_blue_violet():" - ], "cpp": [ "#define COLOR_BLUE_VIOLET", "color color_blue_violet()" ], + "python": [ + "def color_blue_violet():" + ], "csharp": [ "public static Color Color.BlueViolet { get }", "public static Color SplashKit.ColorBlueViolet();" @@ -89922,13 +87123,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_bright_green():" - ], "cpp": [ "#define COLOR_BRIGHT_GREEN", "color color_bright_green()" ], + "python": [ + "def color_bright_green():" + ], "csharp": [ "public static Color Color.BrightGreen { get }", "public static Color SplashKit.ColorBrightGreen();" @@ -89966,13 +87167,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_brown():" - ], "cpp": [ "#define COLOR_BROWN", "color color_brown()" ], + "python": [ + "def color_brown():" + ], "csharp": [ "public static Color Color.Brown { get }", "public static Color SplashKit.ColorBrown();" @@ -90010,13 +87211,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_burly_wood():" - ], "cpp": [ "#define COLOR_BURLY_WOOD", "color color_burly_wood()" ], + "python": [ + "def color_burly_wood():" + ], "csharp": [ "public static Color Color.BurlyWood { get }", "public static Color SplashKit.ColorBurlyWood();" @@ -90054,13 +87255,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_cadet_blue():" - ], "cpp": [ "#define COLOR_CADET_BLUE", "color color_cadet_blue()" ], + "python": [ + "def color_cadet_blue():" + ], "csharp": [ "public static Color Color.CadetBlue { get }", "public static Color SplashKit.ColorCadetBlue();" @@ -90098,13 +87299,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_chartreuse():" - ], "cpp": [ "#define COLOR_CHARTREUSE", "color color_chartreuse()" ], + "python": [ + "def color_chartreuse():" + ], "csharp": [ "public static Color Color.Chartreuse { get }", "public static Color SplashKit.ColorChartreuse();" @@ -90142,13 +87343,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_chocolate():" - ], "cpp": [ "#define COLOR_CHOCOLATE", "color color_chocolate()" ], + "python": [ + "def color_chocolate():" + ], "csharp": [ "public static Color Color.Chocolate { get }", "public static Color SplashKit.ColorChocolate();" @@ -90186,13 +87387,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_coral():" - ], "cpp": [ "#define COLOR_CORAL", "color color_coral()" ], + "python": [ + "def color_coral():" + ], "csharp": [ "public static Color Color.Coral { get }", "public static Color SplashKit.ColorCoral();" @@ -90230,13 +87431,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_cornflower_blue():" - ], "cpp": [ "#define COLOR_CORNFLOWER_BLUE", "color color_cornflower_blue()" ], + "python": [ + "def color_cornflower_blue():" + ], "csharp": [ "public static Color Color.CornflowerBlue { get }", "public static Color SplashKit.ColorCornflowerBlue();" @@ -90274,13 +87475,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_cornsilk():" - ], "cpp": [ "#define COLOR_CORNSILK", "color color_cornsilk()" ], + "python": [ + "def color_cornsilk():" + ], "csharp": [ "public static Color Color.Cornsilk { get }", "public static Color SplashKit.ColorCornsilk();" @@ -90318,13 +87519,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_crimson():" - ], "cpp": [ "#define COLOR_CRIMSON", "color color_crimson()" ], + "python": [ + "def color_crimson():" + ], "csharp": [ "public static Color Color.Crimson { get }", "public static Color SplashKit.ColorCrimson();" @@ -90362,13 +87563,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_cyan():" - ], "cpp": [ "#define COLOR_CYAN", "color color_cyan()" ], + "python": [ + "def color_cyan():" + ], "csharp": [ "public static Color Color.Cyan { get }", "public static Color SplashKit.ColorCyan();" @@ -90406,13 +87607,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_blue():" - ], "cpp": [ "#define COLOR_DARK_BLUE", "color color_dark_blue()" ], + "python": [ + "def color_dark_blue():" + ], "csharp": [ "public static Color Color.DarkBlue { get }", "public static Color SplashKit.ColorDarkBlue();" @@ -90450,13 +87651,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_cyan():" - ], "cpp": [ "#define COLOR_DARK_CYAN", "color color_dark_cyan()" ], + "python": [ + "def color_dark_cyan():" + ], "csharp": [ "public static Color Color.DarkCyan { get }", "public static Color SplashKit.ColorDarkCyan();" @@ -90494,13 +87695,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_goldenrod():" - ], "cpp": [ "#define COLOR_DARK_GOLDENROD", "color color_dark_goldenrod()" ], + "python": [ + "def color_dark_goldenrod():" + ], "csharp": [ "public static Color Color.DarkGoldenrod { get }", "public static Color SplashKit.ColorDarkGoldenrod();" @@ -90538,13 +87739,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_gray():" - ], "cpp": [ "#define COLOR_DARK_GRAY", "color color_dark_gray()" ], + "python": [ + "def color_dark_gray():" + ], "csharp": [ "public static Color Color.DarkGray { get }", "public static Color SplashKit.ColorDarkGray();" @@ -90582,13 +87783,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_green():" - ], "cpp": [ "#define COLOR_DARK_GREEN", "color color_dark_green()" ], + "python": [ + "def color_dark_green():" + ], "csharp": [ "public static Color Color.DarkGreen { get }", "public static Color SplashKit.ColorDarkGreen();" @@ -90626,13 +87827,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_khaki():" - ], "cpp": [ "#define COLOR_DARK_KHAKI", "color color_dark_khaki()" ], + "python": [ + "def color_dark_khaki():" + ], "csharp": [ "public static Color Color.DarkKhaki { get }", "public static Color SplashKit.ColorDarkKhaki();" @@ -90670,13 +87871,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_magenta():" - ], "cpp": [ "#define COLOR_DARK_MAGENTA", "color color_dark_magenta()" ], + "python": [ + "def color_dark_magenta():" + ], "csharp": [ "public static Color Color.DarkMagenta { get }", "public static Color SplashKit.ColorDarkMagenta();" @@ -90714,13 +87915,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_olive_green():" - ], "cpp": [ "#define COLOR_DARK_OLIVE_GREEN", "color color_dark_olive_green()" ], + "python": [ + "def color_dark_olive_green():" + ], "csharp": [ "public static Color Color.DarkOliveGreen { get }", "public static Color SplashKit.ColorDarkOliveGreen();" @@ -90758,13 +87959,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_orange():" - ], "cpp": [ "#define COLOR_DARK_ORANGE", "color color_dark_orange()" ], + "python": [ + "def color_dark_orange():" + ], "csharp": [ "public static Color Color.DarkOrange { get }", "public static Color SplashKit.ColorDarkOrange();" @@ -90802,13 +88003,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_orchid():" - ], "cpp": [ "#define COLOR_DARK_ORCHID", "color color_dark_orchid()" ], + "python": [ + "def color_dark_orchid():" + ], "csharp": [ "public static Color Color.DarkOrchid { get }", "public static Color SplashKit.ColorDarkOrchid();" @@ -90846,13 +88047,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_red():" - ], "cpp": [ "#define COLOR_DARK_RED", "color color_dark_red()" ], + "python": [ + "def color_dark_red():" + ], "csharp": [ "public static Color Color.DarkRed { get }", "public static Color SplashKit.ColorDarkRed();" @@ -90890,13 +88091,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_salmon():" - ], "cpp": [ "#define COLOR_DARK_SALMON", "color color_dark_salmon()" ], + "python": [ + "def color_dark_salmon():" + ], "csharp": [ "public static Color Color.DarkSalmon { get }", "public static Color SplashKit.ColorDarkSalmon();" @@ -90934,13 +88135,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_sea_green():" - ], "cpp": [ "#define COLOR_DARK_SEA_GREEN", "color color_dark_sea_green()" ], + "python": [ + "def color_dark_sea_green():" + ], "csharp": [ "public static Color Color.DarkSeaGreen { get }", "public static Color SplashKit.ColorDarkSeaGreen();" @@ -90978,13 +88179,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_slate_blue():" - ], "cpp": [ "#define COLOR_DARK_SLATE_BLUE", "color color_dark_slate_blue()" ], + "python": [ + "def color_dark_slate_blue():" + ], "csharp": [ "public static Color Color.DarkSlateBlue { get }", "public static Color SplashKit.ColorDarkSlateBlue();" @@ -91022,13 +88223,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_slate_gray():" - ], "cpp": [ "#define COLOR_DARK_SLATE_GRAY", "color color_dark_slate_gray()" ], + "python": [ + "def color_dark_slate_gray():" + ], "csharp": [ "public static Color Color.DarkSlateGray { get }", "public static Color SplashKit.ColorDarkSlateGray();" @@ -91066,13 +88267,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_turquoise():" - ], "cpp": [ "#define COLOR_DARK_TURQUOISE", "color color_dark_turquoise()" ], + "python": [ + "def color_dark_turquoise():" + ], "csharp": [ "public static Color Color.DarkTurquoise { get }", "public static Color SplashKit.ColorDarkTurquoise();" @@ -91110,13 +88311,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dark_violet():" - ], "cpp": [ "#define COLOR_DARK_VIOLET", "color color_dark_violet()" ], + "python": [ + "def color_dark_violet():" + ], "csharp": [ "public static Color Color.DarkViolet { get }", "public static Color SplashKit.ColorDarkViolet();" @@ -91154,13 +88355,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_deep_pink():" - ], "cpp": [ "#define COLOR_DEEP_PINK", "color color_deep_pink()" ], + "python": [ + "def color_deep_pink():" + ], "csharp": [ "public static Color Color.DeepPink { get }", "public static Color SplashKit.ColorDeepPink();" @@ -91198,13 +88399,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_deep_sky_blue():" - ], "cpp": [ "#define COLOR_DEEP_SKY_BLUE", "color color_deep_sky_blue()" ], + "python": [ + "def color_deep_sky_blue():" + ], "csharp": [ "public static Color Color.DeepSkyBlue { get }", "public static Color SplashKit.ColorDeepSkyBlue();" @@ -91242,13 +88443,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dim_gray():" - ], "cpp": [ "#define COLOR_DIM_GRAY", "color color_dim_gray()" ], + "python": [ + "def color_dim_gray():" + ], "csharp": [ "public static Color Color.DimGray { get }", "public static Color SplashKit.ColorDimGray();" @@ -91286,13 +88487,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_dodger_blue():" - ], "cpp": [ "#define COLOR_DODGER_BLUE", "color color_dodger_blue()" ], + "python": [ + "def color_dodger_blue():" + ], "csharp": [ "public static Color Color.DodgerBlue { get }", "public static Color SplashKit.ColorDodgerBlue();" @@ -91330,13 +88531,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_firebrick():" - ], "cpp": [ "#define COLOR_FIREBRICK", "color color_firebrick()" ], + "python": [ + "def color_firebrick():" + ], "csharp": [ "public static Color Color.Firebrick { get }", "public static Color SplashKit.ColorFirebrick();" @@ -91374,13 +88575,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_floral_white():" - ], "cpp": [ "#define COLOR_FLORAL_WHITE", "color color_floral_white()" ], + "python": [ + "def color_floral_white():" + ], "csharp": [ "public static Color Color.FloralWhite { get }", "public static Color SplashKit.ColorFloralWhite();" @@ -91418,13 +88619,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_forest_green():" - ], "cpp": [ "#define COLOR_FOREST_GREEN", "color color_forest_green()" ], + "python": [ + "def color_forest_green():" + ], "csharp": [ "public static Color Color.ForestGreen { get }", "public static Color SplashKit.ColorForestGreen();" @@ -91462,13 +88663,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_fuchsia():" - ], "cpp": [ "#define COLOR_FUCHSIA", "color color_fuchsia()" ], + "python": [ + "def color_fuchsia():" + ], "csharp": [ "public static Color Color.Fuchsia { get }", "public static Color SplashKit.ColorFuchsia();" @@ -91506,13 +88707,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_gainsboro():" - ], "cpp": [ "#define COLOR_GAINSBORO", "color color_gainsboro()" ], + "python": [ + "def color_gainsboro():" + ], "csharp": [ "public static Color Color.Gainsboro { get }", "public static Color SplashKit.ColorGainsboro();" @@ -91550,13 +88751,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_ghost_white():" - ], "cpp": [ "#define COLOR_GHOST_WHITE", "color color_ghost_white()" ], + "python": [ + "def color_ghost_white():" + ], "csharp": [ "public static Color Color.GhostWhite { get }", "public static Color SplashKit.ColorGhostWhite();" @@ -91594,13 +88795,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_gold():" - ], "cpp": [ "#define COLOR_GOLD", "color color_gold()" ], + "python": [ + "def color_gold():" + ], "csharp": [ "public static Color Color.Gold { get }", "public static Color SplashKit.ColorGold();" @@ -91638,13 +88839,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_goldenrod():" - ], "cpp": [ "#define COLOR_GOLDENROD", "color color_goldenrod()" ], + "python": [ + "def color_goldenrod():" + ], "csharp": [ "public static Color Color.Goldenrod { get }", "public static Color SplashKit.ColorGoldenrod();" @@ -91682,13 +88883,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_gray():" - ], "cpp": [ "#define COLOR_GRAY", "color color_gray()" ], + "python": [ + "def color_gray():" + ], "csharp": [ "public static Color Color.Gray { get }", "public static Color SplashKit.ColorGray();" @@ -91726,13 +88927,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_green():" - ], "cpp": [ "#define COLOR_GREEN", "color color_green()" ], + "python": [ + "def color_green():" + ], "csharp": [ "public static Color Color.Green { get }", "public static Color SplashKit.ColorGreen();" @@ -91770,13 +88971,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_green_yellow():" - ], "cpp": [ "#define COLOR_GREEN_YELLOW", "color color_green_yellow()" ], + "python": [ + "def color_green_yellow():" + ], "csharp": [ "public static Color Color.GreenYellow { get }", "public static Color SplashKit.ColorGreenYellow();" @@ -91814,13 +89015,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_honeydew():" - ], "cpp": [ "#define COLOR_HONEYDEW", "color color_honeydew()" ], + "python": [ + "def color_honeydew():" + ], "csharp": [ "public static Color Color.Honeydew { get }", "public static Color SplashKit.ColorHoneydew();" @@ -91858,13 +89059,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_hot_pink():" - ], "cpp": [ "#define COLOR_HOT_PINK", "color color_hot_pink()" ], + "python": [ + "def color_hot_pink():" + ], "csharp": [ "public static Color Color.HotPink { get }", "public static Color SplashKit.ColorHotPink();" @@ -91902,13 +89103,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_indian_red():" - ], "cpp": [ "#define COLOR_INDIAN_RED", "color color_indian_red()" ], + "python": [ + "def color_indian_red():" + ], "csharp": [ "public static Color Color.IndianRed { get }", "public static Color SplashKit.ColorIndianRed();" @@ -91946,13 +89147,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_indigo():" - ], "cpp": [ "#define COLOR_INDIGO", "color color_indigo()" ], + "python": [ + "def color_indigo():" + ], "csharp": [ "public static Color Color.Indigo { get }", "public static Color SplashKit.ColorIndigo();" @@ -91990,13 +89191,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_ivory():" - ], "cpp": [ "#define COLOR_IVORY", "color color_ivory()" ], + "python": [ + "def color_ivory():" + ], "csharp": [ "public static Color Color.Ivory { get }", "public static Color SplashKit.ColorIvory();" @@ -92034,13 +89235,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_khaki():" - ], "cpp": [ "#define COLOR_KHAKI", "color color_khaki()" ], + "python": [ + "def color_khaki():" + ], "csharp": [ "public static Color Color.Khaki { get }", "public static Color SplashKit.ColorKhaki();" @@ -92078,13 +89279,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_lavender():" - ], "cpp": [ "#define COLOR_LAVENDER", "color color_lavender()" ], + "python": [ + "def color_lavender():" + ], "csharp": [ "public static Color Color.Lavender { get }", "public static Color SplashKit.ColorLavender();" @@ -92122,13 +89323,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_lavender_blush():" - ], "cpp": [ "#define COLOR_LAVENDER_BLUSH", "color color_lavender_blush()" ], + "python": [ + "def color_lavender_blush():" + ], "csharp": [ "public static Color Color.LavenderBlush { get }", "public static Color SplashKit.ColorLavenderBlush();" @@ -92166,13 +89367,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_lawn_green():" - ], "cpp": [ "#define COLOR_LAWN_GREEN", "color color_lawn_green()" ], + "python": [ + "def color_lawn_green():" + ], "csharp": [ "public static Color Color.LawnGreen { get }", "public static Color SplashKit.ColorLawnGreen();" @@ -92210,13 +89411,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_lemon_chiffon():" - ], "cpp": [ "#define COLOR_LEMON_CHIFFON", "color color_lemon_chiffon()" ], + "python": [ + "def color_lemon_chiffon():" + ], "csharp": [ "public static Color Color.LemonChiffon { get }", "public static Color SplashKit.ColorLemonChiffon();" @@ -92254,13 +89455,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_blue():" - ], "cpp": [ "#define COLOR_LIGHT_BLUE", "color color_light_blue()" ], + "python": [ + "def color_light_blue():" + ], "csharp": [ "public static Color Color.LightBlue { get }", "public static Color SplashKit.ColorLightBlue();" @@ -92298,13 +89499,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_coral():" - ], "cpp": [ "#define COLOR_LIGHT_CORAL", "color color_light_coral()" ], + "python": [ + "def color_light_coral():" + ], "csharp": [ "public static Color Color.LightCoral { get }", "public static Color SplashKit.ColorLightCoral();" @@ -92342,13 +89543,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_cyan():" - ], "cpp": [ "#define COLOR_LIGHT_CYAN", "color color_light_cyan()" ], + "python": [ + "def color_light_cyan():" + ], "csharp": [ "public static Color Color.LightCyan { get }", "public static Color SplashKit.ColorLightCyan();" @@ -92386,13 +89587,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_goldenrod_yellow():" - ], "cpp": [ "#define COLOR_LIGHT_GOLDENROD_YELLOW", "color color_light_goldenrod_yellow()" ], + "python": [ + "def color_light_goldenrod_yellow():" + ], "csharp": [ "public static Color Color.LightGoldenrodYellow { get }", "public static Color SplashKit.ColorLightGoldenrodYellow();" @@ -92430,13 +89631,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_gray():" - ], "cpp": [ "#define COLOR_LIGHT_GRAY", "color color_light_gray()" ], + "python": [ + "def color_light_gray():" + ], "csharp": [ "public static Color Color.LightGray { get }", "public static Color SplashKit.ColorLightGray();" @@ -92474,13 +89675,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_green():" - ], "cpp": [ "#define COLOR_LIGHT_GREEN", "color color_light_green()" ], + "python": [ + "def color_light_green():" + ], "csharp": [ "public static Color Color.LightGreen { get }", "public static Color SplashKit.ColorLightGreen();" @@ -92518,13 +89719,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_pink():" - ], "cpp": [ "#define COLOR_LIGHT_PINK", "color color_light_pink()" ], + "python": [ + "def color_light_pink():" + ], "csharp": [ "public static Color Color.LightPink { get }", "public static Color SplashKit.ColorLightPink();" @@ -92562,13 +89763,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_salmon():" - ], "cpp": [ "#define COLOR_LIGHT_SALMON", "color color_light_salmon()" ], + "python": [ + "def color_light_salmon():" + ], "csharp": [ "public static Color Color.LightSalmon { get }", "public static Color SplashKit.ColorLightSalmon();" @@ -92606,13 +89807,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_sea_green():" - ], "cpp": [ "#define COLOR_LIGHT_SEA_GREEN", "color color_light_sea_green()" ], + "python": [ + "def color_light_sea_green():" + ], "csharp": [ "public static Color Color.LightSeaGreen { get }", "public static Color SplashKit.ColorLightSeaGreen();" @@ -92650,13 +89851,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_sky_blue():" - ], "cpp": [ "#define COLOR_LIGHT_SKY_BLUE", "color color_light_sky_blue()" ], + "python": [ + "def color_light_sky_blue():" + ], "csharp": [ "public static Color Color.LightSkyBlue { get }", "public static Color SplashKit.ColorLightSkyBlue();" @@ -92694,13 +89895,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_slate_gray():" - ], "cpp": [ "#define COLOR_LIGHT_SLATE_GRAY", "color color_light_slate_gray()" ], + "python": [ + "def color_light_slate_gray():" + ], "csharp": [ "public static Color Color.LightSlateGray { get }", "public static Color SplashKit.ColorLightSlateGray();" @@ -92738,13 +89939,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_steel_blue():" - ], "cpp": [ "#define COLOR_LIGHT_STEEL_BLUE", "color color_light_steel_blue()" ], + "python": [ + "def color_light_steel_blue():" + ], "csharp": [ "public static Color Color.LightSteelBlue { get }", "public static Color SplashKit.ColorLightSteelBlue();" @@ -92782,13 +89983,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_light_yellow():" - ], "cpp": [ "#define COLOR_LIGHT_YELLOW", "color color_light_yellow()" ], + "python": [ + "def color_light_yellow():" + ], "csharp": [ "public static Color Color.LightYellow { get }", "public static Color SplashKit.ColorLightYellow();" @@ -92826,13 +90027,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_lime():" - ], "cpp": [ "#define COLOR_LIME", "color color_lime()" ], + "python": [ + "def color_lime():" + ], "csharp": [ "public static Color Color.Lime { get }", "public static Color SplashKit.ColorLime();" @@ -92870,13 +90071,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_lime_green():" - ], "cpp": [ "#define COLOR_LIME_GREEN", "color color_lime_green()" ], + "python": [ + "def color_lime_green():" + ], "csharp": [ "public static Color Color.LimeGreen { get }", "public static Color SplashKit.ColorLimeGreen();" @@ -92914,13 +90115,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_linen():" - ], "cpp": [ "#define COLOR_LINEN", "color color_linen()" ], + "python": [ + "def color_linen():" + ], "csharp": [ "public static Color Color.Linen { get }", "public static Color SplashKit.ColorLinen();" @@ -92958,13 +90159,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_magenta():" - ], "cpp": [ "#define COLOR_MAGENTA", "color color_magenta()" ], + "python": [ + "def color_magenta():" + ], "csharp": [ "public static Color Color.Magenta { get }", "public static Color SplashKit.ColorMagenta();" @@ -93002,13 +90203,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_maroon():" - ], "cpp": [ "#define COLOR_MAROON", "color color_maroon()" ], + "python": [ + "def color_maroon():" + ], "csharp": [ "public static Color Color.Maroon { get }", "public static Color SplashKit.ColorMaroon();" @@ -93046,13 +90247,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_aquamarine():" - ], "cpp": [ "#define COLOR_MEDIUM_AQUAMARINE", "color color_medium_aquamarine()" ], + "python": [ + "def color_medium_aquamarine():" + ], "csharp": [ "public static Color Color.MediumAquamarine { get }", "public static Color SplashKit.ColorMediumAquamarine();" @@ -93090,13 +90291,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_blue():" - ], "cpp": [ "#define COLOR_MEDIUM_BLUE", "color color_medium_blue()" ], + "python": [ + "def color_medium_blue():" + ], "csharp": [ "public static Color Color.MediumBlue { get }", "public static Color SplashKit.ColorMediumBlue();" @@ -93134,13 +90335,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_orchid():" - ], "cpp": [ "#define COLOR_MEDIUM_ORCHID", "color color_medium_orchid()" ], + "python": [ + "def color_medium_orchid():" + ], "csharp": [ "public static Color Color.MediumOrchid { get }", "public static Color SplashKit.ColorMediumOrchid();" @@ -93178,13 +90379,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_purple():" - ], "cpp": [ "#define COLOR_MEDIUM_PURPLE", "color color_medium_purple()" ], + "python": [ + "def color_medium_purple():" + ], "csharp": [ "public static Color Color.MediumPurple { get }", "public static Color SplashKit.ColorMediumPurple();" @@ -93222,13 +90423,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_sea_green():" - ], "cpp": [ "#define COLOR_MEDIUM_SEA_GREEN", "color color_medium_sea_green()" ], + "python": [ + "def color_medium_sea_green():" + ], "csharp": [ "public static Color Color.MediumSeaGreen { get }", "public static Color SplashKit.ColorMediumSeaGreen();" @@ -93266,13 +90467,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_slate_blue():" - ], "cpp": [ "#define COLOR_MEDIUM_SLATE_BLUE", "color color_medium_slate_blue()" ], + "python": [ + "def color_medium_slate_blue():" + ], "csharp": [ "public static Color Color.MediumSlateBlue { get }", "public static Color SplashKit.ColorMediumSlateBlue();" @@ -93310,13 +90511,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_spring_green():" - ], "cpp": [ "#define COLOR_MEDIUM_SPRING_GREEN", "color color_medium_spring_green()" ], + "python": [ + "def color_medium_spring_green():" + ], "csharp": [ "public static Color Color.MediumSpringGreen { get }", "public static Color SplashKit.ColorMediumSpringGreen();" @@ -93354,13 +90555,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_turquoise():" - ], "cpp": [ "#define COLOR_MEDIUM_TURQUOISE", "color color_medium_turquoise()" ], + "python": [ + "def color_medium_turquoise():" + ], "csharp": [ "public static Color Color.MediumTurquoise { get }", "public static Color SplashKit.ColorMediumTurquoise();" @@ -93398,13 +90599,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_medium_violet_red():" - ], "cpp": [ "#define COLOR_MEDIUM_VIOLET_RED", "color color_medium_violet_red()" ], + "python": [ + "def color_medium_violet_red():" + ], "csharp": [ "public static Color Color.MediumVioletRed { get }", "public static Color SplashKit.ColorMediumVioletRed();" @@ -93442,13 +90643,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_midnight_blue():" - ], "cpp": [ "#define COLOR_MIDNIGHT_BLUE", "color color_midnight_blue()" ], + "python": [ + "def color_midnight_blue():" + ], "csharp": [ "public static Color Color.MidnightBlue { get }", "public static Color SplashKit.ColorMidnightBlue();" @@ -93486,13 +90687,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_mint_cream():" - ], "cpp": [ "#define COLOR_MINT_CREAM", "color color_mint_cream()" ], + "python": [ + "def color_mint_cream():" + ], "csharp": [ "public static Color Color.MintCream { get }", "public static Color SplashKit.ColorMintCream();" @@ -93530,13 +90731,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_misty_rose():" - ], "cpp": [ "#define COLOR_MISTY_ROSE", "color color_misty_rose()" ], + "python": [ + "def color_misty_rose():" + ], "csharp": [ "public static Color Color.MistyRose { get }", "public static Color SplashKit.ColorMistyRose();" @@ -93574,13 +90775,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_moccasin():" - ], "cpp": [ "#define COLOR_MOCCASIN", "color color_moccasin()" ], + "python": [ + "def color_moccasin():" + ], "csharp": [ "public static Color Color.Moccasin { get }", "public static Color SplashKit.ColorMoccasin();" @@ -93618,13 +90819,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_navajo_white():" - ], "cpp": [ "#define COLOR_NAVAJO_WHITE", "color color_navajo_white()" ], + "python": [ + "def color_navajo_white():" + ], "csharp": [ "public static Color Color.NavajoWhite { get }", "public static Color SplashKit.ColorNavajoWhite();" @@ -93662,13 +90863,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_navy():" - ], "cpp": [ "#define COLOR_NAVY", "color color_navy()" ], + "python": [ + "def color_navy():" + ], "csharp": [ "public static Color Color.Navy { get }", "public static Color SplashKit.ColorNavy();" @@ -93706,13 +90907,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_old_lace():" - ], "cpp": [ "#define COLOR_OLD_LACE", "color color_old_lace()" ], + "python": [ + "def color_old_lace():" + ], "csharp": [ "public static Color Color.OldLace { get }", "public static Color SplashKit.ColorOldLace();" @@ -93750,13 +90951,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_olive():" - ], "cpp": [ "#define COLOR_OLIVE", "color color_olive()" ], + "python": [ + "def color_olive():" + ], "csharp": [ "public static Color Color.Olive { get }", "public static Color SplashKit.ColorOlive();" @@ -93794,13 +90995,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_olive_drab():" - ], "cpp": [ "#define COLOR_OLIVE_DRAB", "color color_olive_drab()" ], + "python": [ + "def color_olive_drab():" + ], "csharp": [ "public static Color Color.OliveDrab { get }", "public static Color SplashKit.ColorOliveDrab();" @@ -93838,13 +91039,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_orange():" - ], "cpp": [ "#define COLOR_ORANGE", "color color_orange()" ], + "python": [ + "def color_orange():" + ], "csharp": [ "public static Color Color.Orange { get }", "public static Color SplashKit.ColorOrange();" @@ -93882,13 +91083,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_orange_red():" - ], "cpp": [ "#define COLOR_ORANGE_RED", "color color_orange_red()" ], + "python": [ + "def color_orange_red():" + ], "csharp": [ "public static Color Color.OrangeRed { get }", "public static Color SplashKit.ColorOrangeRed();" @@ -93926,13 +91127,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_orchid():" - ], "cpp": [ "#define COLOR_ORCHID", "color color_orchid()" ], + "python": [ + "def color_orchid():" + ], "csharp": [ "public static Color Color.Orchid { get }", "public static Color SplashKit.ColorOrchid();" @@ -93970,13 +91171,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_pale_goldenrod():" - ], "cpp": [ "#define COLOR_PALE_GOLDENROD", "color color_pale_goldenrod()" ], + "python": [ + "def color_pale_goldenrod():" + ], "csharp": [ "public static Color Color.PaleGoldenrod { get }", "public static Color SplashKit.ColorPaleGoldenrod();" @@ -94014,13 +91215,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_pale_green():" - ], "cpp": [ "#define COLOR_PALE_GREEN", "color color_pale_green()" ], + "python": [ + "def color_pale_green():" + ], "csharp": [ "public static Color Color.PaleGreen { get }", "public static Color SplashKit.ColorPaleGreen();" @@ -94058,13 +91259,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_pale_turquoise():" - ], "cpp": [ "#define COLOR_PALE_TURQUOISE", "color color_pale_turquoise()" ], + "python": [ + "def color_pale_turquoise():" + ], "csharp": [ "public static Color Color.PaleTurquoise { get }", "public static Color SplashKit.ColorPaleTurquoise();" @@ -94102,13 +91303,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_pale_violet_red():" - ], "cpp": [ "#define COLOR_PALE_VIOLET_RED", "color color_pale_violet_red()" ], + "python": [ + "def color_pale_violet_red():" + ], "csharp": [ "public static Color Color.PaleVioletRed { get }", "public static Color SplashKit.ColorPaleVioletRed();" @@ -94146,13 +91347,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_papaya_whip():" - ], "cpp": [ "#define COLOR_PAPAYA_WHIP", "color color_papaya_whip()" ], + "python": [ + "def color_papaya_whip():" + ], "csharp": [ "public static Color Color.PapayaWhip { get }", "public static Color SplashKit.ColorPapayaWhip();" @@ -94190,13 +91391,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_peach_puff():" - ], "cpp": [ "#define COLOR_PEACH_PUFF", "color color_peach_puff()" ], + "python": [ + "def color_peach_puff():" + ], "csharp": [ "public static Color Color.PeachPuff { get }", "public static Color SplashKit.ColorPeachPuff();" @@ -94234,13 +91435,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_peru():" - ], "cpp": [ "#define COLOR_PERU", "color color_peru()" ], + "python": [ + "def color_peru():" + ], "csharp": [ "public static Color Color.Peru { get }", "public static Color SplashKit.ColorPeru();" @@ -94278,13 +91479,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_pink():" - ], "cpp": [ "#define COLOR_PINK", "color color_pink()" ], + "python": [ + "def color_pink():" + ], "csharp": [ "public static Color Color.Pink { get }", "public static Color SplashKit.ColorPink();" @@ -94322,13 +91523,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_plum():" - ], "cpp": [ "#define COLOR_PLUM", "color color_plum()" ], + "python": [ + "def color_plum():" + ], "csharp": [ "public static Color Color.Plum { get }", "public static Color SplashKit.ColorPlum();" @@ -94366,13 +91567,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_powder_blue():" - ], "cpp": [ "#define COLOR_POWDER_BLUE", "color color_powder_blue()" ], + "python": [ + "def color_powder_blue():" + ], "csharp": [ "public static Color Color.PowderBlue { get }", "public static Color SplashKit.ColorPowderBlue();" @@ -94410,13 +91611,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_purple():" - ], "cpp": [ "#define COLOR_PURPLE", "color color_purple()" ], + "python": [ + "def color_purple():" + ], "csharp": [ "public static Color Color.Purple { get }", "public static Color SplashKit.ColorPurple();" @@ -94454,13 +91655,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_red():" - ], "cpp": [ "#define COLOR_RED", "color color_red()" ], + "python": [ + "def color_red():" + ], "csharp": [ "public static Color Color.Red { get }", "public static Color SplashKit.ColorRed();" @@ -94498,13 +91699,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_rosy_brown():" - ], "cpp": [ "#define COLOR_ROSY_BROWN", "color color_rosy_brown()" ], + "python": [ + "def color_rosy_brown():" + ], "csharp": [ "public static Color Color.RosyBrown { get }", "public static Color SplashKit.ColorRosyBrown();" @@ -94542,13 +91743,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_royal_blue():" - ], "cpp": [ "#define COLOR_ROYAL_BLUE", "color color_royal_blue()" ], + "python": [ + "def color_royal_blue():" + ], "csharp": [ "public static Color Color.RoyalBlue { get }", "public static Color SplashKit.ColorRoyalBlue();" @@ -94586,13 +91787,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_saddle_brown():" - ], "cpp": [ "#define COLOR_SADDLE_BROWN", "color color_saddle_brown()" ], + "python": [ + "def color_saddle_brown():" + ], "csharp": [ "public static Color Color.SaddleBrown { get }", "public static Color SplashKit.ColorSaddleBrown();" @@ -94630,13 +91831,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_salmon():" - ], "cpp": [ "#define COLOR_SALMON", "color color_salmon()" ], + "python": [ + "def color_salmon():" + ], "csharp": [ "public static Color Color.Salmon { get }", "public static Color SplashKit.ColorSalmon();" @@ -94674,13 +91875,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_sandy_brown():" - ], "cpp": [ "#define COLOR_SANDY_BROWN", "color color_sandy_brown()" ], + "python": [ + "def color_sandy_brown():" + ], "csharp": [ "public static Color Color.SandyBrown { get }", "public static Color SplashKit.ColorSandyBrown();" @@ -94718,13 +91919,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_sea_green():" - ], "cpp": [ "#define COLOR_SEA_GREEN", "color color_sea_green()" ], + "python": [ + "def color_sea_green():" + ], "csharp": [ "public static Color Color.SeaGreen { get }", "public static Color SplashKit.ColorSeaGreen();" @@ -94762,13 +91963,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_sea_shell():" - ], "cpp": [ "#define COLOR_SEA_SHELL", "color color_sea_shell()" ], + "python": [ + "def color_sea_shell():" + ], "csharp": [ "public static Color Color.SeaShell { get }", "public static Color SplashKit.ColorSeaShell();" @@ -94806,13 +92007,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_sienna():" - ], "cpp": [ "#define COLOR_SIENNA", "color color_sienna()" ], + "python": [ + "def color_sienna():" + ], "csharp": [ "public static Color Color.Sienna { get }", "public static Color SplashKit.ColorSienna();" @@ -94850,13 +92051,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_silver():" - ], "cpp": [ "#define COLOR_SILVER", "color color_silver()" ], + "python": [ + "def color_silver():" + ], "csharp": [ "public static Color Color.Silver { get }", "public static Color SplashKit.ColorSilver();" @@ -94894,13 +92095,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_sky_blue():" - ], "cpp": [ "#define COLOR_SKY_BLUE", "color color_sky_blue()" ], + "python": [ + "def color_sky_blue():" + ], "csharp": [ "public static Color Color.SkyBlue { get }", "public static Color SplashKit.ColorSkyBlue();" @@ -94938,13 +92139,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_slate_blue():" - ], "cpp": [ "#define COLOR_SLATE_BLUE", "color color_slate_blue()" ], + "python": [ + "def color_slate_blue():" + ], "csharp": [ "public static Color Color.SlateBlue { get }", "public static Color SplashKit.ColorSlateBlue();" @@ -94982,13 +92183,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_slate_gray():" - ], "cpp": [ "#define COLOR_SLATE_GRAY", "color color_slate_gray()" ], + "python": [ + "def color_slate_gray():" + ], "csharp": [ "public static Color Color.SlateGray { get }", "public static Color SplashKit.ColorSlateGray();" @@ -95026,13 +92227,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_snow():" - ], "cpp": [ "#define COLOR_SNOW", "color color_snow()" ], + "python": [ + "def color_snow():" + ], "csharp": [ "public static Color Color.Snow { get }", "public static Color SplashKit.ColorSnow();" @@ -95070,13 +92271,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_spring_green():" - ], "cpp": [ "#define COLOR_SPRING_GREEN", "color color_spring_green()" ], + "python": [ + "def color_spring_green():" + ], "csharp": [ "public static Color Color.SpringGreen { get }", "public static Color SplashKit.ColorSpringGreen();" @@ -95114,13 +92315,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_steel_blue():" - ], "cpp": [ "#define COLOR_STEEL_BLUE", "color color_steel_blue()" ], + "python": [ + "def color_steel_blue():" + ], "csharp": [ "public static Color Color.SteelBlue { get }", "public static Color SplashKit.ColorSteelBlue();" @@ -95158,13 +92359,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_swinburne_red():" - ], "cpp": [ "#define COLOR_SWINBURNE_RED", "color color_swinburne_red()" ], + "python": [ + "def color_swinburne_red():" + ], "csharp": [ "public static Color Color.SwinburneRed { get }", "public static Color SplashKit.ColorSwinburneRed();" @@ -95202,13 +92403,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_tan():" - ], "cpp": [ "#define COLOR_TAN", "color color_tan()" ], + "python": [ + "def color_tan():" + ], "csharp": [ "public static Color Color.Tan { get }", "public static Color SplashKit.ColorTan();" @@ -95246,13 +92447,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_teal():" - ], "cpp": [ "#define COLOR_TEAL", "color color_teal()" ], + "python": [ + "def color_teal():" + ], "csharp": [ "public static Color Color.Teal { get }", "public static Color SplashKit.ColorTeal();" @@ -95290,13 +92491,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_thistle():" - ], "cpp": [ "#define COLOR_THISTLE", "color color_thistle()" ], + "python": [ + "def color_thistle():" + ], "csharp": [ "public static Color Color.Thistle { get }", "public static Color SplashKit.ColorThistle();" @@ -95334,13 +92535,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_tomato():" - ], "cpp": [ "#define COLOR_TOMATO", "color color_tomato()" ], + "python": [ + "def color_tomato():" + ], "csharp": [ "public static Color Color.Tomato { get }", "public static Color SplashKit.ColorTomato();" @@ -95378,13 +92579,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_transparent():" - ], "cpp": [ "#define COLOR_TRANSPARENT", "color color_transparent()" ], + "python": [ + "def color_transparent():" + ], "csharp": [ "public static Color Color.Transparent { get }", "public static Color SplashKit.ColorTransparent();" @@ -95422,13 +92623,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_turquoise():" - ], "cpp": [ "#define COLOR_TURQUOISE", "color color_turquoise()" ], + "python": [ + "def color_turquoise():" + ], "csharp": [ "public static Color Color.Turquoise { get }", "public static Color SplashKit.ColorTurquoise();" @@ -95466,13 +92667,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_violet():" - ], "cpp": [ "#define COLOR_VIOLET", "color color_violet()" ], + "python": [ + "def color_violet():" + ], "csharp": [ "public static Color Color.Violet { get }", "public static Color SplashKit.ColorViolet();" @@ -95510,13 +92711,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_wheat():" - ], "cpp": [ "#define COLOR_WHEAT", "color color_wheat()" ], + "python": [ + "def color_wheat():" + ], "csharp": [ "public static Color Color.Wheat { get }", "public static Color SplashKit.ColorWheat();" @@ -95554,13 +92755,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_white():" - ], "cpp": [ "#define COLOR_WHITE", "color color_white()" ], + "python": [ + "def color_white():" + ], "csharp": [ "public static Color Color.White { get }", "public static Color SplashKit.ColorWhite();" @@ -95598,13 +92799,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_white_smoke():" - ], "cpp": [ "#define COLOR_WHITE_SMOKE", "color color_white_smoke()" ], + "python": [ + "def color_white_smoke():" + ], "csharp": [ "public static Color Color.WhiteSmoke { get }", "public static Color SplashKit.ColorWhiteSmoke();" @@ -95642,13 +92843,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_yellow():" - ], "cpp": [ "#define COLOR_YELLOW", "color color_yellow()" ], + "python": [ + "def color_yellow():" + ], "csharp": [ "public static Color Color.Yellow { get }", "public static Color SplashKit.ColorYellow();" @@ -95686,13 +92887,13 @@ "group": "color" }, "signatures": { - "python": [ - "def color_yellow_green():" - ], "cpp": [ "#define COLOR_YELLOW_GREEN", "color color_yellow_green()" ], + "python": [ + "def color_yellow_green():" + ], "csharp": [ "public static Color Color.YellowGreen { get }", "public static Color SplashKit.ColorYellowGreen();" @@ -95773,12 +92974,12 @@ "group": "color" }, "signatures": { - "python": [ - "def hsb_color(hue, saturation, brightness):" - ], "cpp": [ "color hsb_color(double hue, double saturation, double brightness)" ], + "python": [ + "def hsb_color(hue, saturation, brightness):" + ], "csharp": [ "public static Color Color.HSBColor(double hue, double saturation, double brightness);", "public static Color SplashKit.HSBColor(double hue, double saturation, double brightness);" @@ -95813,12 +93014,12 @@ "group": "color" }, "signatures": { - "python": [ - "def random_color():" - ], "cpp": [ "color random_color()" ], + "python": [ + "def random_color():" + ], "csharp": [ "public static Color Color.Random();", "public static Color SplashKit.RandomColor();" @@ -95866,12 +93067,12 @@ "group": "color" }, "signatures": { - "python": [ - "def random_rgb_color(alpha):" - ], "cpp": [ "color random_rgb_color(int alpha)" ], + "python": [ + "def random_rgb_color(alpha):" + ], "csharp": [ "public static Color Color.RandomRGB(int alpha);", "public static Color SplashKit.RandomRGBColor(int alpha);" @@ -95946,12 +93147,12 @@ "group": "color" }, "signatures": { - "python": [ - "def rgb_color_from_double(red, green, blue):" - ], "cpp": [ "color rgb_color(double red, double green, double blue)" ], + "python": [ + "def rgb_color_from_double(red, green, blue):" + ], "csharp": [ "public static Color Color.RGBColor(double red, double green, double blue);", "public static Color SplashKit.RGBColor(double red, double green, double blue);" @@ -96025,12 +93226,12 @@ "group": "color" }, "signatures": { - "python": [ - "def rgb_color(red, green, blue):" - ], "cpp": [ "color rgb_color(int red, int green, int blue)" ], + "python": [ + "def rgb_color(red, green, blue):" + ], "csharp": [ "public static Color Color.RGBColor(int red, int green, int blue);", "public static Color SplashKit.RGBColor(int red, int green, int blue);" @@ -96118,12 +93319,12 @@ "group": "color" }, "signatures": { - "python": [ - "def rgba_color_from_double(red, green, blue, alpha):" - ], "cpp": [ "color rgba_color(double red, double green, double blue, double alpha)" ], + "python": [ + "def rgba_color_from_double(red, green, blue, alpha):" + ], "csharp": [ "public static Color Color.RGBAColor(double red, double green, double blue, double alpha);", "public static Color SplashKit.RGBAColor(double red, double green, double blue, double alpha);" @@ -96210,12 +93411,12 @@ "group": "color" }, "signatures": { - "python": [ - "def rgba_color(red, green, blue, alpha):" - ], "cpp": [ "color rgba_color(int red, int green, int blue, int alpha)" ], + "python": [ + "def rgba_color(red, green, blue, alpha):" + ], "csharp": [ "public static Color Color.RGBAColor(int red, int green, int blue, int alpha);", "public static Color SplashKit.RGBAColor(int red, int green, int blue, int alpha);" @@ -96739,19 +93940,19 @@ "number": 3 }, "ADC_PIN_4": { - "description": "Analog Input Channel 4 (only available for ADS7830)", + "description": "Analog Input Channel 4", "number": 4 }, "ADC_PIN_5": { - "description": "Analog Input Channel 5 (only available for ADS7830)", + "description": "Analog Input Channel 5", "number": 5 }, "ADC_PIN_6": { - "description": "Analog Input Channel 6 (only available for ADS7830)", + "description": "Analog Input Channel 6", "number": 6 }, "ADC_PIN_7": { - "description": "Analog Input Channel 7 (only available for ADS7830)", + "description": "Analog Input Channel 7", "number": 7 } }, @@ -96759,14 +93960,14 @@ "group": "types" }, "signatures": { - "python": "public enum {AdcPin.adc_pin_0 = 0, AdcPin.adc_pin_1 = 1, AdcPin.adc_pin_2 = 2, AdcPin.adc_pin_3 = 3, AdcPin.adc_pin_4 = 4, AdcPin.adc_pin_5 = 5, AdcPin.adc_pin_6 = 6, AdcPin.adc_pin_7 = 7}", "cpp": "class adc_pin {ADC_PIN_0 = 0, ADC_PIN_1 = 1, ADC_PIN_2 = 2, ADC_PIN_3 = 3, ADC_PIN_4 = 4, ADC_PIN_5 = 5, ADC_PIN_6 = 6, ADC_PIN_7 = 7};", + "python": "public enum {AdcPin.adc_pin_0 = 0, AdcPin.adc_pin_1 = 1, AdcPin.adc_pin_2 = 2, AdcPin.adc_pin_3 = 3, AdcPin.adc_pin_4 = 4, AdcPin.adc_pin_5 = 5, AdcPin.adc_pin_6 = 6, AdcPin.adc_pin_7 = 7}", "csharp": "public enum {AdcPin.AdcPin0 = 0, AdcPin.AdcPin1 = 1, AdcPin.AdcPin2 = 2, AdcPin.AdcPin3 = 3, AdcPin.AdcPin4 = 4, AdcPin.AdcPin5 = 5, AdcPin.AdcPin6 = 6, AdcPin.AdcPin7 = 7}", "pascal": "public enum {AdcPin.AdcPin0 = 0, AdcPin.AdcPin1 = 1, AdcPin.AdcPin2 = 2, AdcPin.AdcPin3 = 3, AdcPin.AdcPin4 = 4, AdcPin.AdcPin5 = 5, AdcPin.AdcPin6 = 6, AdcPin.AdcPin7 = 7}" } }, { - "signature": "enum adc_type {ADS7830 = 0,PCF8591 = 1,};", + "signature": "enum adc_type {ADS7830 = 0,// PCF8591 = 1,};", "name": "adc_type", "description": "ADC Type:", "brief": null, @@ -96774,20 +93975,16 @@ "ADS7830": { "description": "8-Bit, 8-Channel Sampling A/D Converter with I2C Interface", "number": 0 - }, - "PCF8591": { - "description": "8-Bit, 4-Channel Sampling A/D Converter with I2C Interface", - "number": 1 } }, "attributes": { "group": "types" }, "signatures": { - "python": "public enum {AdcType.ads7830 = 0, AdcType.pcf8591 = 1}", - "cpp": "class adc_type {ADS7830 = 0, PCF8591 = 1};", - "csharp": "public enum {AdcType.Ads7830 = 0, AdcType.Pcf8591 = 1}", - "pascal": "public enum {AdcType.Ads7830 = 0, AdcType.Pcf8591 = 1}" + "cpp": "class adc_type {ADS7830 = 0};", + "python": "public enum {AdcType.ads7830 = 0}", + "csharp": "public enum {AdcType.Ads7830 = 0}", + "pascal": "public enum {AdcType.Ads7830 = 0}" } }, { @@ -96810,8 +94007,8 @@ "group": "types" }, "signatures": { - "python": "public enum {DrawingDest.draw_to_screen = 0, DrawingDest.draw_to_world = 0, DrawingDest.draw_default = 0}", "cpp": "class drawing_dest {DRAW_TO_SCREEN = 0, DRAW_TO_WORLD = 0, DRAW_DEFAULT = 0};", + "python": "public enum {DrawingDest.draw_to_screen = 0, DrawingDest.draw_to_world = 0, DrawingDest.draw_default = 0}", "csharp": "public enum {DrawingDest.DrawToScreen = 0, DrawingDest.DrawToWorld = 0, DrawingDest.DrawDefault = 0}", "pascal": "public enum {DrawingDest.DrawToScreen = 0, DrawingDest.DrawToWorld = 0, DrawingDest.DrawDefault = 0}" } @@ -96843,8 +94040,8 @@ "group": "types" }, "signatures": { - "python": "public enum {FontStyle.normal_font = 0, FontStyle.bold_font = 1, FontStyle.italic_font = 2, FontStyle.underline_font = 4}", "cpp": "class font_style {NORMAL_FONT = 0, BOLD_FONT = 1, ITALIC_FONT = 2, UNDERLINE_FONT = 4};", + "python": "public enum {FontStyle.normal_font = 0, FontStyle.bold_font = 1, FontStyle.italic_font = 2, FontStyle.underline_font = 4}", "csharp": "public enum {FontStyle.NormalFont = 0, FontStyle.BoldFont = 1, FontStyle.ItalicFont = 2, FontStyle.UnderlineFont = 4}", "pascal": "public enum {FontStyle.NormalFont = 0, FontStyle.BoldFont = 1, FontStyle.ItalicFont = 2, FontStyle.UnderlineFont = 4}" } @@ -96864,7 +94061,7 @@ "number": 2 }, "PIN_3": { - "description": "GPIO 2 / SDA (I2C)", + "description": "GPIO2 / SDA (I2C)", "number": 3 }, "PIN_4": { @@ -96872,7 +94069,7 @@ "number": 4 }, "PIN_5": { - "description": "GPIO 3 / SCL (I2C)", + "description": "GPIO3 / SCL (I2C)", "number": 5 }, "PIN_6": { @@ -96880,11 +94077,11 @@ "number": 6 }, "PIN_7": { - "description": "GPIO 4 / GPCLK0", + "description": "GPIO4", "number": 7 }, "PIN_8": { - "description": "GPIO 14 / TXD (UART)", + "description": "GPIO14 / TXD (UART)", "number": 8 }, "PIN_9": { @@ -96892,19 +94089,19 @@ "number": 9 }, "PIN_10": { - "description": "GPIO 15 / RXD (UART)", + "description": "GPIO15 / RXD (UART)", "number": 10 }, "PIN_11": { - "description": "GPIO 17", + "description": "GPIO17", "number": 11 }, "PIN_12": { - "description": "GPIO 18 / PCM_CLK", + "description": "GPIO18 / PCM_CLK", "number": 12 }, "PIN_13": { - "description": "GPIO 27", + "description": "GPIO27", "number": 13 }, "PIN_14": { @@ -96912,11 +94109,11 @@ "number": 14 }, "PIN_15": { - "description": "GPIO 22", + "description": "GPIO22", "number": 15 }, "PIN_16": { - "description": "GPIO 23", + "description": "GPIO23", "number": 16 }, "PIN_17": { @@ -96924,11 +94121,11 @@ "number": 17 }, "PIN_18": { - "description": "GPIO 24", + "description": "GPIO24", "number": 18 }, "PIN_19": { - "description": "GPIO 10 / MOSI (SPI)", + "description": "GPIO10 / MOSI (SPI)", "number": 19 }, "PIN_20": { @@ -96936,19 +94133,19 @@ "number": 20 }, "PIN_21": { - "description": "GPIO 9 / MISO (SPI)", + "description": "GPIO9 / MISO (SPI)", "number": 21 }, "PIN_22": { - "description": "GPIO 25", + "description": "GPIO25", "number": 22 }, "PIN_23": { - "description": "GPIO 11 / SCLK (SPI)", + "description": "GPIO11 / SCLK (SPI)", "number": 23 }, "PIN_24": { - "description": "GPIO 8 / CE0 (SPI)", + "description": "GPIO8 / CE0 (SPI)", "number": 24 }, "PIN_25": { @@ -96956,7 +94153,7 @@ "number": 25 }, "PIN_26": { - "description": "GPIO 7 / CE1 (SPI)", + "description": "GPIO7 / CE1 (SPI)", "number": 26 }, "PIN_27": { @@ -96968,7 +94165,7 @@ "number": 28 }, "PIN_29": { - "description": "GPIO 5", + "description": "GPIO5", "number": 29 }, "PIN_30": { @@ -96976,15 +94173,15 @@ "number": 30 }, "PIN_31": { - "description": "GPIO 6", + "description": "GPIO6", "number": 31 }, "PIN_32": { - "description": "GPIO 12 / PWM0", + "description": "GPIO12", "number": 32 }, "PIN_33": { - "description": "GPIO 13", + "description": "GPIO13", "number": 33 }, "PIN_34": { @@ -96992,19 +94189,19 @@ "number": 34 }, "PIN_35": { - "description": "GPIO 19 / MISO (PCM)", + "description": "GPIO19 / MISO (PCM)", "number": 35 }, "PIN_36": { - "description": "GPIO 16 / CE0 (PCM_FS)", + "description": "GPIO16 / CE0 (PCM)", "number": 36 }, "PIN_37": { - "description": "GPIO 26", + "description": "GPIO26", "number": 37 }, "PIN_38": { - "description": "GPIO 20 / MOSI (PCM_DIN)", + "description": "GPIO20 / MOSI (PCM)", "number": 38 }, "PIN_39": { @@ -97012,7 +94209,7 @@ "number": 39 }, "PIN_40": { - "description": "GPIO 21 / SCLK (PCM_DOUT)", + "description": "GPIO21 / SCLK (PCM)", "number": 40 } }, @@ -97020,8 +94217,8 @@ "group": "types" }, "signatures": { - "python": "public enum {GpioPin.pin_1 = 1, GpioPin.pin_2 = 2, GpioPin.pin_3 = 3, GpioPin.pin_4 = 4, GpioPin.pin_5 = 5, GpioPin.pin_6 = 6, GpioPin.pin_7 = 7, GpioPin.pin_8 = 8, GpioPin.pin_9 = 9, GpioPin.pin_10 = 10, GpioPin.pin_11 = 11, GpioPin.pin_12 = 12, GpioPin.pin_13 = 13, GpioPin.pin_14 = 14, GpioPin.pin_15 = 15, GpioPin.pin_16 = 16, GpioPin.pin_17 = 17, GpioPin.pin_18 = 18, GpioPin.pin_19 = 19, GpioPin.pin_20 = 20, GpioPin.pin_21 = 21, GpioPin.pin_22 = 22, GpioPin.pin_23 = 23, GpioPin.pin_24 = 24, GpioPin.pin_25 = 25, GpioPin.pin_26 = 26, GpioPin.pin_27 = 27, GpioPin.pin_28 = 28, GpioPin.pin_29 = 29, GpioPin.pin_30 = 30, GpioPin.pin_31 = 31, GpioPin.pin_32 = 32, GpioPin.pin_33 = 33, GpioPin.pin_34 = 34, GpioPin.pin_35 = 35, GpioPin.pin_36 = 36, GpioPin.pin_37 = 37, GpioPin.pin_38 = 38, GpioPin.pin_39 = 39, GpioPin.pin_40 = 40}", "cpp": "class gpio_pin {PIN_1 = 1, PIN_2 = 2, PIN_3 = 3, PIN_4 = 4, PIN_5 = 5, PIN_6 = 6, PIN_7 = 7, PIN_8 = 8, PIN_9 = 9, PIN_10 = 10, PIN_11 = 11, PIN_12 = 12, PIN_13 = 13, PIN_14 = 14, PIN_15 = 15, PIN_16 = 16, PIN_17 = 17, PIN_18 = 18, PIN_19 = 19, PIN_20 = 20, PIN_21 = 21, PIN_22 = 22, PIN_23 = 23, PIN_24 = 24, PIN_25 = 25, PIN_26 = 26, PIN_27 = 27, PIN_28 = 28, PIN_29 = 29, PIN_30 = 30, PIN_31 = 31, PIN_32 = 32, PIN_33 = 33, PIN_34 = 34, PIN_35 = 35, PIN_36 = 36, PIN_37 = 37, PIN_38 = 38, PIN_39 = 39, PIN_40 = 40};", + "python": "public enum {GpioPin.pin_1 = 1, GpioPin.pin_2 = 2, GpioPin.pin_3 = 3, GpioPin.pin_4 = 4, GpioPin.pin_5 = 5, GpioPin.pin_6 = 6, GpioPin.pin_7 = 7, GpioPin.pin_8 = 8, GpioPin.pin_9 = 9, GpioPin.pin_10 = 10, GpioPin.pin_11 = 11, GpioPin.pin_12 = 12, GpioPin.pin_13 = 13, GpioPin.pin_14 = 14, GpioPin.pin_15 = 15, GpioPin.pin_16 = 16, GpioPin.pin_17 = 17, GpioPin.pin_18 = 18, GpioPin.pin_19 = 19, GpioPin.pin_20 = 20, GpioPin.pin_21 = 21, GpioPin.pin_22 = 22, GpioPin.pin_23 = 23, GpioPin.pin_24 = 24, GpioPin.pin_25 = 25, GpioPin.pin_26 = 26, GpioPin.pin_27 = 27, GpioPin.pin_28 = 28, GpioPin.pin_29 = 29, GpioPin.pin_30 = 30, GpioPin.pin_31 = 31, GpioPin.pin_32 = 32, GpioPin.pin_33 = 33, GpioPin.pin_34 = 34, GpioPin.pin_35 = 35, GpioPin.pin_36 = 36, GpioPin.pin_37 = 37, GpioPin.pin_38 = 38, GpioPin.pin_39 = 39, GpioPin.pin_40 = 40}", "csharp": "public enum {GpioPin.Pin1 = 1, GpioPin.Pin2 = 2, GpioPin.Pin3 = 3, GpioPin.Pin4 = 4, GpioPin.Pin5 = 5, GpioPin.Pin6 = 6, GpioPin.Pin7 = 7, GpioPin.Pin8 = 8, GpioPin.Pin9 = 9, GpioPin.Pin10 = 10, GpioPin.Pin11 = 11, GpioPin.Pin12 = 12, GpioPin.Pin13 = 13, GpioPin.Pin14 = 14, GpioPin.Pin15 = 15, GpioPin.Pin16 = 16, GpioPin.Pin17 = 17, GpioPin.Pin18 = 18, GpioPin.Pin19 = 19, GpioPin.Pin20 = 20, GpioPin.Pin21 = 21, GpioPin.Pin22 = 22, GpioPin.Pin23 = 23, GpioPin.Pin24 = 24, GpioPin.Pin25 = 25, GpioPin.Pin26 = 26, GpioPin.Pin27 = 27, GpioPin.Pin28 = 28, GpioPin.Pin29 = 29, GpioPin.Pin30 = 30, GpioPin.Pin31 = 31, GpioPin.Pin32 = 32, GpioPin.Pin33 = 33, GpioPin.Pin34 = 34, GpioPin.Pin35 = 35, GpioPin.Pin36 = 36, GpioPin.Pin37 = 37, GpioPin.Pin38 = 38, GpioPin.Pin39 = 39, GpioPin.Pin40 = 40}", "pascal": "public enum {GpioPin.Pin1 = 1, GpioPin.Pin2 = 2, GpioPin.Pin3 = 3, GpioPin.Pin4 = 4, GpioPin.Pin5 = 5, GpioPin.Pin6 = 6, GpioPin.Pin7 = 7, GpioPin.Pin8 = 8, GpioPin.Pin9 = 9, GpioPin.Pin10 = 10, GpioPin.Pin11 = 11, GpioPin.Pin12 = 12, GpioPin.Pin13 = 13, GpioPin.Pin14 = 14, GpioPin.Pin15 = 15, GpioPin.Pin16 = 16, GpioPin.Pin17 = 17, GpioPin.Pin18 = 18, GpioPin.Pin19 = 19, GpioPin.Pin20 = 20, GpioPin.Pin21 = 21, GpioPin.Pin22 = 22, GpioPin.Pin23 = 23, GpioPin.Pin24 = 24, GpioPin.Pin25 = 25, GpioPin.Pin26 = 26, GpioPin.Pin27 = 27, GpioPin.Pin28 = 28, GpioPin.Pin29 = 29, GpioPin.Pin30 = 30, GpioPin.Pin31 = 31, GpioPin.Pin32 = 32, GpioPin.Pin33 = 33, GpioPin.Pin34 = 34, GpioPin.Pin35 = 35, GpioPin.Pin36 = 36, GpioPin.Pin37 = 37, GpioPin.Pin38 = 38, GpioPin.Pin39 = 39, GpioPin.Pin40 = 40}" } @@ -97073,8 +94270,8 @@ "group": "types" }, "signatures": { - "python": "public enum {GpioPinMode.gpio_input = 0, GpioPinMode.gpio_output = 1, GpioPinMode.gpio_alt0 = 4, GpioPinMode.gpio_alt1 = 5, GpioPinMode.gpio_alt2 = 6, GpioPinMode.gpio_alt3 = 7, GpioPinMode.gpio_alt4 = 3, GpioPinMode.gpio_alt5 = 2, GpioPinMode.gpio_default_mode = -1}", "cpp": "class gpio_pin_mode {GPIO_INPUT = 0, GPIO_OUTPUT = 1, GPIO_ALT0 = 4, GPIO_ALT1 = 5, GPIO_ALT2 = 6, GPIO_ALT3 = 7, GPIO_ALT4 = 3, GPIO_ALT5 = 2, GPIO_DEFAULT_MODE = -1};", + "python": "public enum {GpioPinMode.gpio_input = 0, GpioPinMode.gpio_output = 1, GpioPinMode.gpio_alt0 = 4, GpioPinMode.gpio_alt1 = 5, GpioPinMode.gpio_alt2 = 6, GpioPinMode.gpio_alt3 = 7, GpioPinMode.gpio_alt4 = 3, GpioPinMode.gpio_alt5 = 2, GpioPinMode.gpio_default_mode = -1}", "csharp": "public enum {GpioPinMode.GpioInput = 0, GpioPinMode.GpioOutput = 1, GpioPinMode.GpioAlt0 = 4, GpioPinMode.GpioAlt1 = 5, GpioPinMode.GpioAlt2 = 6, GpioPinMode.GpioAlt3 = 7, GpioPinMode.GpioAlt4 = 3, GpioPinMode.GpioAlt5 = 2, GpioPinMode.GpioDefaultMode = -1}", "pascal": "public enum {GpioPinMode.GpioInput = 0, GpioPinMode.GpioOutput = 1, GpioPinMode.GpioAlt0 = 4, GpioPinMode.GpioAlt1 = 5, GpioPinMode.GpioAlt2 = 6, GpioPinMode.GpioAlt3 = 7, GpioPinMode.GpioAlt4 = 3, GpioPinMode.GpioAlt5 = 2, GpioPinMode.GpioDefaultMode = -1}" } @@ -97102,8 +94299,8 @@ "group": "types" }, "signatures": { - "python": "public enum {GpioPinValue.gpio_default_value = -1, GpioPinValue.gpio_low = 0, GpioPinValue.gpio_high = 1}", "cpp": "class gpio_pin_value {GPIO_DEFAULT_VALUE = -1, GPIO_LOW = 0, GPIO_HIGH = 1};", + "python": "public enum {GpioPinValue.gpio_default_value = -1, GpioPinValue.gpio_low = 0, GpioPinValue.gpio_high = 1}", "csharp": "public enum {GpioPinValue.GpioDefaultValue = -1, GpioPinValue.GpioLow = 0, GpioPinValue.GpioHigh = 1}", "pascal": "public enum {GpioPinValue.GpioDefaultValue = -1, GpioPinValue.GpioLow = 0, GpioPinValue.GpioHigh = 1}" } @@ -97183,8 +94380,8 @@ "group": "types" }, "signatures": { - "python": "public enum {HttpStatusCode.http_status_ok = 200, HttpStatusCode.http_status_created = 201, HttpStatusCode.http_status_no_content = 204, HttpStatusCode.http_status_moved_permanently = 301, HttpStatusCode.http_status_found = 302, HttpStatusCode.http_status_see_other = 303, HttpStatusCode.http_status_bad_request = 400, HttpStatusCode.http_status_unauthorized = 401, HttpStatusCode.http_status_forbidden = 403, HttpStatusCode.http_status_not_found = 404, HttpStatusCode.http_status_method_not_allowed = 405, HttpStatusCode.http_status_request_timeout = 408, HttpStatusCode.http_status_conflict = 409, HttpStatusCode.http_status_internal_server_error = 500, HttpStatusCode.http_status_not_implemented = 501, HttpStatusCode.http_status_service_unavailable = 503}", "cpp": "class http_status_code {HTTP_STATUS_OK = 200, HTTP_STATUS_CREATED = 201, HTTP_STATUS_NO_CONTENT = 204, HTTP_STATUS_MOVED_PERMANENTLY = 301, HTTP_STATUS_FOUND = 302, HTTP_STATUS_SEE_OTHER = 303, HTTP_STATUS_BAD_REQUEST = 400, HTTP_STATUS_UNAUTHORIZED = 401, HTTP_STATUS_FORBIDDEN = 403, HTTP_STATUS_NOT_FOUND = 404, HTTP_STATUS_METHOD_NOT_ALLOWED = 405, HTTP_STATUS_REQUEST_TIMEOUT = 408, HTTP_STATUS_CONFLICT = 409, HTTP_STATUS_INTERNAL_SERVER_ERROR = 500, HTTP_STATUS_NOT_IMPLEMENTED = 501, HTTP_STATUS_SERVICE_UNAVAILABLE = 503};", + "python": "public enum {HttpStatusCode.http_status_ok = 200, HttpStatusCode.http_status_created = 201, HttpStatusCode.http_status_no_content = 204, HttpStatusCode.http_status_moved_permanently = 301, HttpStatusCode.http_status_found = 302, HttpStatusCode.http_status_see_other = 303, HttpStatusCode.http_status_bad_request = 400, HttpStatusCode.http_status_unauthorized = 401, HttpStatusCode.http_status_forbidden = 403, HttpStatusCode.http_status_not_found = 404, HttpStatusCode.http_status_method_not_allowed = 405, HttpStatusCode.http_status_request_timeout = 408, HttpStatusCode.http_status_conflict = 409, HttpStatusCode.http_status_internal_server_error = 500, HttpStatusCode.http_status_not_implemented = 501, HttpStatusCode.http_status_service_unavailable = 503}", "csharp": "public enum {HttpStatusCode.HttpStatusOk = 200, HttpStatusCode.HttpStatusCreated = 201, HttpStatusCode.HttpStatusNoContent = 204, HttpStatusCode.HttpStatusMovedPermanently = 301, HttpStatusCode.HttpStatusFound = 302, HttpStatusCode.HttpStatusSeeOther = 303, HttpStatusCode.HttpStatusBadRequest = 400, HttpStatusCode.HttpStatusUnauthorized = 401, HttpStatusCode.HttpStatusForbidden = 403, HttpStatusCode.HttpStatusNotFound = 404, HttpStatusCode.HttpStatusMethodNotAllowed = 405, HttpStatusCode.HttpStatusRequestTimeout = 408, HttpStatusCode.HttpStatusConflict = 409, HttpStatusCode.HttpStatusInternalServerError = 500, HttpStatusCode.HttpStatusNotImplemented = 501, HttpStatusCode.HttpStatusServiceUnavailable = 503}", "pascal": "public enum {HttpStatusCode.HttpStatusOk = 200, HttpStatusCode.HttpStatusCreated = 201, HttpStatusCode.HttpStatusNoContent = 204, HttpStatusCode.HttpStatusMovedPermanently = 301, HttpStatusCode.HttpStatusFound = 302, HttpStatusCode.HttpStatusSeeOther = 303, HttpStatusCode.HttpStatusBadRequest = 400, HttpStatusCode.HttpStatusUnauthorized = 401, HttpStatusCode.HttpStatusForbidden = 403, HttpStatusCode.HttpStatusNotFound = 404, HttpStatusCode.HttpStatusMethodNotAllowed = 405, HttpStatusCode.HttpStatusRequestTimeout = 408, HttpStatusCode.HttpStatusConflict = 409, HttpStatusCode.HttpStatusInternalServerError = 500, HttpStatusCode.HttpStatusNotImplemented = 501, HttpStatusCode.HttpStatusServiceUnavailable = 503}" } @@ -97224,56 +94421,12 @@ "group": "types" }, "signatures": { - "python": "public enum {InterfaceStyle.flat_dark_style = 0, InterfaceStyle.shaded_dark_style = 1, InterfaceStyle.flat_light_style = 2, InterfaceStyle.shaded_light_style = 3, InterfaceStyle.bubble = 4, InterfaceStyle.bubble_multicolored = 5}", "cpp": "class interface_style {FLAT_DARK_STYLE = 0, SHADED_DARK_STYLE = 1, FLAT_LIGHT_STYLE = 2, SHADED_LIGHT_STYLE = 3, BUBBLE = 4, BUBBLE_MULTICOLORED = 5};", + "python": "public enum {InterfaceStyle.flat_dark_style = 0, InterfaceStyle.shaded_dark_style = 1, InterfaceStyle.flat_light_style = 2, InterfaceStyle.shaded_light_style = 3, InterfaceStyle.bubble = 4, InterfaceStyle.bubble_multicolored = 5}", "csharp": "public enum {InterfaceStyle.FlatDarkStyle = 0, InterfaceStyle.ShadedDarkStyle = 1, InterfaceStyle.FlatLightStyle = 2, InterfaceStyle.ShadedLightStyle = 3, InterfaceStyle.Bubble = 4, InterfaceStyle.BubbleMulticolored = 5}", "pascal": "public enum {InterfaceStyle.FlatDarkStyle = 0, InterfaceStyle.ShadedDarkStyle = 1, InterfaceStyle.FlatLightStyle = 2, InterfaceStyle.ShadedLightStyle = 3, InterfaceStyle.Bubble = 4, InterfaceStyle.BubbleMulticolored = 5}" } }, - { - "signature": "enum motor_direction {MOTOR_FORWARD,MOTOR_BACKWARD};", - "name": "motor_direction", - "description": "Motor Movement Directions:", - "brief": null, - "constants": { - "MOTOR_FORWARD": { - "description": "Motor moves forward." - }, - "MOTOR_BACKWARD": { - "description": "Motor moves backward." - } - }, - "attributes": { - "group": "types" - }, - "signatures": { - "python": "public enum {MotorDirection.motor_forward = 0, MotorDirection.motor_backward = 0}", - "cpp": "class motor_direction {MOTOR_FORWARD = 0, MOTOR_BACKWARD = 0};", - "csharp": "public enum {MotorDirection.MotorForward = 0, MotorDirection.MotorBackward = 0}", - "pascal": "public enum {MotorDirection.MotorForward = 0, MotorDirection.MotorBackward = 0}" - } - }, - { - "signature": "enum motor_driver_type {L298N = 0,// L293D = 1,// TB6612FNG = 2,// DRV8835 = 3,// DRV8834 = 4,// DRV8825 = 5,// A4988 = 6,};", - "name": "motor_driver_type", - "description": "Motor Driver Types:", - "brief": null, - "constants": { - "L298N": { - "description": "Dual H-Bridge Motor Driver", - "number": 0 - } - }, - "attributes": { - "group": "types" - }, - "signatures": { - "python": "public enum {MotorDriverType.l298n = 0}", - "cpp": "class motor_driver_type {L298N = 0};", - "csharp": "public enum {MotorDriverType.L298n = 0}", - "pascal": "public enum {MotorDriverType.L298n = 0}" - } - }, { "signature": "enum pull_up_down {PUD_OFF = 0,PUD_DOWN = 1,PUD_UP = 2};", "name": "pull_up_down", @@ -97297,8 +94450,8 @@ "group": "types" }, "signatures": { - "python": "public enum {PullUpDown.pud_off = 0, PullUpDown.pud_down = 1, PullUpDown.pud_up = 2}", "cpp": "class pull_up_down {PUD_OFF = 0, PUD_DOWN = 1, PUD_UP = 2};", + "python": "public enum {PullUpDown.pud_off = 0, PullUpDown.pud_down = 1, PullUpDown.pud_up = 2}", "csharp": "public enum {PullUpDown.PudOff = 0, PullUpDown.PudDown = 1, PullUpDown.PudUp = 2}", "pascal": "public enum {PullUpDown.PudOff = 0, PullUpDown.PudDown = 1, PullUpDown.PudUp = 2}" } @@ -97349,12 +94502,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def base64_decode(input):" - ], "cpp": [ "string base64_decode(const string &input)" ], + "python": [ + "def base64_decode(input):" + ], "csharp": [ "public static string SplashKit.Base64Decode(string input);" ], @@ -97400,12 +94553,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def base64_encode(input):" - ], "cpp": [ "string base64_encode(const string &input)" ], + "python": [ + "def base64_encode(input):" + ], "csharp": [ "public static string SplashKit.Base64Encode(string input);" ], @@ -97451,12 +94604,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def bin_to_dec(bin):" - ], "cpp": [ "unsigned int bin_to_dec(const string &bin)" ], + "python": [ + "def bin_to_dec(bin):" + ], "csharp": [ "public static uint SplashKit.BinToDec(string bin);" ], @@ -97502,12 +94655,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def bin_to_hex(bin_str):" - ], "cpp": [ "string bin_to_hex(const string &bin_str)" ], + "python": [ + "def bin_to_hex(bin_str):" + ], "csharp": [ "public static string SplashKit.BinToHex(string binStr);" ], @@ -97553,12 +94706,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def bin_to_oct(bin_str):" - ], "cpp": [ "string bin_to_oct(const string &bin_str)" ], + "python": [ + "def bin_to_oct(bin_str):" + ], "csharp": [ "public static string SplashKit.BinToOct(string binStr);" ], @@ -97617,12 +94770,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def contains(text, subtext):" - ], "cpp": [ "bool contains(const string &text, const string &subtext)" ], + "python": [ + "def contains(text, subtext):" + ], "csharp": [ "public static bool SplashKit.Contains(string text, string subtext);" ], @@ -97668,12 +94821,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def convert_to_double(text):" - ], "cpp": [ "double convert_to_double(const string &text)" ], + "python": [ + "def convert_to_double(text):" + ], "csharp": [ "public static double SplashKit.ConvertToDouble(string text);" ], @@ -97719,12 +94872,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def convert_to_integer(text):" - ], "cpp": [ "int convert_to_integer(const string &text)" ], + "python": [ + "def convert_to_integer(text):" + ], "csharp": [ "public static int SplashKit.ConvertToInteger(string text);" ], @@ -97770,12 +94923,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def dec_to_bin(dec):" - ], "cpp": [ "string dec_to_bin(unsigned int dec)" ], + "python": [ + "def dec_to_bin(dec):" + ], "csharp": [ "public static string SplashKit.DecToBin(uint dec);" ], @@ -97821,12 +94974,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def dec_to_oct(decimal_value):" - ], "cpp": [ "string dec_to_oct(unsigned int decimal_value)" ], + "python": [ + "def dec_to_oct(decimal_value):" + ], "csharp": [ "public static string SplashKit.DecToOct(uint decimalValue);" ], @@ -97846,7 +94999,7 @@ "brief": "Calculates the greatest common divisor of two numbers", "return": { "type": "int", - "description": "Greatest common divisor of the two numbers, or 0 if both numbers are 0", + "description": "Greatest common divisor of the two numbers, or 0 if either of the numbers is not a valid integer above 0", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -97885,12 +95038,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def greatest_common_divisor(number1, number2):" - ], "cpp": [ "int greatest_common_divisor(int number1, int number2)" ], + "python": [ + "def greatest_common_divisor(number1, number2):" + ], "csharp": [ "public static int SplashKit.GreatestCommonDivisor(int number1, int number2);" ], @@ -97936,12 +95089,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def hex_to_bin(hex_str):" - ], "cpp": [ "string hex_to_bin(const string &hex_str)" ], + "python": [ + "def hex_to_bin(hex_str):" + ], "csharp": [ "public static string SplashKit.HexToBin(string hexStr);" ], @@ -97987,12 +95140,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def hex_to_dec(hex_string):" - ], "cpp": [ "unsigned int hex_to_dec(const string &hex_string)" ], + "python": [ + "def hex_to_dec(hex_string):" + ], "csharp": [ "public static uint SplashKit.HexToDec(string hexString);" ], @@ -98038,12 +95191,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def hex_to_oct(hex_str):" - ], "cpp": [ "string hex_to_oct(const string &hex_str)" ], + "python": [ + "def hex_to_oct(hex_str):" + ], "csharp": [ "public static string SplashKit.HexToOct(string hexStr);" ], @@ -98102,12 +95255,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def index_of(text, subtext):" - ], "cpp": [ "int index_of(const string &text, const string &subtext)" ], + "python": [ + "def index_of(text, subtext):" + ], "csharp": [ "public static int SplashKit.IndexOf(string text, string subtext);" ], @@ -98153,12 +95306,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def is_binary(bin_str):" - ], "cpp": [ "bool is_binary(const string &bin_str)" ], + "python": [ + "def is_binary(bin_str):" + ], "csharp": [ "public static bool SplashKit.IsBinary(string binStr);" ], @@ -98204,12 +95357,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def is_double(text):" - ], "cpp": [ "bool is_double(const string &text)" ], + "python": [ + "def is_double(text):" + ], "csharp": [ "public static bool SplashKit.IsDouble(string text);" ], @@ -98255,12 +95408,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def is_hex(hex_str):" - ], "cpp": [ "bool is_hex(const string &hex_str)" ], + "python": [ + "def is_hex(hex_str):" + ], "csharp": [ "public static bool SplashKit.IsHex(string hexStr);" ], @@ -98306,12 +95459,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def is_integer(text):" - ], "cpp": [ "bool is_integer(const string &text)" ], + "python": [ + "def is_integer(text):" + ], "csharp": [ "public static bool SplashKit.IsInteger(string text);" ], @@ -98357,12 +95510,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def is_number(text):" - ], "cpp": [ "bool is_number(const string &text)" ], + "python": [ + "def is_number(text):" + ], "csharp": [ "public static bool SplashKit.IsNumber(string text);" ], @@ -98408,12 +95561,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def is_octal(octal_str):" - ], "cpp": [ "bool is_octal(const string &octal_str)" ], + "python": [ + "def is_octal(octal_str):" + ], "csharp": [ "public static bool SplashKit.IsOctal(string octalStr);" ], @@ -98459,12 +95612,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def is_prime_number(number):" - ], "cpp": [ "bool is_prime_number(int number)" ], + "python": [ + "def is_prime_number(number):" + ], "csharp": [ "public static bool SplashKit.IsPrimeNumber(int number);" ], @@ -98484,7 +95637,7 @@ "brief": "Calculates the least common multiple of two numbers", "return": { "type": "int", - "description": "Least common multiple of the two numbers, or 0 if either of the numbers are 0", + "description": "Least common multiple of the two numbers, or 0 if either of the numbers is not a valid integer above 0", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -98523,12 +95676,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def least_common_multiple(number1, number2):" - ], "cpp": [ "int least_common_multiple(int number1, int number2)" ], + "python": [ + "def least_common_multiple(number1, number2):" + ], "csharp": [ "public static int SplashKit.LeastCommonMultiple(int number1, int number2);" ], @@ -98574,12 +95727,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def length_of(text):" - ], "cpp": [ "int length_of(const string &text)" ], + "python": [ + "def length_of(text):" + ], "csharp": [ "public static int SplashKit.LengthOf(string text);" ], @@ -98625,12 +95778,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def oct_to_bin(octal_str):" - ], "cpp": [ "string oct_to_bin(const string &octal_str)" ], + "python": [ + "def oct_to_bin(octal_str):" + ], "csharp": [ "public static string SplashKit.OctToBin(string octalStr);" ], @@ -98676,12 +95829,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def oct_to_dec(octal_string):" - ], "cpp": [ "unsigned int oct_to_dec(const string &octal_string)" ], + "python": [ + "def oct_to_dec(octal_string):" + ], "csharp": [ "public static uint SplashKit.OctToDec(string octalString);" ], @@ -98727,12 +95880,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def oct_to_hex(oct_str):" - ], "cpp": [ "string oct_to_hex(const string &oct_str)" ], + "python": [ + "def oct_to_hex(oct_str):" + ], "csharp": [ "public static string SplashKit.OctToHex(string octStr);" ], @@ -98804,12 +95957,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def replace_all(text, substr, new_text):" - ], "cpp": [ "string replace_all(const string &text, const string &substr, const string &new_text)" ], + "python": [ + "def replace_all(text, substr, new_text):" + ], "csharp": [ "public static string SplashKit.ReplaceAll(string text, string substr, string newText);" ], @@ -98868,12 +96021,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def split(text, delimiter):" - ], "cpp": [ "vector split(const string &text, char delimiter)" ], + "python": [ + "def split(text, delimiter):" + ], "csharp": [ "public static List SplashKit.Split(string text, char delimiter);" ], @@ -98919,83 +96072,32 @@ "static": "utilities" }, "signatures": { - "python": [ - "def square_root(number):" - ], "cpp": [ "double square_root(int number)" ], - "csharp": [ - "public static double SplashKit.SquareRoot(int number);" - ], - "pascal": [ - "function SquareRoot(number: Integer): Double" - ] - } - }, - { - "signature": "double to_double(const string &text);", - "name": "to_double", - "method_name": null, - "unique_global_name": "to_double", - "unique_method_name": null, - "suffix_name": null, - "description": "Convert the passed in string into a double. This can fail in an error if\nthe value is not a number, consider using `is_number` to check before\nconverting a string.", - "brief": null, - "return": { - "type": "double", - "description": "The double value read from the text.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "text": { - "type": "string", - "description": "The text to convert.", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "utilities", - "static": "utilities" - }, - "signatures": { "python": [ - "def to_double(text):" - ], - "cpp": [ - "double to_double(const string &text)" + "def square_root(number):" ], "csharp": [ - "public static double SplashKit.ToDouble(string text);" + "public static double SplashKit.SquareRoot(int number);" ], "pascal": [ - "function ToDouble(const text: String): Double" + "function SquareRoot(number: Integer): Double" ] } }, { - "signature": "int to_integer(const string &text);", - "name": "to_integer", + "signature": "string to_lowercase(const string &text);", + "name": "to_lowercase", "method_name": null, - "unique_global_name": "to_integer", + "unique_global_name": "to_lowercase", "unique_method_name": null, "suffix_name": null, - "description": "Convert the passed in string into an integer. This can fail in an error if\nthe value is not an integer, consider using `is_integer` to check before\nconverting a string.", + "description": "Return a lowercase version of the passed in string.", "brief": null, "return": { - "type": "int", - "description": "The integer value read from the text.", + "type": "string", + "description": "A lower case version of the passed in text.", "is_pointer": false, "is_reference": false, "is_vector": false, @@ -99021,63 +96123,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def to_integer(text):" - ], "cpp": [ - "int to_integer(const string &text)" - ], - "csharp": [ - "public static int SplashKit.ToInteger(string text);" + "string to_lowercase(const string &text)" ], - "pascal": [ - "function ToInteger(const text: String): Integer" - ] - } - }, - { - "signature": "string to_lowercase(const string &text);", - "name": "to_lowercase", - "method_name": null, - "unique_global_name": "to_lowercase", - "unique_method_name": null, - "suffix_name": null, - "description": "Return a lowercase version of the passed in string.", - "brief": null, - "return": { - "type": "string", - "description": "A lower case version of the passed in text.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "text": { - "type": "string", - "description": "The text to convert.", - "is_pointer": false, - "is_const": true, - "is_reference": true, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "group": "utilities", - "static": "utilities" - }, - "signatures": { "python": [ "def to_lowercase(text):" ], - "cpp": [ - "string to_lowercase(const string &text)" - ], "csharp": [ "public static string SplashKit.ToLowercase(string text);" ], @@ -99086,175 +96137,6 @@ ] } }, - { - "signature": "string to_string(double value,int precision);", - "name": "to_string", - "method_name": null, - "unique_global_name": "to_string_from_double_with_precision", - "unique_method_name": null, - "suffix_name": null, - "description": "Convert the passed in double to a string, restricting\nthe output the a given number of decimal places. For example\nif value is 3.14159265359 and precision is 2 then the output\nwill be \"3.14\".", - "brief": null, - "return": { - "type": "string", - "description": "string containing the double value.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "value": { - "type": "double", - "description": "the value to convert to a string.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - }, - "precision": { - "type": "int", - "description": "the number of decimal places to output.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "from_double_with_precision", - "group": "utilities", - "static": "utilities" - }, - "signatures": { - "python": [ - "def to_string_from_double_with_precision(value, precision):" - ], - "cpp": [ - "string to_string(double value, int precision)" - ], - "csharp": [ - "public static string SplashKit.ToString(double value, int precision);" - ], - "pascal": [ - "function ToString(value: Double; precision: Integer): String" - ] - } - }, - { - "signature": "string to_string(double value);", - "name": "to_string", - "method_name": null, - "unique_global_name": "to_string_from_double", - "unique_method_name": null, - "suffix_name": null, - "description": "Convert the passed in double to a string.", - "brief": null, - "return": { - "type": "string", - "description": "string containing the double value.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "value": { - "type": "double", - "description": "the value to convert to a string.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "from_double", - "group": "utilities", - "static": "utilities" - }, - "signatures": { - "python": [ - "def to_string_from_double(value):" - ], - "cpp": [ - "string to_string(double value)" - ], - "csharp": [ - "public static string SplashKit.ToString(double value);" - ], - "pascal": [ - "function ToString(value: Double): String" - ] - } - }, - { - "signature": "string to_string(int value);", - "name": "to_string", - "method_name": null, - "unique_global_name": "to_string_from_int", - "unique_method_name": null, - "suffix_name": null, - "description": "Convert the passed in integer to a string.", - "brief": null, - "return": { - "type": "string", - "description": "string containing the integer value.", - "is_pointer": false, - "is_reference": false, - "is_vector": false, - "type_parameter": null - }, - "parameters": { - "value": { - "type": "int", - "description": "the value to convert to a string.", - "is_pointer": false, - "is_const": false, - "is_reference": false, - "is_array": false, - "array_dimension_sizes": [ - - ], - "is_vector": false, - "type_parameter": null - } - }, - "attributes": { - "suffix": "from_int", - "group": "utilities", - "static": "utilities" - }, - "signatures": { - "python": [ - "def to_string_from_int(value):" - ], - "cpp": [ - "string to_string(int value)" - ], - "csharp": [ - "public static string SplashKit.ToString(int value);" - ], - "pascal": [ - "function ToString(value: Integer): String" - ] - } - }, { "signature": "string to_uppercase(const string &text);", "name": "to_uppercase", @@ -99292,12 +96174,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def to_uppercase(text):" - ], "cpp": [ "string to_uppercase(const string &text)" ], + "python": [ + "def to_uppercase(text):" + ], "csharp": [ "public static string SplashKit.ToUppercase(string text);" ], @@ -99343,12 +96225,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def trim(text):" - ], "cpp": [ "string trim(const string &text)" ], + "python": [ + "def trim(text):" + ], "csharp": [ "public static string SplashKit.Trim(string text);" ], @@ -99408,12 +96290,12 @@ "static": "random" }, "signatures": { - "python": [ - "def rnd_range(min, max):" - ], "cpp": [ "int rnd(int min, int max)" ], + "python": [ + "def rnd_range(min, max):" + ], "csharp": [ "public static int SplashKit.Rnd(int min, int max);" ], @@ -99446,12 +96328,12 @@ "static": "random" }, "signatures": { - "python": [ - "def rnd():" - ], "cpp": [ "float rnd()" ], + "python": [ + "def rnd():" + ], "csharp": [ "public static float SplashKit.Rnd();" ], @@ -99498,12 +96380,12 @@ "static": "random" }, "signatures": { - "python": [ - "def rnd_int(ubound):" - ], "cpp": [ "int rnd(int ubound)" ], + "python": [ + "def rnd_int(ubound):" + ], "csharp": [ "public static int SplashKit.Rnd(int ubound);" ], @@ -99536,12 +96418,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def current_ticks():" - ], "cpp": [ "unsigned int current_ticks()" ], + "python": [ + "def current_ticks():" + ], "csharp": [ "public static uint SplashKit.CurrentTicks();" ], @@ -99587,12 +96469,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def delay(milliseconds):" - ], "cpp": [ "void delay(int milliseconds)" ], + "python": [ + "def delay(milliseconds):" + ], "csharp": [ "public static void SplashKit.Delay(int milliseconds);" ], @@ -99677,12 +96559,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def display_dialog(title, msg, output_font, font_size):" - ], "cpp": [ "void display_dialog(const string &title, const string &msg, font output_font, int font_size)" ], + "python": [ + "def display_dialog(title, msg, output_font, font_size):" + ], "csharp": [ "public static void SplashKit.DisplayDialog(string title, string msg, Font outputFont, int fontSize);" ], @@ -99741,12 +96623,12 @@ "static": "utilities" }, "signatures": { - "python": [ - "def file_as_string(filename, kind):" - ], "cpp": [ "string file_as_string(string filename, resource_kind kind)" ], + "python": [ + "def file_as_string(filename, kind):" + ], "csharp": [ "public static string SplashKit.FileAsString(string filename, ResourceKind kind);" ], @@ -99826,12 +96708,12 @@ "self": "wind" }, "signatures": { - "python": [ - "def clear_window(wind, clr):" - ], "cpp": [ "void clear_window(window wind, color clr)" ], + "python": [ + "def clear_window(wind, clr):" + ], "csharp": [ "public void Window.Clear(Color clr);", "public static void SplashKit.ClearWindow(Window wind, Color clr);" @@ -99865,12 +96747,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def close_all_windows():" - ], "cpp": [ "void close_all_windows()" ], + "python": [ + "def close_all_windows():" + ], "csharp": [ "public static void SplashKit.CloseAllWindows();" ], @@ -99903,12 +96785,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def close_current_window():" - ], "cpp": [ "void close_current_window()" ], + "python": [ + "def close_current_window():" + ], "csharp": [ "public static void SplashKit.CloseCurrentWindow();" ], @@ -99955,12 +96837,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def close_window_named(name):" - ], "cpp": [ "void close_window(const string &name)" ], + "python": [ + "def close_window_named(name):" + ], "csharp": [ "public static void SplashKit.CloseWindow(string name);" ], @@ -100010,12 +96892,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def close_window(wind):" - ], "cpp": [ "void close_window(window wind)" ], + "python": [ + "def close_window(wind):" + ], "csharp": [ "public void Window.Close();", "public static void SplashKit.CloseWindow(Window wind);" @@ -100049,12 +96931,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def current_window():" - ], "cpp": [ "window current_window()" ], + "python": [ + "def current_window():" + ], "csharp": [ "public static Window SplashKit.CurrentWindow();" ], @@ -100087,12 +96969,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def current_window_has_border():" - ], "cpp": [ "bool current_window_has_border()" ], + "python": [ + "def current_window_has_border():" + ], "csharp": [ "public static bool SplashKit.CurrentWindowHasBorder();" ], @@ -100125,12 +97007,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def current_window_height():" - ], "cpp": [ "int current_window_height()" ], + "python": [ + "def current_window_height():" + ], "csharp": [ "public static int SplashKit.CurrentWindowHeight();" ], @@ -100163,12 +97045,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def current_window_is_fullscreen():" - ], "cpp": [ "bool current_window_is_fullscreen()" ], + "python": [ + "def current_window_is_fullscreen():" + ], "csharp": [ "public static bool SplashKit.CurrentWindowIsFullscreen();" ], @@ -100201,12 +97083,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def current_window_position():" - ], "cpp": [ "point_2d current_window_position()" ], + "python": [ + "def current_window_position():" + ], "csharp": [ "public static Point2D SplashKit.CurrentWindowPosition();" ], @@ -100239,12 +97121,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def current_window_toggle_border():" - ], "cpp": [ "void current_window_toggle_border()" ], + "python": [ + "def current_window_toggle_border():" + ], "csharp": [ "public static void SplashKit.CurrentWindowToggleBorder();" ], @@ -100277,12 +97159,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def current_window_toggle_fullscreen():" - ], "cpp": [ "void current_window_toggle_fullscreen()" ], + "python": [ + "def current_window_toggle_fullscreen():" + ], "csharp": [ "public static void SplashKit.CurrentWindowToggleFullscreen();" ], @@ -100315,12 +97197,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def current_window_width():" - ], "cpp": [ "int current_window_width()" ], + "python": [ + "def current_window_width():" + ], "csharp": [ "public static int SplashKit.CurrentWindowWidth();" ], @@ -100353,12 +97235,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def current_window_x():" - ], "cpp": [ "int current_window_x()" ], + "python": [ + "def current_window_x():" + ], "csharp": [ "public static int SplashKit.CurrentWindowX();" ], @@ -100391,12 +97273,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def current_window_y():" - ], "cpp": [ "int current_window_y()" ], + "python": [ + "def current_window_y():" + ], "csharp": [ "public static int SplashKit.CurrentWindowY();" ], @@ -100442,12 +97324,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def has_window(caption):" - ], "cpp": [ "bool has_window(string caption)" ], + "python": [ + "def has_window(caption):" + ], "csharp": [ "public static bool SplashKit.HasWindow(string caption);" ], @@ -100496,12 +97378,12 @@ "self": "wind" }, "signatures": { - "python": [ - "def is_current_window(wind):" - ], "cpp": [ "bool is_current_window(window wind)" ], + "python": [ + "def is_current_window(wind):" + ], "csharp": [ "public bool Window.IsCurrentWindow { get }", "public static bool SplashKit.IsCurrentWindow(Window wind);" @@ -100561,12 +97443,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def move_current_window_to(x, y):" - ], "cpp": [ "void move_current_window_to(int x, int y)" ], + "python": [ + "def move_current_window_to(x, y):" + ], "csharp": [ "public static void SplashKit.MoveCurrentWindowTo(int x, int y);" ], @@ -100639,12 +97521,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def move_window_to_named(name, x, y):" - ], "cpp": [ "void move_window_to(const string &name, int x, int y)" ], + "python": [ + "def move_window_to_named(name, x, y):" + ], "csharp": [ "public static void SplashKit.MoveWindowTo(string name, int x, int y);" ], @@ -100719,12 +97601,12 @@ "self": "wind" }, "signatures": { - "python": [ - "def move_window_to(wind, x, y):" - ], "cpp": [ "void move_window_to(window wind, int x, int y)" ], + "python": [ + "def move_window_to(wind, x, y):" + ], "csharp": [ "public void Window.MoveTo(int x, int y);", "public static void SplashKit.MoveWindowTo(Window wind, int x, int y);" @@ -100799,12 +97681,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def open_window(caption, width, height):" - ], "cpp": [ "window open_window(string caption, int width, int height)" ], + "python": [ + "def open_window(caption, width, height):" + ], "csharp": [ "public static Window SplashKit.OpenWindow(string caption, int width, int height);", "public Window(string caption, int width, int height);" @@ -100854,12 +97736,12 @@ "self": "wind" }, "signatures": { - "python": [ - "def refresh_window(wind):" - ], "cpp": [ "void refresh_window(window wind)" ], + "python": [ + "def refresh_window(wind):" + ], "csharp": [ "public void Window.Refresh();", "public static void SplashKit.RefreshWindow(Window wind);" @@ -100923,12 +97805,12 @@ "self": "wind" }, "signatures": { - "python": [ - "def refresh_window_with_target_fps(wind, target_fps):" - ], "cpp": [ "void refresh_window(window wind, unsigned int target_fps)" ], + "python": [ + "def refresh_window_with_target_fps(wind, target_fps):" + ], "csharp": [ "public void Window.Refresh(uint targetFps);", "public static void SplashKit.RefreshWindow(Window wind, uint targetFps);" @@ -100988,12 +97870,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def resize_current_window(width, height):" - ], "cpp": [ "void resize_current_window(int width, int height)" ], + "python": [ + "def resize_current_window(width, height):" + ], "csharp": [ "public static void SplashKit.ResizeCurrentWindow(int width, int height);" ], @@ -101068,12 +97950,12 @@ "self": "wnd" }, "signatures": { - "python": [ - "def resize_window(wnd, width, height):" - ], "cpp": [ "void resize_window(window wnd, int width, int height)" ], + "python": [ + "def resize_window(wnd, width, height):" + ], "csharp": [ "public void Window.Resize(int width, int height);", "public static void SplashKit.ResizeWindow(Window wnd, int width, int height);" @@ -101121,12 +98003,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def set_current_window_named(name):" - ], "cpp": [ "void set_current_window(const string &name)" ], + "python": [ + "def set_current_window_named(name):" + ], "csharp": [ "public static void SplashKit.SetCurrentWindow(string name);" ], @@ -101175,12 +98057,12 @@ "self": "wind" }, "signatures": { - "python": [ - "def set_current_window(wind):" - ], "cpp": [ "void set_current_window(window wind)" ], + "python": [ + "def set_current_window(wind):" + ], "csharp": [ "public void Window.MakeCurrent();", "public static void SplashKit.SetCurrentWindow(Window wind);" @@ -101230,12 +98112,12 @@ "self": "wind" }, "signatures": { - "python": [ - "def window_caption(wind):" - ], "cpp": [ "string window_caption(window wind)" ], + "python": [ + "def window_caption(wind):" + ], "csharp": [ "public string Window.Caption { get }", "public static string SplashKit.WindowCaption(Window wind);" @@ -101283,12 +98165,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def window_close_requested_named(name):" - ], "cpp": [ "bool window_close_requested(const string &name)" ], + "python": [ + "def window_close_requested_named(name):" + ], "csharp": [ "public static bool SplashKit.WindowCloseRequested(string name);" ], @@ -101337,12 +98219,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def window_close_requested(wind):" - ], "cpp": [ "bool window_close_requested(window wind)" ], + "python": [ + "def window_close_requested(wind):" + ], "csharp": [ "public bool Window.CloseRequested { get }", "public static bool SplashKit.WindowCloseRequested(Window wind);" @@ -101390,12 +98272,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def window_has_border_named(name):" - ], "cpp": [ "bool window_has_border(const string &name)" ], + "python": [ + "def window_has_border_named(name):" + ], "csharp": [ "public static bool SplashKit.WindowHasBorder(string name);" ], @@ -101444,12 +98326,12 @@ "self": "wnd" }, "signatures": { - "python": [ - "def window_has_border(wnd):" - ], "cpp": [ "bool window_has_border(window wnd)" ], + "python": [ + "def window_has_border(wnd):" + ], "csharp": [ "public bool Window.HasBorder { get }", "public static bool SplashKit.WindowHasBorder(Window wnd);" @@ -101499,12 +98381,12 @@ "self": "wind" }, "signatures": { - "python": [ - "def window_has_focus(wind):" - ], "cpp": [ "bool window_has_focus(window wind)" ], + "python": [ + "def window_has_focus(wind):" + ], "csharp": [ "public bool Window.HasFocus { get }", "public static bool SplashKit.WindowHasFocus(Window wind);" @@ -101552,12 +98434,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def window_height_named(name):" - ], "cpp": [ "int window_height(const string &name)" ], + "python": [ + "def window_height_named(name):" + ], "csharp": [ "public static int SplashKit.WindowHeight(string name);" ], @@ -101606,12 +98488,12 @@ "self": "wind" }, "signatures": { - "python": [ - "def window_height(wind):" - ], "cpp": [ "int window_height(window wind)" ], + "python": [ + "def window_height(wind):" + ], "csharp": [ "public int Window.Height { get }", "public static int SplashKit.WindowHeight(Window wind);" @@ -101659,12 +98541,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def window_is_fullscreen_named(name):" - ], "cpp": [ "bool window_is_fullscreen(const string &name)" ], + "python": [ + "def window_is_fullscreen_named(name):" + ], "csharp": [ "public static bool SplashKit.WindowIsFullscreen(string name);" ], @@ -101713,12 +98595,12 @@ "self": "wnd" }, "signatures": { - "python": [ - "def window_is_fullscreen(wnd):" - ], "cpp": [ "bool window_is_fullscreen(window wnd)" ], + "python": [ + "def window_is_fullscreen(wnd):" + ], "csharp": [ "public bool Window.IsFullscreen { get }", "public static bool SplashKit.WindowIsFullscreen(Window wnd);" @@ -101765,12 +98647,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def window_named(caption):" - ], "cpp": [ "window window_named(string caption)" ], + "python": [ + "def window_named(caption):" + ], "csharp": [ "public static Window SplashKit.WindowNamed(string caption);" ], @@ -101817,12 +98699,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def window_position_named(name):" - ], "cpp": [ "point_2d window_position(const string &name)" ], + "python": [ + "def window_position_named(name):" + ], "csharp": [ "public static Point2D SplashKit.WindowPosition(string name);" ], @@ -101871,12 +98753,12 @@ "self": "wnd" }, "signatures": { - "python": [ - "def window_position(wnd):" - ], "cpp": [ "point_2d window_position(window wnd)" ], + "python": [ + "def window_position(wnd):" + ], "csharp": [ "public Point2D Window.Position { get }", "public static Point2D SplashKit.WindowPosition(Window wnd);" @@ -101939,12 +98821,12 @@ "self": "wind" }, "signatures": { - "python": [ - "def window_set_icon(wind, bmp):" - ], "cpp": [ "void window_set_icon(window wind, bitmap bmp)" ], + "python": [ + "def window_set_icon(wind, bmp):" + ], "csharp": [ "public void Window.Icon { set }", "public static void SplashKit.WindowSetIcon(Window wind, Bitmap bmp);" @@ -101992,12 +98874,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def window_toggle_border_named(name):" - ], "cpp": [ "void window_toggle_border(const string &name)" ], + "python": [ + "def window_toggle_border_named(name):" + ], "csharp": [ "public static void SplashKit.WindowToggleBorder(string name);" ], @@ -102046,12 +98928,12 @@ "self": "wnd" }, "signatures": { - "python": [ - "def window_toggle_border(wnd):" - ], "cpp": [ "void window_toggle_border(window wnd)" ], + "python": [ + "def window_toggle_border(wnd):" + ], "csharp": [ "public void Window.ToggleBorder();", "public static void SplashKit.WindowToggleBorder(Window wnd);" @@ -102099,12 +98981,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def window_toggle_fullscreen_named(name):" - ], "cpp": [ "void window_toggle_fullscreen(const string &name)" ], + "python": [ + "def window_toggle_fullscreen_named(name):" + ], "csharp": [ "public static void SplashKit.WindowToggleFullscreen(string name);" ], @@ -102153,12 +99035,12 @@ "self": "wnd" }, "signatures": { - "python": [ - "def window_toggle_fullscreen(wnd):" - ], "cpp": [ "void window_toggle_fullscreen(window wnd)" ], + "python": [ + "def window_toggle_fullscreen(wnd):" + ], "csharp": [ "public void Window.ToggleFullscreen();", "public static void SplashKit.WindowToggleFullscreen(Window wnd);" @@ -102206,12 +99088,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def window_width_named(name):" - ], "cpp": [ "int window_width(const string &name)" ], + "python": [ + "def window_width_named(name):" + ], "csharp": [ "public static int SplashKit.WindowWidth(string name);" ], @@ -102260,12 +99142,12 @@ "self": "wind" }, "signatures": { - "python": [ - "def window_width(wind):" - ], "cpp": [ "int window_width(window wind)" ], + "python": [ + "def window_width(wind):" + ], "csharp": [ "public int Window.Width { get }", "public static int SplashKit.WindowWidth(Window wind);" @@ -102299,12 +99181,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def window_with_focus():" - ], "cpp": [ "window window_with_focus()" ], + "python": [ + "def window_with_focus():" + ], "csharp": [ "public static Window SplashKit.WindowWithFocus();" ], @@ -102351,12 +99233,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def window_x_named(name):" - ], "cpp": [ "int window_x(const string &name)" ], + "python": [ + "def window_x_named(name):" + ], "csharp": [ "public static int SplashKit.WindowX(string name);" ], @@ -102405,12 +99287,12 @@ "self": "wnd" }, "signatures": { - "python": [ - "def window_x(wnd):" - ], "cpp": [ "int window_x(window wnd)" ], + "python": [ + "def window_x(wnd):" + ], "csharp": [ "public int Window.X { get }", "public static int SplashKit.WindowX(Window wnd);" @@ -102458,12 +99340,12 @@ "static": "window_manager" }, "signatures": { - "python": [ - "def window_y_named(name):" - ], "cpp": [ "int window_y(const string &name)" ], + "python": [ + "def window_y_named(name):" + ], "csharp": [ "public static int SplashKit.WindowY(string name);" ], @@ -102512,12 +99394,12 @@ "self": "wnd" }, "signatures": { - "python": [ - "def window_y(wnd):" - ], "cpp": [ "int window_y(window wnd)" ], + "python": [ + "def window_y(wnd):" + ], "csharp": [ "public int Window.Y { get }", "public static int SplashKit.WindowY(Window wnd);" diff --git a/scripts/json-files/guides-groups.json b/scripts/json-files/guides-groups.json index 7fe7bccde..36a7e3fb5 100644 --- a/scripts/json-files/guides-groups.json +++ b/scripts/json-files/guides-groups.json @@ -2,9 +2,9 @@ "animations", "audio", "beyond-splashkit", - "camera", + "Camera", "color", - "graphics", + "Graphics", "input", "interface", "json", diff --git a/scripts/json-files/usage-example-references.json b/scripts/json-files/usage-example-references.json index c41688ec6..e25f0e863 100644 --- a/scripts/json-files/usage-example-references.json +++ b/scripts/json-files/usage-example-references.json @@ -2,7 +2,7 @@ "audio": [ { "funcKey": "play_music_named", - "title": "Music Playback", + "title": "Music Playback\r", "url": "/api/audio/#play-music-named", "functions": [ "audio_ready", @@ -14,7 +14,7 @@ }, { "funcKey": "resume_music", - "title": "Pausing and Resuming Game Music", + "title": "Pausing and Resuming Game Music\r", "url": "/api/audio/#resume-music", "functions": [ "audio_ready", @@ -38,6 +38,31 @@ ] } ], + "color": [ + { + "funcKey": "saturation_of", + "title": "Draws a rectangle in a random colour. The colour's saturation value is displayed on screen", + "url": "/api/color/#saturation-of", + "functions": [ + "open_window", + "random_rgb_color", + "round", + "rectangle_from", + "clear_screen", + "color_white", + "fill_rectangle_record", + "draw_text_no_font_no_size", + "color_black", + "red_of", + "green_of", + "blue_of", + "alpha_of", + "refresh_screen", + "delay", + "close_all_windows" + ] + } + ], "geometry": [ { "funcKey": "center_point", @@ -142,7 +167,7 @@ }, { "funcKey": "closest_point_on_circle", - "title": "Closest Point to Mouse on Circle", + "title": "Closest Point to Mouse on Circle\r", "url": "/api/geometry/#closest-point-on-circle", "functions": [ "open_window", @@ -161,6 +186,25 @@ "close_all_windows" ] }, + { + "funcKey": "lines_intersect", + "title": "Simple Line Intersect Check", + "url": "/api/geometry/#lines-intersect", + "functions": [ + "open_window", + "Point2D", + "line_from_point_to_point", + "draw_line_record", + "color_red", + "draw_text_no_font_no_size", + "color_black", + "color_blue", + "color_green", + "refresh_screen", + "delay", + "close_all_windows" + ] + }, { "funcKey": "line_intersects_rect", "title": "Avoid the Rectangle", @@ -256,25 +300,6 @@ "close_all_windows" ] }, - { - "funcKey": "lines_intersect", - "title": "Simple Line Intersect Check", - "url": "/api/geometry/#lines-intersect", - "functions": [ - "open_window", - "Point2D", - "line_from_point_to_point", - "draw_line_record", - "color_red", - "draw_text_no_font_no_size", - "color_black", - "color_blue", - "color_green", - "refresh_screen", - "delay", - "close_all_windows" - ] - }, { "funcKey": "point_at", "title": "Flower Grid", @@ -508,7 +533,7 @@ }, { "funcKey": "random_window_point", - "title": "Random Portals", + "title": "Random Portals\r", "url": "/api/geometry/#random-window-point", "functions": [ "open_window", @@ -524,6 +549,32 @@ "close_window" ] }, + { + "funcKey": "rectangle_around", + "title": "A perpetually moving circle which increases and decreases in size, surrounded by a rectangle shape", + "url": "/api/geometry/#rectangle-around", + "functions": [ + "open_window", + "create_timer", + "start_timer", + "quit_requested", + "point_at", + "cosine", + "sine", + "circle_at", + "timer_ticks", + "reset_timer", + "process_events", + "clear_screen_to_white", + "draw_rectangle_record", + "color_black", + "rectangle_around_circle", + "fill_circle_record", + "color_red", + "refresh_screen", + "close_all_windows" + ] + }, { "funcKey": "same_point", "title": "Point 2D Guessing Game", @@ -561,6 +612,24 @@ "close_all_windows" ] }, + { + "funcKey": "bitmap_center", + "title": "Draw a bitmap with a red dot at its center\r", + "url": "/api/graphics/#bitmap-center", + "functions": [ + "open_window", + "load_bitmap", + "clear_screen", + "color_white", + "draw_bitmap", + "fill_circle_record", + "color_red", + "circle_at", + "refresh_screen", + "delay", + "close_all_windows" + ] + }, { "funcKey": "clear_screen", "title": "Background Color", @@ -575,7 +644,7 @@ }, { "funcKey": "draw_bitmap_named", - "title": "SplashKit Logo", + "title": "SplashKit Logo\r", "url": "/api/graphics/#draw-bitmap-named", "functions": [ "open_window", @@ -597,6 +666,26 @@ "SplashKit" ] }, + { + "funcKey": "draw_circle", + "title": "Circle Showcase\r", + "url": "/api/graphics/#draw-circle", + "functions": [ + "open_window", + "clear_screen", + "color_white", + "fill_circle", + "color_red", + "color_blue", + "color_green", + "color_orange", + "color_purple", + "random_rgb_color", + "refresh_screen", + "delay", + "close_all_windows" + ] + }, { "funcKey": "draw_circle_on_bitmap", "title": "Creating a Red Planet", @@ -1041,7 +1130,7 @@ }, { "funcKey": "fill_rectangle_on_bitmap", - "title": "Cityscape", + "title": "Cityscape\r", "url": "/api/graphics/#fill-rectangle-on-bitmap", "functions": [ "open_window", @@ -1112,7 +1201,7 @@ }, { "funcKey": "fill_triangle_on_bitmap", - "title": "Hooray! A Red Hat", + "title": "Hooray! A Red Hat\r", "url": "/api/graphics/#fill-triangle-on-bitmap", "functions": [ "open_window", @@ -1172,7 +1261,7 @@ }, { "funcKey": "free_font", - "title": "Freeing Fonts", + "title": "Freeing Fonts\r", "url": "/api/graphics/#free-font", "functions": [ "open_window", @@ -1189,6 +1278,25 @@ "close_all_windows" ] }, + { + "funcKey": "get_font_style", + "title": "The program automatically cycles through font styles for a given font (also displaying example text), with the numerical value of each style being shown on screen\r", + "url": "/api/graphics/#get-font-style", + "functions": [ + "open_window", + "font_named", + "quit_requested", + "process_events", + "set_font_style", + "clear_screen_to_white", + "draw_text_no_font_no_size", + "color_black", + "draw_text", + "refresh_screen", + "delay", + "close_all_windows" + ] + }, { "funcKey": "has_font", "title": "Checking for Font using Variable", @@ -1211,7 +1319,7 @@ }, { "funcKey": "load_font", - "title": "Using Fonts", + "title": "Using Fonts\r", "url": "/api/graphics/#load-font", "functions": [ "open_window", @@ -1242,7 +1350,7 @@ }, { "funcKey": "text_width_font_named", - "title": "Underline Text using Text Width", + "title": "Underline Text using Text Width\r", "url": "/api/graphics/#text-width-font-named", "functions": [ "open_window", @@ -1303,7 +1411,7 @@ "physics": [ { "funcKey": "sprite_bitmap_collision", - "title": "Does SplashKit have bugs?", + "title": "Does SplashKit have bugs?\r", "url": "/api/physics/#sprite-bitmap-collision", "functions": [ "open_window", @@ -1323,7 +1431,7 @@ }, { "funcKey": "sprite_collision", - "title": "Colliding Sprites", + "title": "Colliding Sprites\r", "url": "/api/physics/#sprite-collision", "functions": [ "open_window", @@ -1342,7 +1450,7 @@ }, { "funcKey": "sprite_point_collision", - "title": "Determine Sprite Collisions with Points", + "title": "Determine Sprite Collisions with Points\r", "url": "/api/physics/#sprite-point-collision", "functions": [ "open_window", @@ -1365,7 +1473,7 @@ }, { "funcKey": "sprite_rectangle_collision", - "title": "Detect Sprite Collisions with Rectangles", + "title": "Detect Sprite Collisions with Rectangles\r", "url": "/api/physics/#sprite-rectangle-collision", "functions": [ "open_window", @@ -1390,7 +1498,7 @@ "raspberry": [ { "funcKey": "raspi_i2c_write_data", - "title": "LED Text Scrolling", + "title": "LED Text Scrolling\r", "url": "/api/raspberry/#raspi-i2c-write-data", "functions": [ "write_line", @@ -1407,7 +1515,7 @@ "sprites": [ { "funcKey": "create_sprite", - "title": "Creating a Player Sprite", + "title": "Creating a Player Sprite\r", "url": "/api/sprites/#create-sprite", "functions": [ "open_window", @@ -1425,7 +1533,7 @@ }, { "funcKey": "draw_sprite", - "title": "Drawing a Player Sprite", + "title": "Drawing a Player Sprite\r", "url": "/api/sprites/#draw-sprite", "functions": [ "open_window", @@ -1443,7 +1551,7 @@ }, { "funcKey": "free_sprite", - "title": "Freeing a Sprite", + "title": "Freeing a Sprite\r", "url": "/api/sprites/#free-sprite", "functions": [ "open_window", @@ -1465,7 +1573,7 @@ }, { "funcKey": "sprite_set_position", - "title": "Setting Sprite Position", + "title": "Setting Sprite Position\r", "url": "/api/sprites/#sprite-set-position", "functions": [ "open_window", @@ -1485,7 +1593,7 @@ }, { "funcKey": "sprite_set_velocity", - "title": "Setting Velocity of Sprite", + "title": "Setting Velocity of Sprite\r", "url": "/api/sprites/#sprite-set-velocity", "functions": [ "open_window", @@ -1507,7 +1615,7 @@ }, { "funcKey": "sprite_set_x", - "title": "Setting Sprite X-coordinate", + "title": "Setting Sprite X-coordinate\r", "url": "/api/sprites/#sprite-set-x", "functions": [ "open_window", @@ -1524,7 +1632,7 @@ }, { "funcKey": "sprite_set_y", - "title": "Setting Sprite Y-coordinate", + "title": "Setting Sprite Y-coordinate\r", "url": "/api/sprites/#sprite-set-y", "functions": [ "open_window", @@ -1541,7 +1649,7 @@ }, { "funcKey": "sprite_x", - "title": "Sprite x-coordinate", + "title": "Sprite x-coordinate\r", "url": "/api/sprites/#sprite-x", "functions": [ "open_window", @@ -1561,7 +1669,7 @@ }, { "funcKey": "sprite_y", - "title": "Sprite y-coordinate", + "title": "Sprite y-coordinate\r", "url": "/api/sprites/#sprite-y", "functions": [ "open_window", @@ -1673,7 +1781,7 @@ }, { "funcKey": "current_ticks", - "title": "How many ticks?", + "title": "How many ticks?\r", "url": "/api/utilities/#current-ticks", "functions": [ "write_line", @@ -1790,5 +1898,30 @@ "write_line" ] } + ], + "windows": [ + { + "funcKey": "close_window", + "title": "Starts a countdown to close the window at the push of a button.", + "url": "/api/windows/#close-window", + "functions": [ + "open_window", + "create_timer", + "quit_requested", + "process_events", + "clear_window", + "color_white", + "button_at_position", + "rectangle_from", + "start_timer", + "draw_text_font_as_string", + "color_black", + "timer_ticks", + "reset_timer", + "draw_interface", + "refresh_window", + "close_all_windows" + ] + } ] } \ No newline at end of file diff --git a/scripts/usage-example-scraping.cjs b/scripts/usage-example-scraping.cjs index 0ec5376cf..a05361681 100644 --- a/scripts/usage-example-scraping.cjs +++ b/scripts/usage-example-scraping.cjs @@ -43,6 +43,12 @@ function getAvailableExamplesFunctionUsage(dir) { try { const folderKey = folder.toLowerCase(); + + // Skip generative_ai examples (no API docs yet) + if (folderKey === "generative_ai") { + return; + } + const funcKey = pyFileMatch[1].toLowerCase(); if (!result[folderKey]) { diff --git a/src/components/starlight/ThemeSelect.astro b/src/components/starlight/ThemeSelect.astro new file mode 100644 index 000000000..d08ff8955 --- /dev/null +++ b/src/components/starlight/ThemeSelect.astro @@ -0,0 +1,121 @@ +--- +--- + + +
+ + +
+ + + + + + + diff --git a/src/content/docs/guides/interface/getting-started-with-interfaces.mdx b/src/content/docs/guides/interface/getting-started-with-interfaces.mdx index 3027d666b..1150d6794 100644 --- a/src/content/docs/guides/interface/getting-started-with-interfaces.mdx +++ b/src/content/docs/guides/interface/getting-started-with-interfaces.mdx @@ -548,11 +548,15 @@ Now let's try out some more interesting elements - let's add a text box, so we c -2. Now let's add the text box. We can use the [Text Box](/api/interface/#text-box) function, which takes a string - the current text, and a position - where to draw it. +2. Now let's add the text box. We can use the [Text Box](/api/interface/#text-box) function, which takes two strings - a label/identifier and the current text, and a position - where to draw it. It then _returns_ the updated text - if the user hasn't typed anything, this will be the same text that was passed in. But if the user _has_ typed something, this will be our new text, and we can store it in the variable! - For example, `user_text = text_box(user_text, rectangle_from(0,0,200,24));` would show a text box at the top-right corner of the screen, with the text that's in the variable `user_text`, and if the user has _altered_ the text, it would return the new text and store it back into `user_text`. + For example, `user_text = text_box("user_text", user_text, rectangle_from(0, 0, 200, 24));` would show a text box at the top-right corner of the screen, with the text that's in the variable `user_text`, and if the user has _altered_ the text, it would return the new text and store it back into `user_text`. + + :::tip[Identifiers / Labels] + The first parameter passes in the identifier/label for the textbox. SplashKit uses this to identifity the text when you edit it. We used the variable name as the string here, but you can use any unique identifier. + ::: Finally, we can use this variable in our [Write Line](/api/terminal/#write-line), to write the user's text to the console. @@ -562,7 +566,7 @@ Now let's try out some more interesting elements - let's add a text box, so we c ```cpp ins={1} ins="write_line(user_message);" - user_message = text_box(user_message, rectangle_from(300, 220, 200, 24)); + user_message = text_box("user_message", user_message, rectangle_from(300, 220, 200, 24)); if (button("Write To Terminal!", rectangle_from(300, 260, 200, 24))) { @@ -577,7 +581,7 @@ Now let's try out some more interesting elements - let's add a text box, so we c ```csharp ins={1} ins="WriteLine(userMessage);" - userMessage = TextBox(userMessage, RectangleFrom(300, 220, 200, 24)); + userMessage = TextBox("user_message", userMessage, RectangleFrom(300, 220, 200, 24)); if (Button("Write To Terminal!", RectangleFrom(300, 260, 200, 24))) { @@ -589,7 +593,7 @@ Now let's try out some more interesting elements - let's add a text box, so we c ```csharp ins={1} ins="SplashKit.WriteLine(userMessage);" - userMessage = SplashKit.TextBox(userMessage, SplashKit.RectangleFrom(300, 220, 200, 24)); + userMessage = SplashKit.TextBox("user_message", userMessage, SplashKit.RectangleFrom(300, 220, 200, 24)); // Check if the button is clicked if (SplashKit.Button("Write To Terminal!", SplashKit.RectangleFrom(300, 260, 200, 24))) @@ -605,7 +609,7 @@ Now let's try out some more interesting elements - let's add a text box, so we c ```python ins={1} ins="write_line(user_message)" - user_message = text_box_at_position(user_message, rectangle_from(300, 220, 200, 24)) + user_message = text_box_at_position("user_message", user_message, rectangle_from(300, 220, 200, 24)) if button_at_position("Write To Terminal!", rectangle_from(300, 260, 200, 24)): write_line(user_message) @@ -655,7 +659,7 @@ int main() clear_screen(COLOR_WHITE); // interface! - user_message = text_box(user_message, rectangle_from(300, 220, 200, 24)); + user_message = text_box("user_message", user_message, rectangle_from(300, 220, 200, 24)); if (button("Write To Terminal!", rectangle_from(300, 260, 200, 24))) { @@ -700,7 +704,7 @@ while (!QuitRequested()) ClearScreen(ColorWhite()); // interface! - userMessage = TextBox(userMessage, RectangleFrom(300, 220, 200, 24)); + userMessage = TextBox("userMessage", userMessage, RectangleFrom(300, 220, 200, 24)); if (Button("Write To Terminal!", RectangleFrom(300, 260, 200, 24))) { @@ -744,7 +748,7 @@ namespace CreatingUserInterfaces window.Clear(Color.White); // interface! - userMessage = SplashKit.TextBox(userMessage, SplashKit.RectangleFrom(300, 220, 200, 24)); + userMessage = SplashKit.TextBox("userMessage", userMessage, SplashKit.RectangleFrom(300, 220, 200, 24)); if (SplashKit.Button("Write To Terminal!", SplashKit.RectangleFrom(300, 260, 200, 24))) { @@ -787,7 +791,7 @@ while (not quit_requested()): clear_screen_to_white() # interface! - user_message = text_box_at_position(user_message, rectangle_from(300, 220, 200, 24)) + user_message = text_box_at_position("user_message", user_message, rectangle_from(300, 220, 200, 24)) if button_at_position("Write To Terminal!", rectangle_from(300, 260, 200, 24)): write_line(user_message) @@ -839,7 +843,7 @@ int main() clear_screen(COLOR_WHITE); // interface! - user_message = text_box(user_message, rectangle_from(400 - width/2, 220, width, 24)); + user_message = text_box("user_message", user_message, rectangle_from(400 - width/2, 220, width, 24)); if (button("Write To Terminal!", rectangle_from(400 - width/2, 260, width, 24))) { @@ -886,7 +890,7 @@ while (!QuitRequested()) ClearScreen(ColorWhite()); // interface! - userMessage = TextBox(userMessage, RectangleFrom(400 - width/2, 220, width, 24)); + userMessage = TextBox("userMessage", userMessage, RectangleFrom(400 - width/2, 220, width, 24)); if (Button("Write To Terminal!", RectangleFrom(400 - width/2, 260, width, 24))) { @@ -933,7 +937,7 @@ namespace CreatingUserInterfaces window.Clear(Color.White); // interface! - userMessage = SplashKit.TextBox(userMessage, SplashKit.RectangleFrom(400 - width / 2, 220, width, 24)); + userMessage = SplashKit.TextBox("userMessage", userMessage, SplashKit.RectangleFrom(400 - width / 2, 220, width, 24)); if (SplashKit.Button("Write To Terminal!", SplashKit.RectangleFrom(400 - width / 2, 260, width, 24))) { @@ -979,7 +983,7 @@ while (not quit_requested()): clear_screen_to_white() # interface - user_message = text_box_at_position(user_message, rectangle_from(400 - width/2, 220, width, 24)) + user_message = text_box_at_position("user_message", user_message, rectangle_from(400 - width/2, 220, width, 24)) if button_at_position("Write To Terminal!", rectangle_from(400 - width/2, 260, width, 24)): write_line(user_message) @@ -1032,7 +1036,7 @@ int main() clear_screen(COLOR_WHITE); // interface! - user_message = text_box(user_message, rectangle_from(400 - width/2, 220, width, 24)); + user_message = text_box("user_message", user_message, rectangle_from(400 - width/2, 220, width, 24)); if (button("Write To Terminal!", rectangle_from(400 - width/2, 260, width, 24))) { @@ -1079,7 +1083,7 @@ while (!QuitRequested()) ClearScreen(ColorWhite()); // interface! - userMessage = TextBox(userMessage, RectangleFrom(400 - width/2, 220, width, 24)); + userMessage = TextBox("userMessage", userMessage, RectangleFrom(400 - width/2, 220, width, 24)); if (Button("Write To Terminal!", RectangleFrom(400 - width/2, 260, width, 24))) { @@ -1126,7 +1130,7 @@ namespace CreatingUserInterfaces window.Clear(Color.White); // interface! - userMessage = SplashKit.TextBox(userMessage, SplashKit.RectangleFrom(400 - width / 2, 220, width, 24)); + userMessage = SplashKit.TextBox("userMessage", userMessage, SplashKit.RectangleFrom(400 - width / 2, 220, width, 24)); if (SplashKit.Button("Write To Terminal!", SplashKit.RectangleFrom(400 - width / 2, 260, width, 24))) { @@ -1172,7 +1176,7 @@ while (not quit_requested()): clear_screen_to_white() # interface - user_message = text_box_at_position(user_message, rectangle_from(400 - width/2, 220, width, 24)) + user_message = text_box_at_position("user_message", user_message, rectangle_from(400 - width/2, 220, width, 24)) if button_at_position("Write To Terminal!", rectangle_from(400 - width/2, 260, width, 24)): write_line(user_message) diff --git a/src/content/docs/guides/interface/interface-layouts.mdx b/src/content/docs/guides/interface/interface-layouts.mdx index e922a5488..15287467d 100644 --- a/src/content/docs/guides/interface/interface-layouts.mdx +++ b/src/content/docs/guides/interface/interface-layouts.mdx @@ -258,10 +258,14 @@ This'll give us a button like this: ![A panel with a button in it.](/gifs/guides/interface/panel_w_button.gif) -Similarly, we can add a [Text Box](/api/interface/#text-box) by declaring a `string` variable _outside_ the main loop, and then calling `my_string = text_box(my_string)`: +Similarly, we can add a [Text Box](/api/interface/#text-box) by declaring a `string` variable _outside_ the main loop, and then calling `my_string = text_box("id", my_string)`: ![A panel with a button and a text box in it.](/gifs/guides/interface/panel_w_button_and_textbox.gif) +:::tip["id"?] +You have to give a identifier/label for each text box. This is used to identify it when the user interacts with it. +::: + Here's the full code recreating what we had last tutorial, while creating a panel and adding the elements inside it. @@ -296,7 +300,7 @@ int main() write_line(user_message); } - user_message = text_box(user_message); + user_message = text_box("id", user_message); // end the panel end_panel("My panel"); @@ -347,7 +351,7 @@ while (!QuitRequested()) WriteLine(userMessage); } - userMessage = TextBox(userMessage); + userMessage = TextBox("id" userMessage); // end the panel EndPanel("My panel"); @@ -398,7 +402,7 @@ namespace InterfaceLayouts SplashKit.WriteLine(userMessage); } - userMessage = SplashKit.TextBox(userMessage); + userMessage = SplashKit.TextBox("id" userMessage); // end the panel SplashKit.EndPanel("My panel"); @@ -445,7 +449,7 @@ while (not quit_requested()): if button("Write To Terminal!"): write_line(user_message) - user_message = text_box(user_message) + user_message = text_box("id", user_message) # end the panel end_panel("My panel") @@ -466,9 +470,9 @@ close_all_windows() To place elements inside panels, we just need to create them _between_ the `start` and `end` calls. ::: -Another useful thing you can do now is add _labels_ to your elements. You can do this by passing an additional string to each element function at the start - as an example, `text_box(my_string)` can become `text_box("Message", my_string)`, which will give us this: +Another useful thing you can do now is add _labels_ to your elements. You can do this by passing an additional string to each element function at the start - as an example, `button("Click Me")` can become `button("Label", "Click Me")`, which will give us this. All `text_box` must have a label, to show the label you need to pass in an additional boolean parameter `text_box("Message", my_string, true)`: -![A panel with a textbox that has a label to the left of it.](./images/panel_w_labeltextbox.png) +![A panel with a text box that has a label to the left of it.](./images/panel_w_labeltextbox.png) :::note[SplashKit Interfaces] Here's a quick rundown of common element functions: @@ -478,7 +482,7 @@ Here's a quick rundown of common element functions: |boolean button(text) | boolean button("Label:", text) | |boolean checkbox(text, state) | boolean checkbox("Label:", text, state) | |number slider(value, min, max) | number slider("Label:", value, min, max)| -|string text_box(text) | string text_box("Label:", text) | +|string text_box(id, text) | string text_box("Label:", text, true) | ------------------------------------------- @@ -505,7 +509,7 @@ Headers are really easy to add - we can use the [Header](/api/interface/#header) ```cpp if (header("Edit Message!")) { - user_message = text_box(user_message); + user_message = text_box("id", user_message); } ``` @@ -518,7 +522,7 @@ if (header("Edit Message!")) ```csharp if (Header("Edit Message!")) { - userMessage = TextBox(userMessage); + userMessage = TextBox("id" userMessage); } ``` @@ -528,7 +532,7 @@ if (Header("Edit Message!")) ```csharp if (SplashKit.Header("Edit Message!")) { - userMessage = SplashKit.TextBox(userMessage); + userMessage = SplashKit.TextBox("id" userMessage); } ``` @@ -540,7 +544,7 @@ if (SplashKit.Header("Edit Message!")) ```python if header("Edit Message!"): - user_message = text_box(user_message) + user_message = text_box("id", user_message) ``` diff --git a/src/styles/custom.css b/src/styles/custom.css index 0a9618d09..789e1c680 100644 --- a/src/styles/custom.css +++ b/src/styles/custom.css @@ -366,7 +366,7 @@ code { /* Light gray background */ --icon-color: var(--sl-color-accent); /* Accent color for the icon */ - --icon-hover-color: darken(var(--sl-color-accent), 10%); + --icon-hover-color: #2f4bf2; /* Slightly darker color for the icon on hover */ border: 3px solid var(--custom-details-border); @@ -623,4 +623,256 @@ mjx-container svg { /* ----- End Tab Styling ----- -*/ \ No newline at end of file +*/ + +/* === Custom theme select switch styling === */ +starlight-theme-select { + display: inline-flex; + align-items: center; + justify-content: center; +} + +starlight-theme-select .theme-toggle { + display: inline-flex; + align-items: center; + gap: 0.35rem; + padding: 0.3rem; + border-radius: 9999px; + background: rgba(255, 255, 255, 0.88); + border: 1px solid rgba(128, 128, 128, 0.2); + box-shadow: inset 0 0 0 1px rgba(255, 255, 255, 0.03); +} + +html[data-theme="dark"] starlight-theme-select .theme-toggle { + background: rgba(25, 25, 25, 0.92); + border-color: rgba(255, 255, 255, 0.12); +} + +starlight-theme-select .theme-option { + position: relative; + appearance: none; + border: none; + background: transparent; + color: inherit; + padding: 0.55rem 0.85rem; + border-radius: 9999px; + display: inline-flex; + align-items: center; + justify-content: center; + gap: 0.35rem; + font-size: 0.85rem; + cursor: pointer; + transition: background 0.2s ease, color 0.2s ease, transform 0.2s ease; +} + +starlight-theme-select .theme-option.active { + background: var(--accent-foreground, #1f2937); + color: var(--accent-background, #ffffff); + transform: translateY(-1px); +} + +starlight-theme-select .theme-option:hover { + background: rgba(0, 0, 0, 0.05); +} + +html[data-theme="dark"] starlight-theme-select .theme-option:hover { + background: rgba(255, 255, 255, 0.08); +} + +starlight-theme-select .theme-option .theme-icon { + display: inline-flex; + width: 1rem; + height: 1rem; + align-items: center; + justify-content: center; + font-size: 1rem; +} + +starlight-theme-select .theme-option span:not(.theme-icon) { + display: none; +} + +starlight-theme-select .theme-toggle-select { + position: absolute; + width: 1px; + height: 1px; + padding: 0; + margin: -1px; + overflow: hidden; + border: 0; + clip: rect(0 0 0 0); + white-space: nowrap; +} + +starlight-theme-select .theme-option { + all: unset; + position: relative !important; + display: inline-flex !important; + align-items: center !important; + justify-content: center !important; + gap: 0.35rem !important; + padding: 0.55rem 0.85rem !important; + background: transparent !important; + border-radius: 9999px !important; + color: inherit !important; + cursor: pointer !important; + transition: background 0.2s ease, color 0.2s ease, transform 0.2s ease !important; +} + +starlight-theme-select .theme-option::before, +starlight-theme-select .theme-option::after { + content: none !important; + display: none !important; +} + +starlight-theme-select .theme-option.active { + background: var(--accent-foreground, #1f2937) !important; + color: var(--accent-background, #ffffff) !important; + transform: translateY(-1px) !important; +} + +starlight-theme-select .theme-option:hover { + background: rgba(0, 0, 0, 0.05) !important; +} + +html[data-theme="dark"] starlight-theme-select .theme-option:hover { + background: rgba(255, 255, 255, 0.08) !important; +} + +/* === Theme Toggle Switch Styling === */ + +/* Main theme toggle button styling */ +sl-icon-button[aria-label*="Dark"], +sl-icon-button[aria-label*="Light"], +sl-icon-button[aria-label*="Mode"], +button[aria-label*="Dark"], +button[aria-label*="Light"], +button[aria-label*="Mode"] { + position: relative !important; + width: 70px !important; + height: 40px !important; + padding: 0 !important; + background: none !important; + border: none !important; + cursor: pointer !important; + display: flex !important; + align-items: center !important; + justify-content: center !important; +} + +/* The actual toggle switch container */ +button[aria-label*="Dark"]::before, +button[aria-label*="Light"]::before, +button[aria-label*="Mode"]::before, +sl-icon-button[aria-label*="Dark"]::before, +sl-icon-button[aria-label*="Light"]::before, +sl-icon-button[aria-label*="Mode"]::before { + content: ""; + position: absolute; + width: 60px; + height: 34px; + background: linear-gradient(90deg, #f0f0f0 0%, #e0e0e0 100%); + border: 2px solid #333; + border-radius: 17px; + transition: all 0.3s ease; + z-index: 1; +} + +/* Light mode (left side sun) */ +html[data-theme="light"] button[aria-label*="Dark"]::before, +html[data-theme="light"] button[aria-label*="Light"]::before, +html[data-theme="light"] button[aria-label*="Mode"]::before, +html[data-theme="light"] sl-icon-button[aria-label*="Dark"]::before, +html[data-theme="light"] sl-icon-button[aria-label*="Light"]::before, +html[data-theme="light"] sl-icon-button[aria-label*="Mode"]::before { + background: linear-gradient(90deg, #fff 0%, #f5f5f5 100%); +} + +/* Dark mode (right side moon) */ +html[data-theme="dark"] button[aria-label*="Dark"]::before, +html[data-theme="dark"] button[aria-label*="Light"]::before, +html[data-theme="dark"] button[aria-label*="Mode"]::before, +html[data-theme="dark"] sl-icon-button[aria-label*="Dark"]::before, +html[data-theme="dark"] sl-icon-button[aria-label*="Light"]::before, +html[data-theme="dark"] sl-icon-button[aria-label*="Mode"]::before { + background: linear-gradient(90deg, #2a2a2a 0%, #1a1a1a 100%); +} + +/* Slider circle */ +button[aria-label*="Dark"]::after, +button[aria-label*="Light"]::after, +button[aria-label*="Mode"]::after, +sl-icon-button[aria-label*="Dark"]::after, +sl-icon-button[aria-label*="Light"]::after, +sl-icon-button[aria-label*="Mode"]::after { + content: ""; + position: absolute; + width: 26px; + height: 26px; + background: radial-gradient(circle at 30% 30%, #fff, #e0e0e0); + border: 2px solid #333; + border-radius: 50%; + left: 4px; + top: 4px; + transition: all 0.3s ease; + z-index: 2; + box-shadow: 0 2px 4px rgba(0, 0, 0, 0.2); +} + +/* Dark mode slider position (right) */ +html[data-theme="dark"] button[aria-label*="Dark"]::after, +html[data-theme="dark"] button[aria-label*="Light"]::after, +html[data-theme="dark"] button[aria-label*="Mode"]::after, +html[data-theme="dark"] sl-icon-button[aria-label*="Dark"]::after, +html[data-theme="dark"] sl-icon-button[aria-label*="Light"]::after, +html[data-theme="dark"] sl-icon-button[aria-label*="Mode"]::after { + left: 30px; + background: radial-gradient(circle at 30% 30%, #fff, #f0f0f0); +} + +/* Icon styling inside the button */ +button[aria-label*="Dark"] svg, +button[aria-label*="Light"] svg, +button[aria-label*="Mode"] svg, +sl-icon-button[aria-label*="Dark"] svg, +sl-icon-button[aria-label*="Light"] svg, +sl-icon-button[aria-label*="Mode"] svg { + position: absolute; + width: 20px; + height: 20px; + opacity: 0; + transition: opacity 0.3s ease; + z-index: 3; +} + +/* Sun icon (light mode) positioning */ +html[data-theme="light"] button[aria-label*="Dark"] svg, +html[data-theme="light"] button[aria-label*="Light"] svg, +html[data-theme="light"] button[aria-label*="Mode"] svg, +html[data-theme="light"] sl-icon-button[aria-label*="Dark"] svg, +html[data-theme="light"] sl-icon-button[aria-label*="Light"] svg, +html[data-theme="light"] sl-icon-button[aria-label*="Mode"] svg { + opacity: 1; + left: 10px; +} + +/* Moon icon (dark mode) positioning */ +html[data-theme="dark"] button[aria-label*="Dark"] svg, +html[data-theme="dark"] button[aria-label*="Light"] svg, +html[data-theme="dark"] button[aria-label*="Mode"] svg, +html[data-theme="dark"] sl-icon-button[aria-label*="Dark"] svg, +html[data-theme="dark"] sl-icon-button[aria-label*="Light"] svg, +html[data-theme="dark"] sl-icon-button[aria-label*="Mode"] svg { + opacity: 1; + right: 10px; +} + +/* Hover effect */ +button[aria-label*="Dark"]:hover::before, +button[aria-label*="Light"]:hover::before, +button[aria-label*="Mode"]:hover::before, +sl-icon-button[aria-label*="Dark"]:hover::before, +sl-icon-button[aria-label*="Light"]:hover::before, +sl-icon-button[aria-label*="Mode"]:hover::before { + box-shadow: 0 0 8px rgba(0, 0, 0, 0.2); +} \ No newline at end of file