SDK API Reference
Introduction to the SDK API
This document provides a comprehensive reference for the Software Development Kit (SDK) APIs. These APIs offer powerful tools and functionalities for building advanced applications that leverage the full capabilities of our platform. Explore the sections below to find detailed information on each API module.
Core APIs
The core APIs form the foundation of many SDK functionalities, providing essential services for application development.
Threading Namespace
Provides classes for managing threads, synchronization, and concurrency.
Thread, Mutex, Semaphore, TaskThread.Start(delegate)
Starts a new thread of execution.
delegate- A method to be executed by the new thread.
Returns a
Thread object representing the new thread.Mutex.Lock()
Acquires exclusive ownership of the mutex.
Returns
true if the lock was acquired, false otherwise.Memory Management Namespace
Offers tools for efficient memory allocation, deallocation, and management.
Allocator, MemoryPoolAllocator.Allocate(size)
Allocates a block of memory of the specified size.
size- The number of bytes to allocate.
A pointer to the allocated memory block.
File System Namespace
Enables interaction with the file system, including file operations and directory management.
File, Directory, PathFile.Exists(filePath)
Checks if a file exists at the specified path.
filePath- The full path to the file.
true if the file exists, false otherwise.Networking APIs
These APIs facilitate network communication, enabling applications to connect to remote services and transfer data.
Sockets Namespace
Provides low-level network socket functionality.
Socket, IPEndPointSocket.Connect(endpoint)
Establishes a connection to a remote host.
endpoint- An
IPEndPointobject representing the remote address and port.
HTTP Client Namespace
Simplifies making HTTP requests and handling responses.
HttpClient, HttpRequest, HttpResponseHttpClient.GetAsync(url)
Sends an asynchronous HTTP GET request to the specified URL.
url- The URL to send the GET request to.
A
Task that represents the asynchronous operation, yielding an HttpResponse.Graphics APIs
Tools for creating rich visual experiences, from 2D rendering to complex 3D graphics.
Rendering Engine Namespace
Core components for drawing graphics to the screen.
Renderer, Canvas, ColorCanvas.DrawRectangle(x, y, width, height, color)
Draws a filled rectangle on the canvas.
x- X-coordinate of the top-left corner.
y- Y-coordinate of the top-left corner.
width- Width of the rectangle.
height- Height of the rectangle.
color- The fill color (
Colorobject).
Shader Language Interface
Interface for writing and managing custom shader programs.
Shader, ShaderParameterShader.Compile(source)
Compiles a shader program from its source code.
source- String containing the shader code.
A compiled
Shader object.Utility Functions
A collection of helpful utility functions for common tasks.
StringUtils.IsNullOrEmpty(str)
Checks if a string is null or empty.
str- The string to check.
true if the string is null or empty, false otherwise.