Declares the most fundamental data types used by NTV2. Since Windows NT was the first principal development platform, many typedefs are Windows-centric. More...

#include "ntv2deprecate.h"
#include <stdint.h>

Include dependency graph for ajatypes.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	NTV2_USE_STDINT

#define	NTV2_NUB_CLIENT_SUPPORT

#define	NTV2_WRITEREG_PROFILING

#define	NTV2_USE_CPLUSPLUS11

#define	NTV2_CHECK_SDRAM_COLLISIONS

#define	AJA_VIRTUAL virtual

#define	AJA_STATIC static

#define	NTV2_UNUSED(__p__) (void)__p__

#define	AJA_NULL NULL

#define	AJA_FALL_THRU

#define	AJATargetBigEndian 0

#define	AJAFUNC __func__

#define	NTV2_CPP_MIN(__x__, __y__) std::min((__x__),(__y__))

#define	NTV2_CPP_MAX(__x__, __y__) std::max((__x__),(__y__))

#define	MAX_PATH 4096

#define	INVALID_HANDLE_VALUE (0)

#define	POINTER_32

#define	NTV2_ASSERT(_expr_) (void) (_expr_)

#define	NTV2_DEPRECATED_INLINE

#define	NTV2_DEPRECATED_FIELD

#define	NTV2_DEPRECATED_VARIABLE

#define	NTV2_DEPRECATED_TYPEDEF

#define	NTV2_DEPRECATED_CLASS

#define	NTV2_SHOULD_BE_DEPRECATED(__f__) __f__

#define	NTV2_SHOULD_DEPRECATE(__f__) __f__

#define	NTV2_MUST_DEPRECATE(__f__) __f__

#define	NTV2_WILL_BE_DEPRECATED(__f__) __f__

#define	NTV2_DEPRECATED_f(__f__) __f__

#define	NTV2_DEPRECATED_v(__v__) __v__

#define	NTV2_DEPRECATED_vi(__v__, __i__) __v__ = (__i__)

#define	NTV2_DEPRECATED_16_0(__f__) NTV2_DEPRECATED_f(__f__)

#define	NTV2_DEPRECATED_16_1(__f__) NTV2_WILL_BE_DEPRECATED(__f__)

#define	NTV2_DEPRECATED_16_2(__f__) NTV2_WILL_BE_DEPRECATED(__f__)

#define	NTV2_DEPRECATED_16_3(__f__) NTV2_WILL_BE_DEPRECATED(__f__)

#define	NTV2_DEPRECATED_17_0(__f__) NTV2_WILL_BE_DEPRECATED(__f__)

#define	NTV2_DEPRECATED_17_1(__f__) NTV2_WILL_BE_DEPRECATED(__f__)

#define	NTV2_DEPRECATED_17_2(__f__) NTV2_WILL_BE_DEPRECATED(__f__)

#define	NTV2_DEPRECATED_17_5(__f__) NTV2_WILL_BE_DEPRECATED(__f__)

#define	NTV2_DEPRECATED_17_6(__f__) NTV2_WILL_BE_DEPRECATED(__f__)

#define	NTV2_DEPRECATED_18_0(__f__) NTV2_WILL_BE_DEPRECATED(__f__)

#define	NTV2_DEPRECATED_18_1(__f__) NTV2_WILL_BE_DEPRECATED(__f__)

#define	BIT(_x_) (1u << (_x_))

#define	BIT_0 (1u<<0)

#define	BIT_1 (1u<<1)

#define	BIT_2 (1u<<2)

#define	BIT_3 (1u<<3)

#define	BIT_4 (1u<<4)

#define	BIT_5 (1u<<5)

#define	BIT_6 (1u<<6)

#define	BIT_7 (1u<<7)

#define	BIT_8 (1u<<8)

#define	BIT_9 (1u<<9)

#define	BIT_10 (1u<<10)

#define	BIT_11 (1u<<11)

#define	BIT_12 (1u<<12)

#define	BIT_13 (1u<<13)

#define	BIT_14 (1u<<14)

#define	BIT_15 (1u<<15)

#define	BIT_16 (1u<<16)

#define	BIT_17 (1u<<17)

#define	BIT_18 (1u<<18)

#define	BIT_19 (1u<<19)

#define	BIT_20 (1u<<20)

#define	BIT_21 (1u<<21)

#define	BIT_22 (1u<<22)

#define	BIT_23 (1u<<23)

#define	BIT_24 (1u<<24)

#define	BIT_25 (1u<<25)

