vgl 1.0.0
Virtual Globe Library: API reference
Loading...
Searching...
No Matches
vgl Namespace Reference

Namespaces

namespace  ogre
 

Classes

class  allocator
 
class  context
 
class  d3d11_backend
 
class  disk_cache
 
struct  enu_frame
 
class  expected
 
class  file_reader
 
class  frame
 
class  gl_backend
 
struct  height_sample
 
class  http_reader
 
class  io_interface
 
class  pack
 
struct  pack_status
 
struct  ray_query_result
 
class  task_interface
 
class  thread_pool
 
class  unexpected
 
struct  version
 

Typedefs

using io_request = vgl_io_request
 
using io_read = vgl_io_read
 
using io_complete_fn = vgl_io_complete_fn
 
using task_fn = vgl_task_fn
 

Enumerations

enum class  result : std::int32_t {
  success = VGL_RESULT_SUCCESS , incomplete = VGL_RESULT_INCOMPLETE , not_ready = VGL_RESULT_NOT_READY , invalid_argument = VGL_RESULT_INVALID_ARGUMENT ,
  out_of_memory = VGL_RESULT_OUT_OF_MEMORY , not_supported = VGL_RESULT_NOT_SUPPORTED , invalid_operation = VGL_RESULT_INVALID_OPERATION , not_found = VGL_RESULT_NOT_FOUND ,
  io_error = VGL_RESULT_IO_ERROR , corrupt_data = VGL_RESULT_CORRUPT_DATA , version_mismatch = VGL_RESULT_VERSION_MISMATCH , cancelled = VGL_RESULT_CANCELLED ,
  backend_error = VGL_RESULT_BACKEND_ERROR , internal_error = VGL_RESULT_INTERNAL_ERROR
}
 
enum class  pack_state : std::int32_t { loading = VGL_PACK_STATE_LOADING , ready = VGL_PACK_STATE_READY , failed = VGL_PACK_STATE_FAILED }
 
enum class  height_reference : std::int32_t { ellipsoid = VGL_HEIGHT_REFERENCE_ELLIPSOID , mean_sea_level = VGL_HEIGHT_REFERENCE_MEAN_SEA_LEVEL }
 
enum class  texture_format : std::int32_t {
  rgba8 = VGL_TEXTURE_FORMAT_RGBA8 , rgba8_srgb = VGL_TEXTURE_FORMAT_RGBA8_SRGB , bc1 = VGL_TEXTURE_FORMAT_BC1 , bc7 = VGL_TEXTURE_FORMAT_BC7 ,
  etc2_rgb8 = VGL_TEXTURE_FORMAT_ETC2_RGB8 , astc_4x4 = VGL_TEXTURE_FORMAT_ASTC_4X4
}
 
enum class  log_level : std::int32_t {
  default_level = VGL_LOG_LEVEL_DEFAULT , error = VGL_LOG_LEVEL_ERROR , warning = VGL_LOG_LEVEL_WARNING , info = VGL_LOG_LEVEL_INFO ,
  debug = VGL_LOG_LEVEL_DEBUG
}
 
enum class  depth_convention : std::int32_t { logarithmic = VGL_DEPTH_CONVENTION_LOGARITHMIC , reversed_z = VGL_DEPTH_CONVENTION_REVERSED_Z , conventional = VGL_DEPTH_CONVENTION_CONVENTIONAL }
 

Functions

constexpr bool succeeded (result r) noexcept
 
constexpr bool failed (result r) noexcept
 
const char * result_name_get (result r) noexcept
 
template<typename T >
constexpr T init () noexcept
 
version version_get () noexcept
 
expected< vgl_dvec3 > view_project (const vgl_view &view, const vgl_dvec3 &position) noexcept
 
expected< vgl_dvec3 > view_geodetic_project (const vgl_view &view, const vgl_geodetic &geodetic, const vgl_ellipsoid *ellipsoid=nullptr) noexcept
 
result io_request_complete (io_request *request, result r, std::span< const std::byte > data={}) noexcept
 
expected< io_request * > io_request_create (io_complete_fn complete, void *user_data, const vgl_allocator_interface *alloc=nullptr) noexcept
 
constexpr double degrees_to_radians (double degrees) noexcept
 
constexpr double radians_to_degrees (double radians) noexcept
 
vgl_ellipsoid ellipsoid_wgs84_get () noexcept
 
expected< vgl_dvec3 > ellipsoid_geodetic_to_ecef (const vgl_ellipsoid &ellipsoid, const vgl_geodetic &geodetic) noexcept
 
