BLI_winstuff.h File Reference

Compatibility-like things for windows. More...

#include "BLI_sys_types.h"
#include <windows.h>

Go to the source code of this file.

Classes
struct	dirent

Macros
#define	WIN32_LEAN_AND_MEAN
#define	NOMINMAX
#define	_USE_MATH_DEFINES
#define	S_ISREG(x)
#define	S_ISDIR(x)

Typedefs
typedef unsigned int	mode_t
typedef struct __dirstream	DIR

Enumerations
enum class	QoSMode { DEFAULT = 0 , HIGH = 1 , ECO = 2 }
enum class	QoSPrecedence { JOB = 0 , CMDLINE_ARG = 1 }

Functions
DIR *	opendir (const char *path)
struct dirent *	readdir (DIR *dp)
int	closedir (DIR *dp)
const char *	dirname (char *path)
bool	BLI_windows_is_store_install (void)
bool	BLI_windows_register_blend_extension (bool all_users)
bool	BLI_windows_unregister_blend_extension (bool all_users)
bool	BLI_windows_update_pinned_launcher (const char *launcher_path)
bool	BLI_windows_get_directx_driver_version (const wchar_t *deviceSubString, long long *r_driverVersion)
bool	BLI_windows_is_build_version_greater_or_equal (DWORD majorVersion, DWORD minorVersion, DWORD buildNumber)
void	BLI_windows_get_default_root_dir (char root_dir[4])
int	BLI_windows_get_executable_dir (char r_dirpath[])
bool	BLI_windows_external_operation_supported (const char *filepath, const char *operation)
bool	BLI_windows_external_operation_execute (const char *filepath, const char *operation)
bool	BLI_windows_execute_self (const char *parameters, const bool wait, const bool elevated, const bool silent)
void	BLI_windows_process_set_qos (QoSMode qos_mode, QoSPrecedence qos_precedence)

Detailed Description

Compatibility-like things for windows.

Definition in file BLI_winstuff.h.

Macro Definition Documentation

_USE_MATH_DEFINES

#define _USE_MATH_DEFINES

Definition at line 42 of file BLI_winstuff.h.

NOMINMAX

#define NOMINMAX

Definition at line 21 of file BLI_winstuff.h.

S_ISDIR

#define S_ISDIR

(

x

)

Value:

(((x) & _S_IFDIR) == _S_IFDIR)

Definition at line 49 of file BLI_winstuff.h.

Referenced by autocomplete_directory(), BKE_appdir_app_templates(), blf_load_datafiles_dir(), BLI_dir_create_recursive(), BLI_file_read_data_as_mem_from_handle(), BLI_is_dir(), BLI_is_file(), blender::gpu::VKShaderCompiler::cache_dir_clear_old(), dir_create_recursive(), direntry_cmp(), filelist_readjob_list_dir(), blender::asset_system::AssetCatalogService::load_from_disk(), missing_files_find__recursive(), path_is_directory(), python_script_exec(), recursive_operation_impl(), and wm_file_write().

S_ISREG

#define S_ISREG

(

x

)

Value:

(((x) & _S_IFREG) == _S_IFREG)

Definition at line 46 of file BLI_winstuff.h.

Referenced by copy_single_file(), direntry_cmp(), blender::asset_system::AssetCatalogService::load_from_disk(), and missing_files_find__recursive().

WIN32_LEAN_AND_MEAN

#define WIN32_LEAN_AND_MEAN

Definition at line 18 of file BLI_winstuff.h.

Typedef Documentation

DIR

typedef struct __dirstream DIR

Intentionally opaque to users.

Definition at line 71 of file BLI_winstuff.h.

mode_t

typedef unsigned int mode_t

Definition at line 60 of file BLI_winstuff.h.

Enumeration Type Documentation

QoSMode

enum class QoSMode

strong

Quality of Service (QoS) modes as defined in the Windows documentation at: https://learn.microsoft.com/en-us/windows/win32/procthread/quality-of-service

Enumerator
DEFAULT	Default mode uses heuristics described in Windows docs.
HIGH	HighQoS mode for performance critical scenarios.
ECO	EcoQoS mode for preserving energy.

Definition at line 125 of file BLI_winstuff.h.

QoSPrecedence

enum class QoSPrecedence

strong

QoS precedence (to make sure command line args overwrite what is set by jobs). Higher values have more precedence.

Enumerator
JOB	QoS mode requested set via the job system.
CMDLINE_ARG	QoS mode requested set via a command line argument.

