Campbell Barton
3d3bc74884
MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
82 lines
2.8 KiB
C++
82 lines
2.8 KiB
C++
/*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* The Original Code is Copyright (C) 2008 Blender Foundation.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bli
|
|
*/
|
|
|
|
#include "BLI_compiler_attrs.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* Generate time-code/frame number string and store in \a str
|
|
*
|
|
* \param str: destination string
|
|
* \param maxncpy: maximum number of characters to copy `sizeof(str)`
|
|
* \param brevity_level: special setting for #View2D grid drawing,
|
|
* used to specify how detailed we need to be
|
|
* \param time_seconds: time total time in seconds
|
|
* \param fps: frames per second, typically from the #FPS macro
|
|
* \param timecode_style: enum from #eTimecodeStyles
|
|
* \return length of \a str
|
|
*/
|
|
size_t BLI_timecode_string_from_time(char *str,
|
|
const size_t maxncpy,
|
|
int brevity_level,
|
|
float time_seconds,
|
|
double fps,
|
|
short timecode_style) ATTR_NONNULL();
|
|
|
|
/**
|
|
* Generate time string and store in \a str
|
|
*
|
|
* \param str: destination string
|
|
* \param maxncpy: maximum number of characters to copy `sizeof(str)`
|
|
* \param time_seconds: time total time in seconds
|
|
* \return length of \a str
|
|
*/
|
|
size_t BLI_timecode_string_from_time_simple(char *str, const size_t maxncpy, double time_seconds)
|
|
ATTR_NONNULL();
|
|
|
|
/**
|
|
* Generate time string and store in \a str
|
|
*
|
|
* \param str: destination string
|
|
* \param maxncpy: maximum number of characters to copy `sizeof(str)`
|
|
* \param brevity_level: special setting for #View2D grid drawing,
|
|
* used to specify how detailed we need to be
|
|
* \param time_seconds: time total time in seconds
|
|
* \return length of \a str
|
|
*
|
|
* \note in some cases this is used to print non-seconds values.
|
|
*/
|
|
size_t BLI_timecode_string_from_time_seconds(char *str,
|
|
const size_t maxncpy,
|
|
int brevity_level,
|
|
float time_seconds) ATTR_NONNULL();
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|