#define	BIT_26 (1u<<26)

#define	BIT_27 (1u<<27)

#define	BIT_28 (1u<<28)

#define	BIT_29 (1u<<29)

#define	BIT_30 (1u<<30)

#define	BIT_31 (1u<<31)

Typedefs
typedef uint8_t	UByte

typedef int8_t	SByte

typedef int16_t	Word

typedef uint16_t	UWord

typedef int32_t	LWord

typedef uint32_t	ULWord

typedef uint32_t *	PULWord

typedef int64_t	LWord64

typedef uint64_t	ULWord64

typedef uint64_t	Pointer64

typedef short	HANDLE

typedef void *	PVOID

typedef unsigned int	BOOL_

typedef ULWord	UWord_

typedef int	Fixed_

typedef int	AJASocket

Detailed Description

Declares the most fundamental data types used by NTV2. Since Windows NT was the first principal development platform, many typedefs are Windows-centric.

Copyright: (C) 2004-2022 AJA Video Systems, Inc.

Definition in file ajatypes.h.

Macro Definition Documentation

◆ AJA_FALL_THRU

#define AJA_FALL_THRU

Definition at line 200 of file ajatypes.h.

◆ AJA_NULL

#define AJA_NULL NULL

Definition at line 180 of file ajatypes.h.

◆ AJA_STATIC

#define AJA_STATIC static

Definition at line 144 of file ajatypes.h.

◆ AJA_VIRTUAL

#define AJA_VIRTUAL virtual

Definition at line 143 of file ajatypes.h.

◆ AJAFUNC

#define AJAFUNC __func__

Definition at line 306 of file ajatypes.h.

◆ AJATargetBigEndian

#define AJATargetBigEndian 0

Definition at line 305 of file ajatypes.h.

◆ BIT

#define BIT ( _x_ ) (1u << (_x_))

Definition at line 596 of file ajatypes.h.

◆ BIT_0

#define BIT_0 (1u<<0)

Definition at line 605 of file ajatypes.h.

◆ BIT_1

#define BIT_1 (1u<<1)

Definition at line 606 of file ajatypes.h.

◆ BIT_10

#define BIT_10 (1u<<10)

Definition at line 615 of file ajatypes.h.

◆ BIT_11

#define BIT_11 (1u<<11)

Definition at line 616 of file ajatypes.h.

◆ BIT_12

#define BIT_12 (1u<<12)

Definition at line 617 of file ajatypes.h.

◆ BIT_13

#define BIT_13 (1u<<13)

Definition at line 618 of file ajatypes.h.

◆ BIT_14

#define BIT_14 (1u<<14)

Definition at line 619 of file ajatypes.h.

◆ BIT_15

#define BIT_15 (1u<<15)

Definition at line 620 of file ajatypes.h.

◆ BIT_16

#define BIT_16 (1u<<16)

Definition at line 621 of file ajatypes.h.

◆ BIT_17

#define BIT_17 (1u<<17)

Definition at line 622 of file ajatypes.h.

◆ BIT_18

#define BIT_18 (1u<<18)

Definition at line 623 of file ajatypes.h.

◆ BIT_19

#define BIT_19 (1u<<19)

Definition at line 624 of file ajatypes.h.

◆ BIT_2

#define BIT_2 (1u<<2)

Definition at line 607 of file ajatypes.h.

◆ BIT_20

#define BIT_20 (1u<<20)

Definition at line 625 of file ajatypes.h.

◆ BIT_21

#define BIT_21 (1u<<21)

Definition at line 626 of file ajatypes.h.

◆ BIT_22

#define BIT_22 (1u<<22)

Definition at line 627 of file ajatypes.h.

◆ BIT_23

#define BIT_23 (1u<<23)

Definition at line 628 of file ajatypes.h.

◆ BIT_24

#define BIT_24 (1u<<24)

Definition at line 629 of file ajatypes.h.

◆ BIT_25

#define BIT_25 (1u<<25)

Definition at line 630 of file ajatypes.h.

◆ BIT_26

#define BIT_26 (1u<<26)

Definition at line 631 of file ajatypes.h.

◆ BIT_27

#define BIT_27 (1u<<27)

Definition at line 632 of file ajatypes.h.

◆ BIT_28

#define BIT_28 (1u<<28)

Definition at line 633 of file ajatypes.h.

◆ BIT_29

#define BIT_29 (1u<<29)

Definition at line 634 of file ajatypes.h.

◆ BIT_3

#define BIT_3 (1u<<3)

