hotline_rs/

lib.rs

/// Operating system module (Windows, Application, Input).
pub mod os;

/// Graphics and compute abstraction module.
pub mod gfx;

/// Hardware accelerated audio and video decoding.
pub mod av;

/// Image reading/writing module support for (png, jpg, bmp, tiff, dds).
pub mod image;

/// Imgui rendering and platform implementation.
pub mod imgui;

/// Immediate mode primitive rendering API.
pub mod imdraw;

/// High level graphics (data driven render pipelines, shaders, views).
pub mod pmfx;

/// Primitive geometry meshes (quad, cube, sphere, etc).
pub mod primitives;

/// Hotline clinet context contains an `App`, `Device`, `SwapChain` and main `Window` automatically setup
/// It can load code dynamically from other `dylibs` or `dlls` abnd provides a very thin run loop for you to hook your own plugins into.
pub mod client;

/// Trait's and macros to assist the creation of plugins in other dynamically loaded libraries
pub mod plugin;

/// Module to aid data / code file watching, rebuilding and reloading
pub mod reloader;

/// Shared types and resources for use with bevy ecs
pub mod ecs_base;

/// Use bitmask for flags
#[macro_use]
extern crate bitflags;

/// Generic errors for modules to define their own
pub struct Error {
    pub msg: String,
}

/// Generic debug for errors
impl std::fmt::Debug for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.msg)
    }
}

impl<T> From<T> for Error where T: ToString {
    fn from(err: T) -> Error {
        Error {
            msg: err.to_string()
        }
    }
}

/// Returns the config name for the current configuration, this is useful to local items in target/debug
#[cfg(debug_assertions)]
pub const fn get_config_name() -> &'static str {
    "debug"
}

/// Returns the config name for the current configuration, this is useful to local items in target/release
#[cfg(not(debug_assertions))]
pub const fn get_config_name() -> &'static str {
    "release"
}

/// Return an absolute path for a resource given the relative resource name from the /hotline-data/src_data dir
pub fn get_src_data_path(asset: &str) -> String {
    let exe_path = std::env::current_exe().ok().unwrap();
    // back 2 (client)
    let data_path = exe_path.parent().unwrap().join("../../hotline-data/src");
    if data_path.join(asset).exists() {
        let path = std::fs::canonicalize(data_path.join(asset)).unwrap();
        String::from(path.to_str().unwrap()).replace("\\\\?\\", "")
    }
    else {
        // back 3 (examples)
        let data_path = exe_path.parent().unwrap().join("../../../hotline-data/src");
        if data_path.join(asset).exists() {
            let path = std::fs::canonicalize(data_path.join(asset)).unwrap();
            String::from(path.to_str().unwrap()).replace("\\\\?\\", "")
        }
        else {
            panic!();
        }
    }
}

/// Return an absolute path for a resource given the relative resource name from the /data dir
pub fn get_data_path(asset: &str) -> String {
    let exe_path = std::env::current_exe().ok().unwrap();
    // back 1 (target/data)
    let data_path = exe_path.parent().unwrap().join("../data");
    if data_path.exists() {
        let path = std::fs::canonicalize(data_path.join(asset));
        if path.is_err() {
            println!("{:?}", data_path);
            println!("{}", asset);
        }
        String::from(path.unwrap().to_str().unwrap()).replace("\\\\?\\", "")
    }
    else {
        // back 2 (examples)
        let data_path = exe_path.parent().unwrap().join("../../data");
        if data_path.exists() {
            let path = std::fs::canonicalize(data_path.join(asset)).unwrap();
            String::from(path.to_str().unwrap()).replace("\\\\?\\", "")
        }
        else {
            // unable to locate data
            panic!()
        }
    }
}

/// Return an absolute path for a resource given the relative path from the /executable dir
pub fn get_exe_path(asset: &str) -> String {
    let exe_path = std::env::current_exe().ok().unwrap();
    String::from(exe_path.join(asset).to_str().unwrap())
}

/// Recursivley get files from folder as a vector
fn get_files_recursive(dir: &str, mut files: Vec<String>) -> Vec<String> {
    let paths = std::fs::read_dir(dir).unwrap();
    for path in paths {
        let path = path.unwrap().path();
        if std::fs::read_dir(&path).is_ok() {
            files = get_files_recursive(path.to_str().unwrap(), files);
        }
        else {
            files.push(path.to_str().unwrap().to_string());
        }   
    }
    files
}

/// This is a hardcoded compile time selection of os backend for windows as win32
#[cfg(target_os = "windows")]
pub use os::win32 as os_platform;

/// This is a hardcoded compile time selection of os backend for windows as d3d12
#[cfg(target_os = "windows")]
pub use gfx::d3d12 as gfx_platform;

/// This is a hardcoded compile time selection of os backend for windows as wmf
#[cfg(target_os = "windows")]
pub use av::wmf as av_platform;


/// Most commonly used re-exported types.
#[cfg(target_os = "windows")]
pub mod prelude {
    #[doc(hidden)]
    pub use crate::{
        // modules
        gfx,
        os,
        client,
        plugin,
        pmfx,
        imgui,
        image,

        // platform specific 
        gfx_platform,
        os_platform,
        av_platform,

        // traits
        ecs_base::*,
        gfx::{Device, SwapChain, CmdBuf, Texture, RenderPass, Pipeline, Buffer},
        pmfx::{DrawData, MaterialData, PointLightData, SpotLightData, DirectionalLightData, WorldBufferReserveInfo, WorldBufferInfo},
        os::{App, Window},
        pmfx::Pmfx,
        imgui::ImGui,
        imdraw::ImDraw,
        client::{Client, HotlineInfo, PluginInfo},
        plugin::{Plugin},
        av::{VideoPlayer},

        // macros
        hotline_plugin,
        system_func,
        render_func,
        render_func_closure,

        compute_func,
        compute_func_closure,
        compute_func_query,
        compute_func_query_closure,

        demos,
        systems
    };
}

#[cfg(not(target_os = "windows"))]
pub mod prelude {
    #[doc(hidden)]
    pub use crate::{
        // modules
        gfx,
        os,
        client,
        plugin,
        pmfx,
        imgui,

        // traits
        gfx::{Device, SwapChain, CmdBuf, Texture, RenderPass},
        os::{App, Window},
        pmfx::Pmfx,
        imgui::ImGui,
        imdraw::ImDraw,
        client::{Client, HotlineInfo, PluginInfo},
        plugin::{Plugin},
        av::{VideoPlayer},
    };
}