expected< vgl_geodetic > ellipsoid_ecef_to_geodetic (const vgl_ellipsoid &ellipsoid, const vgl_dvec3 &ecef) noexcept
 
expected< enu_frame > ellipsoid_enu_frame_get (const vgl_ellipsoid &ellipsoid, const vgl_geodetic &origin) noexcept
 
expected< double > earth_rotation_angle_get (double julian_date) noexcept
 

Variables

constexpr std::uint64_t io_size_to_end = VGL_IO_SIZE_TO_END
 
constexpr double pi = VGL_PI
 

Typedef Documentation

◆ io_request

◆ io_read

◆ io_complete_fn

◆ task_fn

Enumeration Type Documentation

◆ result

enum class vgl::result : std::int32_t
strong
Enumerator
success 
incomplete 
not_ready 
invalid_argument 
out_of_memory 
not_supported 
invalid_operation 
not_found 
io_error 
corrupt_data 
version_mismatch 
cancelled 
backend_error 
internal_error 

◆ pack_state

enum class vgl::pack_state : std::int32_t
strong
Enumerator
loading 
ready 
failed 

◆ height_reference

enum class vgl::height_reference : std::int32_t
strong
Enumerator
ellipsoid 
mean_sea_level 

◆ texture_format

enum class vgl::texture_format : std::int32_t
strong
Enumerator
rgba8 
rgba8_srgb 
bc1 
bc7 
etc2_rgb8 
astc_4x4 

◆ log_level

enum class vgl::log_level : std::int32_t
strong
Enumerator
default_level 
error 
warning 
info 
debug 

◆ depth_convention

enum class vgl::depth_convention : std::int32_t
strong
Enumerator
logarithmic 
reversed_z 
conventional 

Function Documentation

◆ succeeded()

constexpr bool vgl::succeeded ( result  r)
constexprnoexcept

◆ failed()

constexpr bool vgl::failed ( result  r)
constexprnoexcept

◆ result_name_get()

const char * vgl::result_name_get ( result  r)
inlinenoexcept

◆ init()

template<typename T >
constexpr T vgl::init ( )
constexprnoexcept

◆ version_get()

version vgl::version_get ( )
inlinenoexcept

◆ view_project()

expected< vgl_dvec3 > vgl::view_project ( const vgl_view &  view,
const vgl_dvec3 &  position 
)
inlinenoexcept

◆ view_geodetic_project()

expected< vgl_dvec3 > vgl::view_geodetic_project ( const vgl_view &  view,
const vgl_geodetic &  geodetic,
const vgl_ellipsoid *  ellipsoid = nullptr 
)
inlinenoexcept

◆ io_request_complete()

result vgl::io_request_complete ( io_request *  request,
result  r,
std::span< const std::byte >  data = {} 
)
inlinenoexcept

◆ io_request_create()

expected< io_request * > vgl::io_request_create ( io_complete_fn  complete,
void *  user_data,
const vgl_allocator_interface *  alloc = nullptr 
)
inlinenoexcept

◆ degrees_to_radians()

constexpr double vgl::degrees_to_radians ( double  degrees)
constexprnoexcept

◆ radians_to_degrees()

constexpr double vgl::radians_to_degrees ( double  radians)
constexprnoexcept

◆ ellipsoid_wgs84_get()

vgl_ellipsoid vgl::ellipsoid_wgs84_get ( )
inlinenoexcept

◆ ellipsoid_geodetic_to_ecef()

expected< vgl_dvec3 > vgl::ellipsoid_geodetic_to_ecef ( const vgl_ellipsoid &  ellipsoid,
const vgl_geodetic &  geodetic 
)
inlinenoexcept

◆ ellipsoid_ecef_to_geodetic()

expected< vgl_geodetic > vgl::ellipsoid_ecef_to_geodetic ( const vgl_ellipsoid &  ellipsoid,
const vgl_dvec3 &  ecef 
)
inlinenoexcept

◆ ellipsoid_enu_frame_get()

expected< enu_frame > vgl::ellipsoid_enu_frame_get ( const vgl_ellipsoid &  ellipsoid,
const vgl_geodetic &  origin 
)
inlinenoexcept

◆ earth_rotation_angle_get()

expected< double > vgl::earth_rotation_angle_get ( double  julian_date)
inlinenoexcept

Variable Documentation

◆ io_size_to_end

constexpr std::uint64_t vgl::io_size_to_end = VGL_IO_SIZE_TO_END
inlineconstexpr

◆ pi

constexpr double vgl::pi = VGL_PI
inlineconstexpr