Definition at line 608 of file ajatypes.h.

◆ BIT_30

#define BIT_30 (1u<<30)

Definition at line 635 of file ajatypes.h.

◆ BIT_31

#define BIT_31 (1u<<31)

Definition at line 636 of file ajatypes.h.

◆ BIT_4

#define BIT_4 (1u<<4)

Definition at line 609 of file ajatypes.h.

◆ BIT_5

#define BIT_5 (1u<<5)

Definition at line 610 of file ajatypes.h.

◆ BIT_6

#define BIT_6 (1u<<6)

Definition at line 611 of file ajatypes.h.

◆ BIT_7

#define BIT_7 (1u<<7)

Definition at line 612 of file ajatypes.h.

◆ BIT_8

#define BIT_8 (1u<<8)

Definition at line 613 of file ajatypes.h.

◆ BIT_9

#define BIT_9 (1u<<9)

Definition at line 614 of file ajatypes.h.

◆ INVALID_HANDLE_VALUE

#define INVALID_HANDLE_VALUE (0)

Definition at line 312 of file ajatypes.h.

◆ MAX_PATH

#define MAX_PATH 4096

Definition at line 310 of file ajatypes.h.

◆ NTV2_ASSERT

#define NTV2_ASSERT ( _expr_ ) (void) (_expr_)

Definition at line 489 of file ajatypes.h.

◆ NTV2_CHECK_SDRAM_COLLISIONS

#define NTV2_CHECK_SDRAM_COLLISIONS

Definition at line 136 of file ajatypes.h.

◆ NTV2_CPP_MAX

#define NTV2_CPP_MAX	(	__x__,
		__y__
	)	std::max((__x__),(__y__))

Definition at line 308 of file ajatypes.h.

◆ NTV2_CPP_MIN

#define NTV2_CPP_MIN	(	__x__,
		__y__
	)	std::min((__x__),(__y__))

Definition at line 307 of file ajatypes.h.

◆ NTV2_DEPRECATED_16_0

#define NTV2_DEPRECATED_16_0 ( __f__ ) NTV2_DEPRECATED_f(__f__)

Definition at line 542 of file ajatypes.h.

◆ NTV2_DEPRECATED_16_1

#define NTV2_DEPRECATED_16_1 ( __f__ ) NTV2_WILL_BE_DEPRECATED(__f__)

Definition at line 546 of file ajatypes.h.

◆ NTV2_DEPRECATED_16_2

#define NTV2_DEPRECATED_16_2 ( __f__ ) NTV2_WILL_BE_DEPRECATED(__f__)

Definition at line 551 of file ajatypes.h.

◆ NTV2_DEPRECATED_16_3

#define NTV2_DEPRECATED_16_3 ( __f__ ) NTV2_WILL_BE_DEPRECATED(__f__)

Definition at line 556 of file ajatypes.h.

◆ NTV2_DEPRECATED_17_0

#define NTV2_DEPRECATED_17_0 ( __f__ ) NTV2_WILL_BE_DEPRECATED(__f__)

Definition at line 561 of file ajatypes.h.

◆ NTV2_DEPRECATED_17_1

#define NTV2_DEPRECATED_17_1 ( __f__ ) NTV2_WILL_BE_DEPRECATED(__f__)

Definition at line 566 of file ajatypes.h.

◆ NTV2_DEPRECATED_17_2

#define NTV2_DEPRECATED_17_2 ( __f__ ) NTV2_WILL_BE_DEPRECATED(__f__)

Definition at line 571 of file ajatypes.h.

◆ NTV2_DEPRECATED_17_5

#define NTV2_DEPRECATED_17_5 ( __f__ ) NTV2_WILL_BE_DEPRECATED(__f__)

Definition at line 576 of file ajatypes.h.

◆ NTV2_DEPRECATED_17_6

#define NTV2_DEPRECATED_17_6 ( __f__ ) NTV2_WILL_BE_DEPRECATED(__f__)

Definition at line 581 of file ajatypes.h.

◆ NTV2_DEPRECATED_18_0

#define NTV2_DEPRECATED_18_0 ( __f__ ) NTV2_WILL_BE_DEPRECATED(__f__)

Definition at line 586 of file ajatypes.h.

◆ NTV2_DEPRECATED_18_1

#define NTV2_DEPRECATED_18_1 ( __f__ ) NTV2_WILL_BE_DEPRECATED(__f__)

Definition at line 591 of file ajatypes.h.

◆ NTV2_DEPRECATED_CLASS