Definition at line 136 of file BLI_winstuff.h.

Function Documentation

BLI_windows_execute_self()

bool BLI_windows_execute_self	(	const char *	parameters,
		const bool	wait,
		const bool	elevated,
		const bool	silent )

Launch our own executable.

Parameters

parameters	application parameters separated by spaces.
wait	whether to wait for the instance to exit.
elevated	run as administrator. Will do UAC prompt.
silent	Not show the launched program.

Referenced by WM_platform_associate_set().

BLI_windows_external_operation_execute()

bool BLI_windows_external_operation_execute	(	const char *	filepath,
		const char *	operation )

Referenced by BLI_file_external_operation_execute().

BLI_windows_external_operation_supported()

bool BLI_windows_external_operation_supported	(	const char *	filepath,
		const char *	operation )

Referenced by BLI_file_external_operation_execute(), and BLI_file_external_operation_supported().

BLI_windows_get_default_root_dir()

void BLI_windows_get_default_root_dir

(

char

root_dir[4]

)

Set the root_dir to the default root directory on MS-Windows, The string is guaranteed to be set with a length of 3 & null terminated, using a fall-back in case the root directory can't be found.

Referenced by BKE_appdir_folder_root(), BLI_path_abs(), BLI_path_rel(), and parent_dir_until_exists_or_default_root().

BLI_windows_get_directx_driver_version()

bool BLI_windows_get_directx_driver_version	(	const wchar_t *	deviceSubString,
		long long *	r_driverVersion )

Referenced by blender::gpu::detect_workarounds().

BLI_windows_get_executable_dir()

int BLI_windows_get_executable_dir

(

char

r_dirpath[]

)

BLI_windows_is_build_version_greater_or_equal()

bool BLI_windows_is_build_version_greater_or_equal	(	DWORD	majorVersion,
		DWORD	minorVersion,
		DWORD	buildNumber )

BLI_windows_is_store_install()

bool BLI_windows_is_store_install

(

void

)

Referenced by associate_blend_exec(), associate_blend_poll(), and unassociate_blend_exec().

BLI_windows_process_set_qos()

void BLI_windows_process_set_qos	(	QoSMode	qos_mode,
		QoSPrecedence	qos_precedence )

Sets the Quality of Service (QoS) mode of the process.

Parameters

qos_mode	The QoS mode to use for the process.
qos_precedence	The precedence of the caller (higher wins).

Referenced by arg_handle_qos_set(), and wm_jobs_update_qos().

BLI_windows_register_blend_extension()

bool BLI_windows_register_blend_extension

(

bool

all_users

)

Referenced by arg_handle_extension_registration(), and WM_platform_associate_set().

BLI_windows_unregister_blend_extension()

bool BLI_windows_unregister_blend_extension

(

bool

all_users

)

Referenced by arg_handle_extension_registration(), and WM_platform_associate_set().

BLI_windows_update_pinned_launcher()

bool BLI_windows_update_pinned_launcher

(

const char *

launcher_path

)

closedir()

int closedir

(

DIR *

dp

)

Referenced by autocomplete_directory(), BKE_ptcache_disk_cache_rename(), BKE_ptcache_id_clear(), BKE_ptcache_id_time(), BKE_ptcache_load_external(), bli_builddir(), and missing_files_find__recursive().

dirname()

const char * dirname

(

char *

path

)

Referenced by autocomplete_directory(), BKE_image_get_tile_info(), BKE_image_tile_filepath_exists(), blender_absolute_path(), bli_builddir(), BLI_dir_create_recursive(), BLI_dir_free_space(), BLI_filelist_dir_contents(), dir_create_recursive(), file_directory_new_exec(), fsmenu_read_system(), get_index_dir(), preferences_asset_library_add_exec(), ptcache_path(), render_result_exr_file_cache_path(), blender::seq::seq_proxy_index_dir_set(), and uiTemplateRecentFiles_tooltip_func().

opendir()

DIR * opendir

(

const char *

path

)

Referenced by autocomplete_directory(), BKE_ptcache_disk_cache_rename(), BKE_ptcache_id_clear(), BKE_ptcache_id_time(), BKE_ptcache_load_external(), bli_builddir(), and missing_files_find__recursive().

readdir()

struct dirent * readdir

(

DIR *

dp

)

Referenced by autocomplete_directory(), BKE_ptcache_disk_cache_rename(), BKE_ptcache_id_clear(), BKE_ptcache_id_time(), BKE_ptcache_load_external(), bli_builddir(), and missing_files_find__recursive().