plugins/include/profiler.inc
author Matt Schubert <schubertm@gmail.com>
Fri Sep 12 20:36:53 2008 +0000 (2008-09-12)
changeset 2280 156053eea73c
parent 1952 b7aa2b626807
child 2289 44045ead61cd
permissions -rw-r--r--
Fixed amb1929 - Banning via console should now work properly
ds@1952
     1
/**
ds@1952
     2
 * vim: set ts=4 :
ds@1952
     3
 * =============================================================================
ds@1952
     4
 * SourceMod (C)2004-2008 AlliedModders LLC.  All rights reserved.
ds@1952
     5
 * =============================================================================
ds@1952
     6
 *
ds@1952
     7
 * This file is part of the SourceMod/SourcePawn SDK.
ds@1952
     8
 *
ds@1952
     9
 * This program is free software; you can redistribute it and/or modify it under
ds@1952
    10
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1952
    11
 * Free Software Foundation.
ds@1952
    12
 * 
ds@1952
    13
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1952
    14
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1952
    15
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1952
    16
 * details.
ds@1952
    17
 *
ds@1952
    18
 * You should have received a copy of the GNU General Public License along with
ds@1952
    19
 * this program.  If not, see <http://www.gnu.org/licenses/>.
ds@1952
    20
 *
ds@1952
    21
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1952
    22
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1952
    23
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1952
    24
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1952
    25
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1952
    26
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1952
    27
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1952
    28
 * or <http://www.sourcemod.net/license.php>.
ds@1952
    29
 *
ds@1952
    30
 * Version: $Id$
ds@1952
    31
 */
ds@1952
    32
ds@1952
    33
#if defined _profiler_included
ds@1952
    34
 #endinput
ds@1952
    35
#endif
ds@1952
    36
#define _profiler_included
ds@1952
    37
ds@1952
    38
/**
ds@1952
    39
 * ONLY AVAILABLE ON WINDOWS RIGHT NOW K.
ds@1952
    40
 */
ds@1952
    41
 
ds@1952
    42
/**
ds@1952
    43
 * Creates a new profile object.  The Handle must be freed
ds@1952
    44
 * using CloseHandle().
ds@1952
    45
 *
ds@1952
    46
 * @return			Handle to the profiler object.
ds@1952
    47
 */
ds@1952
    48
native Handle:CreateProfiler();
ds@1952
    49
ds@1952
    50
/**
ds@1952
    51
 * Starts profiling.
ds@1952
    52
 *
ds@1952
    53
 * @param prof		Profiling object.
ds@1952
    54
 * @noreturn
ds@1952
    55
 * @error			Invalid Handle.
ds@1952
    56
 */
ds@1952
    57
native StartProfiling(Handle:prof);
ds@1952
    58
ds@1952
    59
/**
ds@1952
    60
 * Stops profiling.
ds@1952
    61
 *
ds@1952
    62
 * @param prof		Profiling object.
ds@1952
    63
 * @noreturn
ds@1952
    64
 * @error			Invalid Handle or profiling was never started.
ds@1952
    65
 */
ds@1952
    66
native StopProfiling(Handle:prof);
ds@1952
    67
ds@1952
    68
/**
ds@1952
    69
 * Returns the amount of high-precision time in seconds
ds@1952
    70
 * that passed during the profiler's last start/stop 
ds@1952
    71
 * cycle.
ds@1952
    72
 *
ds@1952
    73
 * @param prof		Profiling object.
ds@1952
    74
 * @return			Time elapsed in seconds.
ds@1952
    75
 * @error			Invalid Handle.
ds@1952
    76
 */
ds@1952
    77
native Float:GetProfilerTime(Handle:prof);