#define NTV2_DEPRECATED_CLASS

Definition at line 503 of file ajatypes.h.

◆ NTV2_DEPRECATED_f

#define NTV2_DEPRECATED_f ( __f__ ) __f__

Definition at line 537 of file ajatypes.h.

◆ NTV2_DEPRECATED_FIELD

#define NTV2_DEPRECATED_FIELD

Definition at line 500 of file ajatypes.h.

◆ NTV2_DEPRECATED_INLINE

#define NTV2_DEPRECATED_INLINE

Definition at line 499 of file ajatypes.h.

◆ NTV2_DEPRECATED_TYPEDEF

#define NTV2_DEPRECATED_TYPEDEF

Definition at line 502 of file ajatypes.h.

◆ NTV2_DEPRECATED_v

#define NTV2_DEPRECATED_v ( __v__ ) __v__

Definition at line 538 of file ajatypes.h.

◆ NTV2_DEPRECATED_VARIABLE

#define NTV2_DEPRECATED_VARIABLE

Definition at line 501 of file ajatypes.h.

◆ NTV2_DEPRECATED_vi

#define NTV2_DEPRECATED_vi	(	__v__,
		__i__
	)	__v__ = (__i__)

Definition at line 539 of file ajatypes.h.

◆ NTV2_MUST_DEPRECATE

#define NTV2_MUST_DEPRECATE ( __f__ ) __f__

Definition at line 506 of file ajatypes.h.

◆ NTV2_NUB_CLIENT_SUPPORT

#define NTV2_NUB_CLIENT_SUPPORT

Definition at line 62 of file ajatypes.h.

◆ NTV2_SHOULD_BE_DEPRECATED

#define NTV2_SHOULD_BE_DEPRECATED ( __f__ ) __f__

Definition at line 504 of file ajatypes.h.

◆ NTV2_SHOULD_DEPRECATE

#define NTV2_SHOULD_DEPRECATE ( __f__ ) __f__

Definition at line 505 of file ajatypes.h.

◆ NTV2_UNUSED

#define NTV2_UNUSED ( __p__ ) (void)__p__

Definition at line 145 of file ajatypes.h.

◆ NTV2_USE_CPLUSPLUS11

#define NTV2_USE_CPLUSPLUS11

Definition at line 91 of file ajatypes.h.

◆ NTV2_USE_STDINT

#define NTV2_USE_STDINT

Definition at line 12 of file ajatypes.h.

◆ NTV2_WILL_BE_DEPRECATED

#define NTV2_WILL_BE_DEPRECATED ( __f__ ) __f__

Definition at line 507 of file ajatypes.h.

◆ NTV2_WRITEREG_PROFILING

#define NTV2_WRITEREG_PROFILING

Definition at line 74 of file ajatypes.h.

◆ POINTER_32

#define POINTER_32

Definition at line 321 of file ajatypes.h.

Typedef Documentation

◆ AJASocket

typedef int AJASocket

Definition at line 303 of file ajatypes.h.

◆ BOOL_

typedef unsigned int BOOL_

Definition at line 300 of file ajatypes.h.

◆ Fixed_

typedef int Fixed_

Definition at line 302 of file ajatypes.h.

◆ HANDLE

typedef short HANDLE

Definition at line 298 of file ajatypes.h.

◆ LWord

typedef int32_t LWord

Definition at line 235 of file ajatypes.h.

◆ LWord64

typedef int64_t LWord64

Definition at line 238 of file ajatypes.h.

◆ Pointer64

typedef uint64_t Pointer64

Definition at line 240 of file ajatypes.h.

◆ PULWord

typedef uint32_t* PULWord

Definition at line 237 of file ajatypes.h.

◆ PVOID

typedef void* PVOID

Definition at line 299 of file ajatypes.h.

◆ SByte

typedef int8_t SByte

Definition at line 232 of file ajatypes.h.

◆ UByte

typedef uint8_t UByte

Definition at line 231 of file ajatypes.h.

◆ ULWord

typedef uint32_t ULWord

Definition at line 236 of file ajatypes.h.

◆ ULWord64

typedef uint64_t ULWord64

Definition at line 239 of file ajatypes.h.

◆ UWord

typedef uint16_t UWord

Definition at line 234 of file ajatypes.h.

◆ UWord_

typedef ULWord UWord_

Definition at line 301 of file ajatypes.h.

◆ Word

typedef int16_t Word

Definition at line 233 of file ajatypes.h.

Macros

Typedefs